0022904: Clean up sccsid variables
[occt.git] / src / QANewModTopOpe / QANewModTopOpe_Limitation.cdl
1 -- File:        QANewModTopOpe_Limitation.cdl
2 -- Created:     Thu May  3 11:56:07 2001
3 -- Author:      Igor FEOKTISTOV <ifv@nnov.matra-dtv.fr>
4 -- Copyright:   SAMTECH S.A. 2001
5
6 -- Lastly modified by :
7 -- +---------------------------------------------------------------------------+
8 -- !       ifv ! Creation                                ! 3-05-2001! 3.0-00-2!
9 -- !       skv ! Adaptation to OCC version 5.0           ! 6-05-2003! 3.0-00-2!
10 -- +---------------------------------------------------------------------------+
11
12 class Limitation from QANewModTopOpe inherits MakeShape from BRepBuilderAPI
13
14 ---Purpose: provides  cutting  shape  by  face  or  shell;
15
16 uses
17
18     Shape from TopoDS, 
19     ListOfShape from TopTools, 
20     ModeOfLimitation  from  QANewModTopOpe, 
21     State  from  TopAbs,  
22     CutPtr  from  QANewModTopOpe, 
23     CommonPtr  from  QANewModTopOpe
24 is 
25   
26     Create(theObjectToCut,  theCutTool : Shape from TopoDS;
27             theMode : ModeOfLimitation  from  QANewModTopOpe = QANewModTopOpe_Forward)
28     ---Purpose: initializes and  fills data structure for  cutting and
29     --          makes  cutting according to orientation theCutTool and
30     --          theMode.
31     --          if theCutTool is not face or shell does nothing.
32     
33     returns Limitation from QANewModTopOpe;    
34      
35     Cut(me  :  in  out);
36     ---Purpose: makes cutting  according to  orientation theCutTool
37     --          and  current value   of  myMode.  Does nothing  if
38     --          result already  exists.
39
40     SetMode(me  :  in  out;  theMode  :  ModeOfLimitation  from  QANewModTopOpe); 
41      
42     GetMode(me)  returns  ModeOfLimitation  from  QANewModTopOpe;  
43      
44     Shape1(me)  returns  Shape  from  TopoDS
45     ---Purpose: Returns the first shape.
46     ---C++: return const &
47     ---Level: Public
48     is static;
49      
50     Shape2(me)  returns  Shape  from  TopoDS
51     ---Purpose: Returns the second shape.
52     ---C++: return const &
53     ---Level: Public
54     is static; 
55     
56     Modified (me: in out; S : Shape from TopoDS)
57         ---Purpose: Returns the list  of shapes modified from the shape
58         --          <S>. 
59         ---C++: return const & 
60         ---Level: Public
61     returns ListOfShape from TopTools
62     is redefined;
63  
64     Modified2 (me: in out;  
65                 aS : Shape from TopoDS) 
66         returns ListOfShape from TopTools;
67     ---Purpose: Returns the list  of shapes modified from the shape <S>.
68     ---         For use in BRepNaming.
69     ---C++: return const & 
70     ---Level: Public
71
72     Generated (me: in out; S : Shape from TopoDS)
73         returns ListOfShape from TopTools
74         is redefined;
75         ---Purpose: Returns the list  of shapes generated from the shape <S>.
76         ---         For use in BRepNaming.
77         ---C++:  return const &
78     
79     HasModified (me)
80         returns Boolean from Standard
81         is virtual;
82         ---Purpose: Returns true if there is at least one modified shape.
83         ---         For use in BRepNaming.
84
85     HasGenerated (me)
86         returns Boolean from Standard
87         is virtual;
88         ---Purpose: Returns true if there is at least one generated shape.
89         ---         For use in BRepNaming.
90
91     HasDeleted (me)
92         returns Boolean from Standard
93         is virtual;
94         ---Purpose: Returns true if there is at least one deleted shape.
95         ---         For use in BRepNaming.
96
97     IsDeleted (me: in out; S : Shape from TopoDS)
98     returns Boolean from Standard
99     is redefined;
100       
101     Delete(me  :  in  out)  is  redefined; 
102     ---C++:  alias  "Standard_EXPORT  ~QANewModTopOpe_Limitation()  {Delete();}"
103   
104
105 fields 
106
107     myResultFwd     :  Shape  from  TopoDS;  
108     myResultRvs     :  Shape  from  TopoDS;  
109     myObjectToCut   :  Shape  from  TopoDS;  
110     myCutTool       :  Shape  from  TopoDS;  
111     myCut           :  CutPtr  from  QANewModTopOpe;
112     myCommon        :  CommonPtr  from  QANewModTopOpe;
113     myFwdIsDone     :  Boolean  from  Standard;
114     myRevIsDone     :  Boolean  from  Standard;  
115     myMode          :  ModeOfLimitation  from  QANewModTopOpe;
116     
117 end  Limitation;
118
119
120 -- @@SDM: begin
121
122 -- Copyright SAMTECH ..........................................Version    3.0-00
123 -- Lastly modified by : skv                                    Date :  6-05-2003
124
125 -- File history synopsis (creation,modification,correction)
126 -- +---------------------------------------------------------------------------+
127 -- ! Developer !              Comments                   !   Date   ! Version  !
128 -- +-----------!-----------------------------------------!----------!----------+
129 -- !       ifv ! Creation                                ! 3-05-2001! 3.0-00-2!
130 -- !       skv ! Adaptation to OCC version 5.0           ! 6-05-2003! 3.0-00-2!
131 -- !  vladimir ! adaptation to CAS 5.0                   !  07/01/03!    4.0-2!
132 -- +---------------------------------------------------------------------------+
133 --
134 -- @@SDM: end