0024927: Getting rid of "Persistent" functionality -- Storable
[occt.git] / src / GccAna / GccAna_Circ2dTanOnRad.cdl
1 -- Created on: 1991-03-22
2 -- Created by: Philippe DAUTRY
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 class Circ2dTanOnRad
18
19 from GccAna
20
21         ---Purpose: This class implements the algorithms used to 
22         --          create a 2d circle tangent to a 2d entity, 
23         --          centered on a curv and with a given radius.
24         --          The arguments of all construction methods are :
25         --             - The qualified element for the tangency constrains 
26         --             (QualifiedCirc, QualifiedLin, Points).
27         --             - The Center element (circle, line).
28         --             - A real Tolerance.
29         --          Tolerance is only used in the limits cases.
30         --          For example : 
31         --          We want to create a circle tangent to an OutsideCirc C1
32         --          centered on a line OnLine with a radius Radius and with
33         --          a tolerance Tolerance.
34         --          If we did not use Tolerance it is impossible to 
35         --          find a solution in the the following case : OnLine is 
36         --          outside C1. There is no intersection point between C1
37         --          and OnLine. The distance between the line and the 
38         --          circle is greater than Radius.
39         --          With Tolerance we will give a solution if the 
40         --          distance between C1 and OnLine is lower than or 
41         --          equal Tolerance.
42
43 uses Pnt2d           from gp,
44      Lin2d           from gp,
45      Circ2d          from gp,
46      QualifiedCirc   from GccEnt, 
47      QualifiedLin    from GccEnt,
48      Array1OfReal    from TColStd,
49      Array1OfInteger from TColStd,
50      Array1OfCirc2d  from TColgp,
51      Array1OfPnt2d   from TColgp,
52      Position         from GccEnt,
53      Array1OfPosition from GccEnt
54
55 raises NegativeValue     from Standard,
56        OutOfRange        from Standard,
57        NotDone           from StdFail,
58        BadQualifier      from GccEnt
59
60 is
61
62 ---Category: On a line ................................................
63
64 Create(Qualified1 : QualifiedCirc from GccEnt  ;
65        OnLine     : Lin2d         from gp      ;
66        Radius     : Real          from Standard;
67        Tolerance  : Real          from Standard) returns Circ2dTanOnRad 
68     ---Purpose: This methods implements the algorithms used to create 
69     --          2d Circles tangent to a circle and centered on a 2d Line 
70     --          with a given radius.
71     --          Tolerance is used to find solution in every limit cases.
72     --          For example Tolerance is used in the case of EnclosedCirc when 
73     --          Radius-R1+dist is greater Tolerance (dist is the distance 
74     --          between the line and the location of the circ, R1 is the 
75     --          radius of the circ) because there is no solution.
76 raises NegativeValue, BadQualifier;
77     ---Purpose: raises NegativeValue in case of NegativeRadius.
78
79 Create(Qualified1 : QualifiedLin  from GccEnt  ;
80        OnLine     : Lin2d         from gp      ;
81        Radius     : Real          from Standard;
82        Tolerance  : Real          from Standard) returns Circ2dTanOnRad 
83     ---Purpose: This methods implements the algorithms used to create 
84     --          2d Circles tangent to a 2d Line and centered on a 2d Line 
85     --          with a given radius.
86     --          Tolerance is used to find solution in every limit cases.
87 raises NegativeValue, BadQualifier;
88     ---Purpose: raises NegativeValue in case of NegativeRadius.
89
90 Create(Point1     : Pnt2d         from gp      ;
91        OnLine     : Lin2d         from gp      ;
92        Radius     : Real          from Standard;
93        Tolerance  : Real          from Standard) returns Circ2dTanOnRad 
94     ---Purpose: This methods implements the algorithms used to create 
95     --          2d Circles passing through a 2d Point and centered on a 
96     --          2d Line with a given radius.
97     --          Tolerance is used to find solution in every limit cases.
98 raises NegativeValue;
99     -- raises NegativeValue in case of NegativeRadius.
100
101 ---Category: On a circle ................................................
102
103 Create(Qualified1 : QualifiedCirc from GccEnt  ;
104        OnCirc     : Circ2d        from gp      ;
105        Radius     : Real          from Standard;
106        Tolerance  : Real          from Standard) returns Circ2dTanOnRad 
107     ---Purpose: This methods implements the algorithms used to create 
108     --          2d Circles tangent to a circle and centered on a 2d Circle 
109     --          with a given radius.
110     --          Tolerance is used to find solution in every limit cases.
111 raises NegativeValue, BadQualifier;
112     ---Purpose: raises NegativeValue in case of NegativeRadius.
113
114 Create(Qualified1 : QualifiedLin  from GccEnt  ;
115        OnCirc     : Circ2d        from gp      ;
116        Radius     : Real          from Standard;
117        Tolerance  : Real          from Standard) returns Circ2dTanOnRad 
118     ---Purpose: This methods implements the algorithms used to create 
119     --          2d Circles tangent to a 2d Line and centered on a 2d Line 
120     --          with a given radius.
121     --          Tolerance is used to find solution in every limit cases.
122 raises NegativeValue, BadQualifier;
123     ---Purpose: raises NegativeValue in case of NegativeRadius.
124
125 Create(Point1     : Pnt2d         from gp      ;
126        OnCirc     : Circ2d        from gp      ;
127        Radius     : Real          from Standard;
128        Tolerance  : Real          from Standard) returns Circ2dTanOnRad 
129     ---Purpose: This methods implements the algorithms used to create 
130     --          2d Circles passing through a 2d Point and centered on a 
131     --          2d Line with a given radius.
132     --          Tolerance is used to find solution in every limit cases.
133 raises NegativeValue;
134     ---Purpose: raises NegativeValue in case of NegativeRadius.
135
136 -- -- ....................................................................
137
138 IsDone(me) returns Boolean from Standard
139 is static;
140     ---Purpose: Returns true if the construction algorithm does not fail
141     --          (even if it finds no solution).
142     --          Note: IsDone protects against a failure arising from a
143     --          more internal intersection algorithm, which has
144     --          reached its numeric limits.
145
146 NbSolutions(me) returns Integer from Standard
147     ---Purpose: This method returns the number of circles, representing solutions.
148     --          Raises NotDone if the construction algorithm didn't succeed.
149 raises NotDone
150 is static;
151         
152 ThisSolution(me                           ; 
153              Index : Integer from Standard) returns Circ2d from gp
154     ---Purpose: Returns the solution number Index and raises OutOfRange 
155     --          exception if Index is greater than the number of solutions.
156     --          Be careful: the Index is only a way to get all the 
157     --          solutions, but is not associated to theses outside the 
158     --          context of the algorithm-object.
159     -- Raises NotDone if the construction algorithm  didn't succeed.
160     --          It raises OutOfRange if Index is greater than the 
161     --          number of solutions
162 raises OutOfRange, NotDone
163 is static;
164        
165
166 WhichQualifier(me                                  ;
167                Index   :     Integer  from Standard;
168                Qualif1 : out Position from GccEnt  )
169 raises OutOfRange, NotDone
170 is static;
171     ---Purpose: Returns the qualifier Qualif1 of the tangency argument
172     --     for the solution of index Index computed by this algorithm.
173     --     The returned qualifier is:
174     -- -   that specified at the start of construction when the
175     --   solutions are defined as enclosed, enclosing or
176     --   outside with respect to the argument, or
177     -- -   that computed during construction (i.e. enclosed,
178     --   enclosing or outside) when the solutions are defined
179     --   as unqualified with respect to the argument, or
180     -- -   GccEnt_noqualifier if the tangency argument is a point.
181     -- Exceptions
182     -- Standard_OutOfRange if Index is less than zero or
183     -- greater than the number of solutions computed by this algorithm.
184     -- StdFail_NotDone if the construction fails. 
185         
186 Tangency1(me                                     ;
187           Index         : Integer   from Standard;
188           ParSol,ParArg : out Real  from Standard;
189           PntSol        : out Pnt2d from gp      )
190     ---Purpose: Returns informations about the tangency point between the 
191     --          result number Index and the first argument.
192     --          ParSol is the intrinsic parameter of the point on the 
193     --          solution curv.
194     --          ParArg is the intrinsic parameter of the point on the 
195     --          argument curv.
196     --          PntSol is the tangency point on the solution curv.
197     --          PntArg is the tangency point on the argument curv.
198     --    Raises NotDone if the construction algorithm didn't succeed.
199     --          It raises OutOfRange if Index is greater than the 
200     --          number of solutions.
201 raises OutOfRange, NotDone
202 is static;
203   
204 CenterOn3 (me                                     ;
205            Index         : Integer   from Standard;
206            ParArg        : out Real  from Standard;
207            PntSol        : out Pnt2d from gp      )
208     ---Purpose: Returns informations about the center (on the curv) 
209     --          of the result.
210     --          ParArg is the intrinsic parameter of the point on 
211     --          the argument curv.
212     --          PntSol is the center point of the solution curv.
213 --    Raises NotDone if the construction algorithm  didn't succeed.
214     --          It raises OutOfRange if Index is greater than the 
215     --          number of solutions.
216 raises OutOfRange, NotDone
217 is static;
218    
219
220 IsTheSame1(me                           ;
221            Index : Integer from Standard) returns Boolean from Standard
222     ---Purpose: Returns True if the solution number Index is equal to 
223     --          the first argument and False in the other cases.
224 --    Raises NotDone if the construction algorithm  didn't succeed.
225     --          It raises OutOfRange if Index is greater than the 
226     --          number of solutions.
227 raises OutOfRange, NotDone
228 is static;
229    
230
231 fields
232
233     WellDone : Boolean from Standard;
234     ---Purpose: True if the algorithm succeeded.
235
236     NbrSol   : Integer from Standard;
237     ---Purpose: The number of possible solutions. We have to decide about the
238     --          status of the multiple solutions...
239
240     cirsol   : Array1OfCirc2d from TColgp;
241     ---Purpose : The solutions.
242
243     qualifier1 : Array1OfPosition from GccEnt;
244     -- The qualifiers of the first argument.
245
246     TheSame1 : Array1OfInteger from TColStd;
247     ---Purpose: 1 if the solution and the first argument are the same in the 
248     -- tolerance of Tolerance.
249     -- 0 in the other cases.
250
251     pnttg1sol   : Array1OfPnt2d from TColgp;
252     ---Purpose: The tangency point between the solution and the first 
253     --          argument on the solution.
254
255     pntcen3   : Array1OfPnt2d from TColgp;
256     ---Purpose: The center point of the solution on the first argument.
257
258     par1sol   : Array1OfReal from TColStd;
259     ---Purpose: The parameter of the tangency point between the solution 
260     --          and the first argument on thesolution.
261
262     pararg1   : Array1OfReal from TColStd;
263     ---Purpose: The parameter of the tangency point between the solution 
264     --          and the first argument on the first argument.
265
266     parcen3   : Array1OfReal from TColStd;
267     ---Purpose: The parameter of the center point of the solution on the 
268     --          second argument.
269
270 end Circ2dTanOnRad;
271