Salome HOME
This commit was generated by cvs2git to track changes on a CVS vendor
[modules/smesh.git] / src / SMDS / SMDS.cdl
1 -- File:        SMDS.cdl
2 -- Created:     Wed Jan 23 11:53:00 2002
3 -- Author:      Jean-Michel BOULCOURT
4 --              <jmb@coulox.paris1.matra-dtv.fr>
5 ---Copyright:    Matra Datavision 2002
6
7
8 package SMDS 
9
10         ---Purpose: This package provides the classes Mesh and MeshElement
11         --          
12         --          class Mesh: 
13         --          -  contains the main definition of the 
14         --             mesh and have access to the MeshElement objects
15         --             
16         --          class MeshElement:  
17         --           -  defines the  topological constituants of the Mesh (i.e
18         --              the Node, Edge, Face and Volume entities.
19         --              
20         --          These two last classes  inherits from an abstract
21         --          class MeshObject.
22
23 uses
24     SMDSAbs,
25     MMgt,
26     TCollection,
27     TColStd,
28     TColgp,
29     gp
30     
31     
32 is
33
34     ---=================================
35     ---Category: enumerations
36     --           
37     ---=================================
38
39     enumeration TypeOfPosition is
40         TOP_UNSPEC,
41         TOP_3DSPACE,
42         TOP_VERTEX,
43         TOP_EDGE,
44         TOP_FACE
45     end TypeOfPosition;
46     ---Purpose: defines the type of position of a node (see SMDS_Position)
47     --          TOP_UNSPEC   : node position not specfied
48     --          TOP_3DSPACE  : just a 3d point in space not related
49     --                         to a CAD geometry
50     --          TOP_VERTEX   : to characterize a node with a CAD vertex
51     --          TOP_EDGE     : to characterize a node with a CAD edge
52     --          TOP_FACE     : to characterize a node with a CAD face
53     
54     ---=====================================
55     ---Category: public classes
56     --           Mesh object related classes
57     ---=====================================
58
59     class MeshOrientedElementMapHasher;
60
61     class MeshElementMapHasher;
62     
63     class PntHasher;
64
65     deferred class MeshObject;
66
67         class Mesh;
68
69         deferred class MeshElement;
70                  class MeshNode;
71                  class MeshEdge;
72                  deferred class MeshFace;
73                     class MeshTriangle;
74                     class MeshQuadrangle;
75                  deferred class MeshVolume;
76                     class MeshTetrahedron;
77                     class MeshPyramid;
78                     class MeshPrism;
79                     class MeshHexahedron;
80                        
81     private deferred class MeshIDFactory;
82              private class MeshNodeIDFactory;
83              private class MeshElementIDFactory;
84
85     deferred class MeshElementsIterator;
86            class MeshVolumesIterator;
87            class MeshFacesIterator;
88            class MeshEdgesIterator;
89            class MeshNodesIterator;
90
91
92     deferred class Position;
93            class SpacePosition;
94            class VertexPosition;
95            class EdgePosition;
96            class FacePosition;
97
98     ---=================================
99     ---Category: public classes
100     --           Mesh group
101     ---=================================
102
103     class MeshGroup;
104     
105     ---=================================
106     ---Category: public classes
107     --           Mesh collection classes
108     ---=================================
109
110     class ExtendedMap
111         instantiates Map from TCollection (MeshElement from SMDS,
112                                     MeshElementMapHasher from SMDS);
113         
114     class ExtendedOrientedMap
115         instantiates Map from TCollection (MeshElement from SMDS,
116                                     MeshOrientedElementMapHasher from SMDS);
117         
118     class DataMapOfPntInteger
119         instantiates DataMap from TCollection (Pnt from gp,
120                                                Integer,
121                                                PntHasher from SMDS);
122     class DataMapOfIntegerMeshElement  instantiates
123           DataMap from TCollection(Integer,MeshElement from SMDS,
124                                    MapIntegerHasher from TColStd);
125
126     class ListOfMeshElement
127         instantiates List from TCollection (MeshElement from SMDS);
128
129     class ListOfMesh
130         instantiates List from TCollection (Mesh from SMDS);
131
132     class MapOfMeshElement;
133
134     class MapOfMeshOrientedElement;
135
136     class SequenceOfMesh
137         instantiates Sequence from TCollection (Mesh from SMDS);
138
139     class HSequenceOfMesh
140         instantiates HSequence from TCollection (Mesh from SMDS,
141                                                  SequenceOfMesh from SMDS);
142
143
144     class ListOfMeshGroup
145         instantiates List from TCollection(MeshGroup from SMDS);
146
147 end SMDS;
148