[occt.git] / src / IntStart / IntStart_SearchOnBoundaries.cdl

-- File:	SearchOnBoundaries.cdl
-- Created:	Fri Sep  4 11:43:50 1992
-- Author:	Jacques GOUSSARD
--		<jag@sdsun2>
---Copyright:	 Matra Datavision 1992


generic class SearchOnBoundaries from IntStart (
  TheVertex            as any;
  TheArc               as any;
  TheArcTool           as any;  -- as ArcTool   from IntStart(TheArc)
  TheSOBTool           as any;  -- as SOBTool   from IntStart(TheVertex,TheArc)
  TheTopolTool         as Transient;  -- as TopolTool from IntStart
                                      -- (TheVertex,TheArc)
  TheFunction          as any)  -- as SOBFunction from IntStart(TheArc)


	---Purpose: This class implements algorithmes to find the intersection
	--          points and curves between the arcs of restriction
	--          of a surface (parametric or implicit), used through
	--          the classes TheArcTool, TheSOBTool and TheTopolTool,
	--          and an implicit surface (natural quadric : Pln, Cylinder,
	--          Cone, Sphere from gp)..


raises NotDone           from StdFail,
       OutOfRange        from Standard,
       ConstructionError from Standard


    class ThePathPoint instantiates PathPoint from IntStart
            (TheVertex,TheArc);

    class SequenceOfPathPoint instantiates Sequence from TCollection
	    (ThePathPoint);

    class TheSegment instantiates Segment from IntStart
            (TheVertex,
             TheArc,
             ThePathPoint);

    class SequenceOfSegment instantiates Sequence from TCollection
            (TheSegment);


is

    Create
    
	---Purpose: Empty constructor.

    	returns SearchOnBoundaries from IntStart;


    Perform(me    : in out;
    	    F     : in out TheFunction;
            Domain: TheTopolTool;
            TolBoundary,TolTangency : Real from Standard)

       	---Purpose: Algorithm to find the points and parts of curves of Domain
       	--          (domain of of restriction of a surface) which verify
       	--          F = 0.
       	--          TolBoundary defines if a curve is on Q.
       	--          TolTangency defines if a point is on Q.

    	raises ConstructionError from Standard
	--     The exception ConstructionError is raised if one of the bounds
	--     of an arc of the domain is infinite. See the method Bounds
	--     of the class SOBTool.

       	is static;


    IsDone(me)
    
    	---Purpose: Returns True if the calculus was successful.

    	returns Boolean from Standard
	---C++: inline

    	is static;


    AllArcSolution(me)
    
	---Purpose: Returns true if all arc of the Arcs are solution (inside
	--          the surface).
	--          An exception is raised if IsDone returns False.

    	returns Boolean from Standard
	---C++: inline
	
	raises NotDone from StdFail
	
	is static;


    NbPoints(me)
    
    	---Purpose: Returns the number of resulting points.
    	--          An exception is raised if IsDone returns False (NotDone).
    
    	returns Integer from Standard
	---C++: inline
	
	raises NotDone from StdFail
    
        is static;


    Point(me; Index: Integer from Standard)
    
	---Purpose: Returns the resulting point of range Index.
	--          The exception NotDone is raised if IsDone() returns
	--          False.
	--          The exception OutOfRange is raised if
	--          Index <= 0 or Index > NbPoints.
    
    	returns ThePathPoint from IntStart
	---C++: return const&
	---C++: inline
	
	raises NotDone    from StdFail,
	       OutOfRange from Standard

    	is static;


    NbSegments(me)
   
    	---Purpose: Returns the number of the resulting segments.
    	--          An exception is raised if IsDone returns False (NotDone).

    	returns Integer from Standard
	---C++: inline
	
	raises NotDone from StdFail

    	is static;


    Segment(me; Index: Integer from Standard)
    
	---Purpose: Returns the resulting segment of range Index.
	--          The exception NotDone is raised if IsDone() returns
	--          False.
	--          The exception OutOfRange is raised if
	--          Index <= 0 or Index > NbPoints.

    	returns TheSegment from IntStart
	---C++: return const&
	---C++: inline

	raises NotDone    from StdFail,
	       OutOfRange from Standard

    	is static;


fields

    done : Boolean                  from Standard;
    all  : Boolean                  from Standard;
    sseg : SequenceOfSegment        from IntStart;
    spnt : SequenceOfPathPoint      from IntStart;

