0024784: Move documentation in CDL files to proper location
[occt.git] / src / ChFiDS / ChFiDS.cdl
1 -- Created on: 1993-11-17
2 -- Created by: Isabelle GRIGNON
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 package ChFiDS 
18
19         ---Purpose: 
20
21 uses BRepAdaptor,GeomAdaptor,Geom,Geom2d,TopExp,TopoDS,TopAbs,TopTools,Law,
22      Adaptor3d,GCPnts,MMgt,TColgp,gp,GeomAbs,TColStd,TCollection,Standard
23
24 is
25
26
27     enumeration State from ChFiDS is OnSame, OnDiff, AllSame, BreakPoint,  
28                                      FreeBoundary, Closed, Tangent  
29     end State from ChFiDS;          
30     ---Purpose: This enum describe the  different kinds of extremities
31     --          of   a   fillet.   OnSame,   Ondiff and  AllSame   are
32     --          particular cases of BreakPoint   for a corner   with 3
33     --          edges and three faces :
34     --          - AllSame means that  the three concavities are on the
35     --          same side of the Shape,
36     --          - OnDiff  means  that the  edge of  the  fillet  has a
37     --          concave side different than the two other edges,
38     --          - OnSame  means  that the  edge of  the  fillet  has a
39     --          concave side different than one of the two other edges
40     --          and identical to the third edge.
41
42     enumeration ChamfMethod from ChFiDS is 
43       Sym,
44       TwoDist,
45       DistAngle
46     end ChamfMethod from ChFiDS;
47         
48     enumeration ErrorStatus from ChFiDS is Ok,Error,WalkingFailure,
49                                    StartsolFailure, TwistedSurface 
50     end ErrorStatus from ChFiDS;
51     --- Purpose statuts concernant la cause de l'erreur 
52     
53
54     class Regul;
55
56     class Regularities instantiates List from TCollection
57                                     (Regul from ChFiDS);
58
59     class CircSection;
60     
61     class StripeArray1 instantiates Array1 from TCollection
62                               (Stripe from ChFiDS);
63
64     class SecArray1 instantiates Array1 from TCollection
65                               (CircSection from ChFiDS);
66
67     class SecHArray1 instantiates HArray1 from TCollection
68         (CircSection from ChFiDS,SecArray1 from ChFiDS);
69
70     class Map; 
71
72     class CommonPoint;
73
74     class FaceInterference;
75
76     class SurfData;
77
78     class SequenceOfSurfData instantiates Sequence from TCollection
79             (SurfData from ChFiDS);
80
81     class HData instantiates HSequence from TCollection
82             (SurfData from ChFiDS,
83              SequenceOfSurfData from ChFiDS);
84             
85     class Stripe;
86
87     class ListOfStripe instantiates List from TCollection
88             (Stripe from ChFiDS);
89             
90     class IndexedDataMapOfVertexListOfStripe instantiates 
91           IndexedDataMap from TCollection ( Vertex from TopoDS,
92                                             ListOfStripe from ChFiDS, 
93                                             ShapeMapHasher from TopTools); 
94
95     class StripeMap;
96
97     class ElSpine;
98
99     class HElSpine instantiates GenHCurve from Adaptor3d (ElSpine from ChFiDS);
100
101     class ListOfHElSpine instantiates List from TCollection
102                         (HElSpine from ChFiDS);
103
104     class Spine;
105
106     class FilSpine;   --- inherits Sp
107
108     class ChamfSpine; --- inherits Sp
109
110     class SequenceOfSpine instantiates 
111             Sequence from TCollection(Spine from ChFiDS);
112
113     
114
115 end ChFiDS;
116