93567a4a52a86b8d64308c09f8d8b68eb3f60bbb
[occt.git] / src / TopLoc / TopLoc_ItemLocation.cdl
1 -- Created on: 1991-01-21
2 -- Created by: Christophe MARION
3 -- Copyright (c) 1991-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 private class ItemLocation from TopLoc
18
19         ---Purpose: An ItemLocation is an elementary coordinate system
20         --          in a Location.
21         --          
22         --          The  ItemLocation     contains :
23         --          
24         --          * The elementary Datum.
25         --          
26         --          * The exponent of the elementary Datum.
27         --          
28         --          * The transformation associated to the composition.
29         --          
30
31 uses
32     Datum3D   from TopLoc,
33     Trsf      from gp,
34     TrsfPtr from TopLoc
35     
36 is
37     Create(D : Datum3D      from TopLoc; 
38            P : Integer      from Standard;
39            fromTrsf : Boolean from Standard = Standard_False) returns ItemLocation from TopLoc;
40         ---Purpose: Sets the elementary Datum to <D>
41         --          Sets the exponent to <P>
42
43     Create(anOther : ItemLocation from TopLoc) returns ItemLocation from TopLoc;
44     
45     Assign(me : in out; anOther : ItemLocation from TopLoc) returns ItemLocation from TopLoc;
46     ---C++: alias operator=
47     ---C++: return &
48
49     Destroy(me : in out);
50     ---C++: alias ~
51
52 fields
53     myDatum  : Datum3D   from TopLoc;
54     myPower  : Integer   from Standard;
55     myTrsf   : TrsfPtr   from TopLoc;
56
57 friends
58     class Location from TopLoc
59     
60 end ItemLocation;