end SearchOnBoundaries;
Commit	Line	Data
7fd59977	1	-- File: SearchOnBoundaries.cdl
	2	-- Created: Fri Sep 4 11:43:50 1992
	3	-- Author: Jacques GOUSSARD
	4	-- <jag@sdsun2>
	5	---Copyright: Matra Datavision 1992
	6
	7
	8
	9	generic class SearchOnBoundaries from IntStart (
	10	TheVertex as any;
	11	TheArc as any;
	12	TheArcTool as any; -- as ArcTool from IntStart(TheArc)
	13	TheSOBTool as any; -- as SOBTool from IntStart(TheVertex,TheArc)
	14	TheTopolTool as Transient; -- as TopolTool from IntStart
	15	-- (TheVertex,TheArc)
	16	TheFunction as any) -- as SOBFunction from IntStart(TheArc)
	17
	18
	19	---Purpose: This class implements algorithmes to find the intersection
	20	-- points and curves between the arcs of restriction
	21	-- of a surface (parametric or implicit), used through
	22	-- the classes TheArcTool, TheSOBTool and TheTopolTool,
	23	-- and an implicit surface (natural quadric : Pln, Cylinder,
	24	-- Cone, Sphere from gp)..
	25
	26
	27	raises NotDone from StdFail,
	28	OutOfRange from Standard,
	29	ConstructionError from Standard
	30
	31
	32	class ThePathPoint instantiates PathPoint from IntStart
	33	(TheVertex,TheArc);
	34
	35	class SequenceOfPathPoint instantiates Sequence from TCollection
	36	(ThePathPoint);
	37
	38	class TheSegment instantiates Segment from IntStart
	39	(TheVertex,
	40	TheArc,
	41	ThePathPoint);
	42
	43	class SequenceOfSegment instantiates Sequence from TCollection
	44	(TheSegment);
	45
	46
	47	is
	48
	49	Create
	50
	51	---Purpose: Empty constructor.
	52
	53	returns SearchOnBoundaries from IntStart;
	54
	55
	56	Perform(me : in out;
	57	F : in out TheFunction;
	58	Domain: TheTopolTool;
	59	TolBoundary,TolTangency : Real from Standard)
	60
	61	---Purpose: Algorithm to find the points and parts of curves of Domain
	62	-- (domain of of restriction of a surface) which verify
	63	-- F = 0.
	64	-- TolBoundary defines if a curve is on Q.
65	-- TolTangency defines if a point is on Q.
66
67	raises ConstructionError from Standard
68	-- The exception ConstructionError is raised if one of the bounds
69	-- of an arc of the domain is infinite. See the method Bounds
70	-- of the class SOBTool.
71
72	is static;
73
74
75	IsDone(me)
76
77	---Purpose: Returns True if the calculus was successful.
78
79	returns Boolean from Standard
80	---C++: inline
81
82	is static;
83
84
85	AllArcSolution(me)
86
87	---Purpose: Returns true if all arc of the Arcs are solution (inside
88	-- the surface).
89	-- An exception is raised if IsDone returns False.
90
91	returns Boolean from Standard
92	---C++: inline
93
94	raises NotDone from StdFail
95
96	is static;
97
98
99	NbPoints(me)
100
101	---Purpose: Returns the number of resulting points.
102	-- An exception is raised if IsDone returns False (NotDone).
103
104	returns Integer from Standard
105	---C++: inline
106
107	raises NotDone from StdFail
108
109	is static;
110
111
112	Point(me; Index: Integer from Standard)
113
114	---Purpose: Returns the resulting point of range Index.
115	-- The exception NotDone is raised if IsDone() returns
116	-- False.
117	-- The exception OutOfRange is raised if
118	-- Index <= 0 or Index > NbPoints.
119
120	returns ThePathPoint from IntStart
121	---C++: return const&
122	---C++: inline
123
124	raises NotDone from StdFail,
125	OutOfRange from Standard
126
127	is static;
128
129
130	NbSegments(me)
131
132	---Purpose: Returns the number of the resulting segments.
133	-- An exception is raised if IsDone returns False (NotDone).
134
135	returns Integer from Standard
136	---C++: inline
137
138	raises NotDone from StdFail
139
140	is static;
141
142
143	Segment(me; Index: Integer from Standard)
144
145	---Purpose: Returns the resulting segment of range Index.
146	-- The exception NotDone is raised if IsDone() returns
147	-- False.
148	-- The exception OutOfRange is raised if
149	-- Index <= 0 or Index > NbPoints.
150
151	returns TheSegment from IntStart
152	---C++: return const&
153	---C++: inline
154
155	raises NotDone from StdFail,
156	OutOfRange from Standard
157
158	is static;
159
160
161	fields
162
163	done : Boolean from Standard;
164	all : Boolean from Standard;
165	sseg : SequenceOfSegment from IntStart;
166	spnt : SequenceOfPathPoint from IntStart;
167
168	end SearchOnBoundaries;