0024784: Move documentation in CDL files to proper location
[occt.git] / src / STEPConstruct / STEPConstruct_Assembly.cdl
1 -- Created on: 1998-07-07
2 -- Created by: Christian CAILLET
3 -- Copyright (c) 1998-1999 Matra Datavision
4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
5 --
6 -- This file is part of Open CASCADE Technology software library.
7 --
8 -- This library is free software; you can redistribute it and/or modify it under
9 -- the terms of the GNU Lesser General Public License version 2.1 as published
10 -- by the Free Software Foundation, with special exception defined in the file
11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 -- distribution for complete text of the license and disclaimer of any warranty.
13 --
14 -- Alternatively, this file may be used under the terms of Open CASCADE
15 -- commercial license or contractual agreement.
16
17 class Assembly  from STEPConstruct
18
19     ---Purpose : This operator creates and checks an item of an assembly, from its
20     --           basic data : a ShapeRepresentation, a Location ...
21     --           
22     --           Three ways of coding such item from a ShapeRepresentation :
23     --           - do nothing : i.e. informations for assembly are ignored
24     --           - create a MappedItem
25     --           - create a RepresentationRelationship (WithTransformation)
26
27 uses
28     Trsf from gp,
29     InterfaceModel from Interface, 
30     Axis2Placement3d from StepGeom,
31     ShapeRepresentation from StepShape,
32     ShapeDefinitionRepresentation from StepShape,
33     NextAssemblyUsageOccurrence from StepRepr,
34     ContextDependentShapeRepresentation from StepShape
35 is
36
37     Create returns Assembly from STEPConstruct;
38
39     Init (me: in out; aSR, SDR0: ShapeDefinitionRepresentation from StepShape;
40                       Ax0, Loc : Axis2Placement3d from StepGeom);
41     ---Purpose : Initialises with starting values
42     --           Ax0 : origin axis (typically, standard XYZ)
43     --           Loc : location to which place the item
44
45 --    MakeMappedItem (me: in out);
46     ---Purpose : Makes a MappedItem
47     --           Resulting Value is returned by ItemValue
48
49     MakeRelationship (me: in out);
50     ---Purpose : Make a (ShapeRepresentationRelationship,...WithTransformation)
51     --           Resulting Value is returned by ItemValue
52
53     ItemValue (me) returns Transient;
54     ---Purpose : Returns the Value
55     --           If no Make... has been called, returns the starting SR
56
57     ItemLocation (me) returns Axis2Placement3d from StepGeom;
58     ---Purpose : Returns the location of the item, computed from starting aLoc
59
60     GetNAUO (me) returns NextAssemblyUsageOccurrence from StepRepr;
61         ---Purpose: Returns NAUO object describing the assembly link
62
63     CheckSRRReversesNAUO (myclass; Model: InterfaceModel from Interface; 
64                                    CDSR : ContextDependentShapeRepresentation from StepShape)
65     returns Boolean;
66         ---Purpose: Checks whether SRR's definition of assembly and component contradicts
67         --          with NAUO definition or not, according to model schema (AP214 or AP203)
68         --          
69         
70 fields
71
72     thesdr : ShapeDefinitionRepresentation from StepShape;
73     thesdr0: ShapeDefinitionRepresentation from StepShape;
74     thesr  : ShapeRepresentation from StepShape;
75     thesr0 : ShapeRepresentation from StepShape;
76     theval : Transient;
77     theloc : Axis2Placement3d from StepGeom;
78     theax0 : Axis2Placement3d from StepGeom;
79
80 end Assembly;