0024784: Move documentation in CDL files to proper location
[occt.git] / src / PTopoDS / PTopoDS.cdl
1 -- Created on: 1993-03-08
2 -- Created by: Remi LEQUETTE
3 -- Copyright (c) 1993-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 -- Update:      Frederic Maupas
18
19
20 package PTopoDS 
21
22         ---Purpose: The package PTopoDS provides persistent classes to
23         --          store Topological Data Structures in Data Base.
24         --          
25         --          The  structure  of  this  persistent  topology  is
26         --          similar  to   the  transient  topology   (see  its
27         --          documentation for more comprehension of this one).
28         --          But some differences occure:
29         --          
30         --          * The class Model and derivatives disappear;
31         --          
32         --          * The "free"  information  disappears,  because  a 
33         --          TShape stored in the Data Base is always "frozen";
34         --          
35
36         --          * The class HShape  inherits  from ExternShareable  from
37         --          ObjMgt,  so that an intance of HShape  may be
38         --          shared by a TShape even if the HShape is not in the
39         --          same Container.
40         --          
41         --          * The class Shape1 inherits from Storable from
42         --          Standard.
43         --          
44         --          Note that the  use of this topology is managed  by
45         --          the package MgtTopoDS.
46         --          
47         --          About the question of "Location", see the  package
48         --          PTopLoc  itself;  about  naming,  referencing  and
49         --          using persistent  Shapes outsing  the  topological
50         --          world, see the package TopoDB.
51
52 uses
53
54     ObjMgt,
55     Standard,
56     TopAbs,      -- basic enumerations : ShapeEnum, Orientation
57     PTopLoc,     -- Persistent local coordinate systems
58     PCollection,
59     TCollection
60     
61 is
62
63     ---Category: Old version of Shape/TShape.
64     --           ============================
65
66     class HShape;
67
68     deferred class TShape;
69
70     deferred class TVertex;
71
72     class Vertex;
73
74     deferred class TEdge;
75
76     class Edge;
77
78     class TWire;
79
80     class Wire;
81
82     class TFace;
83
84     class Face;
85
86     class TShell;
87
88     class Shell;
89
90     class TSolid;
91
92     class Solid;
93
94     class TCompSolid;
95
96     class CompSolid;
97
98     class TCompound;
99
100     class Compound;
101
102
103     class HArray1OfHShape instantiates HArray1 from PCollection
104         (HShape from PTopoDS);
105
106
107     ---Category: New version of Shape/TShape.
108     --           ============================
109
110     class Shape1;
111
112     deferred class TShape1;
113
114     deferred class TVertex1;
115
116     deferred class TEdge1;
117
118     class TWire1;
119
120     class TFace1;
121
122     class TShell1;
123
124     class TSolid1;
125
126
127     class TCompSolid1;
128
129     class TCompound1;
130
131     class HArray1OfShape1 instantiates HArray1 from PCollection
132         (Shape1 from PTopoDS);
133
134 end PTopoDS;