Integration of OCCT 6.5.0 from SVN
[occt.git] / src / IntCurveSurface / IntCurveSurface_Intersection.cdl
1 -- File:        IntCurveSurface_Intersection.cdl
2 -- Created:     Wed Apr  7 16:18:57 1993
3 -- Author:      Laurent BUCHARD
4 --              <lbr@sdsun2>
5 ---Copyright:    Matra Datavision 1993
6
7
8 deferred class Intersection from IntCurveSurface
9
10     ---Level: Public
11
12 uses 
13     IntersectionPoint   from IntCurveSurface,
14     IntersectionSegment from IntCurveSurface,
15     SequenceOfPnt       from IntCurveSurface,
16     SequenceOfSeg       from IntCurveSurface
17
18
19 raises NotDone    from StdFail,
20        OutOfRange from Standard
21
22
23 is 
24
25     Initialize
26         ---Purpose: Empty Constructor;
27         is protected;
28         
29     IsDone(me) 
30         ---Purpose: returns the <done> field.
31         returns Boolean from Standard is static;
32
33     NbPoints(me)
34         ---Purpose: returns the number of IntersectionPoint
35         --          if IsDone returns True.
36         --          else NotDone is raised.
37         returns Integer from Standard 
38         raises  NotDone from StdFail 
39         is static;
40         
41     Point(me; Index: Integer from Standard) 
42         ---Purpose: returns the IntersectionPoint of range <Index>
43         --          raises NotDone if the computation has failed or if 
44         --          the computation has not been done
45         --          raises OutOfRange if Index is not in the range <1..NbPoints>
46         ---C++: return const &
47         returns IntersectionPoint from IntCurveSurface
48         raises  NotDone           from StdFail,
49                 OutOfRange        from Standard
50         is static;
51         
52     NbSegments(me)
53         ---Purpose: returns the number of IntersectionSegment
54         --          if IsDone returns True.
55         --          else NotDone is raised.
56         returns Integer from Standard 
57         raises  NotDone from StdFail 
58         is static;
59         
60     Segment(me; Index: Integer from Standard) 
61         ---Purpose: returns the IntersectionSegment of range <Index>
62         --          raises NotDone if the computation has failed or if 
63         --          the computation has not been done
64         --          raises OutOfRange if Index is not in the range <1..NbSegment>
65         ---C++: return const &
66         returns IntersectionSegment from IntCurveSurface
67         raises  NotDone             from StdFail,
68                 OutOfRange          from Standard
69         is static;
70         
71     SetValues(me:in out; Inter: Intersection from IntCurveSurface)
72         ---Purpose: Internal method
73         --          copy the <Inter> fields to <me>
74         is static protected;
75     
76     Append(me:in out; Inter: Intersection from IntCurveSurface;
77            FirstParamOnCurve: Real from Standard;
78            LastParamOnCurve : Real from Standard)
79         ---Purpose: Internal method
80         --          Append the IntersectionPoints and 
81         --          IntersectionSegments of <Inter> to <me>.
82         is static protected;
83      
84     Append(me:in out; Pt: IntersectionPoint from IntCurveSurface)
85         ---Purpose: Internal method
86         --          Append the IntersectionPoints of <Inter> to <me>
87         is static protected;
88     
89     Append(me:in out; Seg: IntersectionSegment from IntCurveSurface)
90         ---Purpose: Internal method
91         --          Append the IntersectionPoints of <Inter> to <me>
92         is static protected;
93     
94     ResetFields(me:in out)
95         ---Purpose: Internal method
96         --          Reset all the fields of <me>
97         --          Clear the sequences of IntersectionPoints and Segments
98         --          Set the field <done> to Standard_False.
99         is static protected;
100
101     Dump(me)
102         ---Purpose: Dump all the fields.
103         is static;
104
105
106 fields 
107      done      : Boolean        from Standard           is protected;
108      lpnt      : SequenceOfPnt  from IntCurveSurface;
109      lseg      : SequenceOfSeg  from IntCurveSurface;
110 end Intersection;
111