0024157: Parallelization of assembly part of BO
[occt.git] / src / STEPControl / STEPControl_Controller.cdl
1 -- Created on: 1995-02-20
2 -- Created by: Christian CAILLET
3 -- Copyright (c) 1995-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
5 --
6 -- The content of this file is subject to the Open CASCADE Technology Public
7 -- License Version 6.5 (the "License"). You may not use the content of this file
8 -- except in compliance with the License. Please obtain a copy of the License
9 -- at http://www.opencascade.org and read it completely before using this file.
10 --
11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13 --
14 -- The Original Code and all software distributed under the License is
15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
16 -- Initial Developer hereby disclaims all such warranties, including without
17 -- limitation, any warranties of merchantability, fitness for a particular
18 -- purpose or non-infringement. Please see the License for the specific terms
19 -- and conditions governing the rights and limitations under the License.
20
21
22
23 class Controller  from STEPControl inherits Controller  from XSControl
24
25     ---Purpose : defines basic controller for STEP processor
26
27 uses
28
29      CString,
30      Protocol from Interface,
31      InterfaceModel from Interface,
32      WorkLibrary    from IFSelect,
33      ReturnStatus   from IFSelect,
34      ActorOfTransientProcess from Transfer,
35      FinderProcess  from Transfer,
36      ActorOfFinderProcess from Transfer,
37      Shape from TopoDS,
38      WorkSession from XSControl
39
40 is
41
42     Create returns mutable Controller from STEPControl;
43     ---Purpose : Initializes the use of STEP Norm (the first time) and
44     --           returns a Controller
45
46     NewModel     (me) returns mutable InterfaceModel from Interface;
47     ---Purpose : Creates a new empty Model ready to receive data of the Norm.
48     --           It is taken from STEP Template Model
49
50     ActorRead  (me; model : InterfaceModel)
51                  returns mutable ActorOfTransientProcess from Transfer;
52     ---Purpose : Returns a new Actor for Read attached to the pair (norm,appli)
53     --           It is a PmsToTopoDSAct_Actor
54
55         --  Redefined Transfer for Write (using Actor)  --
56     Customise (me: mutable; WS : in out WorkSession from XSControl) is redefined;
57     
58     TransferWriteShape (me; shape : Shape from TopoDS;
59                         FP        : mutable FinderProcess  from Transfer;
60                         model     : mutable InterfaceModel from Interface;
61                         modetrans : Integer = 0)  returns ReturnStatus
62       is redefined;
63     ---Purpose : Takes one Shape and transfers it to the InterfaceModel
64     --           (already created by NewModel for instance)
65     --           <modeshape> is to be interpreted by each kind of XstepAdaptor
66     --           Returns a status : 0 OK  1 No result  2 Fail  -1 bad modeshape
67     --               -2 bad model (requires a StepModel)
68     --           modeshape : 1 Facetted BRep, 2 Shell, 3 Manifold Solid
69
70         --  for global initialisation
71
72     Init (myclass) returns Boolean;
73     ---Purpose : Standard Initialisation. It creates a Controller for STEP
74     --           and records it to various names, available to select it later
75     --           Returns True when done, False if could not be done
76
77 end Controller;