Salome HOME
Add a ChangeLog file
[modules/smesh.git] / src / SMDS / SMDS_Position.cdl
1 --  SMESH SMDS : implementaion of Salome mesh data structure
2 --
3 --  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 --  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
5 -- 
6 --  This library is free software; you can redistribute it and/or 
7 --  modify it under the terms of the GNU Lesser General Public 
8 --  License as published by the Free Software Foundation; either 
9 --  version 2.1 of the License. 
10 -- 
11 --  This library is distributed in the hope that it will be useful, 
12 --  but WITHOUT ANY WARRANTY; without even the implied warranty of 
13 --  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
14 --  Lesser General Public License for more details. 
15 -- 
16 --  You should have received a copy of the GNU Lesser General Public 
17 --  License along with this library; if not, write to the Free Software 
18 --  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
19 -- 
20 --  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org 
21 --
22 --
23 --
24 --  File   : SMDS_Position.cdl
25 --  Author : Jean-Michel BOULCOURT
26 --  Module : SMESH
27
28 deferred class Position from SMDS inherits  TShared from MMgt
29
30         ---Purpose: abstract  class to define  the different positions
31         --          of a node related to the underlying geometry (CAD model)
32
33 uses
34     Pnt from gp,
35     TypeOfPosition from SMDS
36     
37 is
38
39     Initialize(aShapeId: Integer; 
40                aType: TypeOfPosition from SMDS = SMDS_TOP_UNSPEC) 
41     returns mutable Position;
42
43     Coords(me) returns Pnt from gp is deferred;
44     ---Purpose: returns the resulting 3d point to be set
45     --          in the MeshNode instance
46     --          must be redefined by inherited classes
47     
48     GetTypeOfPosition(me) returns TypeOfPosition from SMDS;
49     ---Purpose: returns the type of position
50     --          
51     ---C++: inline
52     
53     SetShapeId(me: mutable; aShapeId: Integer);
54     ---Purpose: Sets the ShapeId of the position
55     --          
56     ---C++: inline
57
58     GetShapeId(me) returns Integer;
59     ---Purpose: Returns the ShapeId of the position
60     --          
61     ---C++: inline
62
63
64 fields
65
66     myShapeId : Integer;
67     myType    : TypeOfPosition from SMDS;    
68 end Position;