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

-- Created on: 1992-09-04
-- Created by: Jacques GOUSSARD
-- Copyright (c) 1992-1999 Matra Datavision
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and/or modify it under
-- the terms of the GNU Lesser General Public License version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.

generic class SearchOnBoundaries from IntStart (
  TheVertex            as any;
  TheArc               as any;
  TheArcTool           as any;
  TheSOBTool           as any;
  TheTopolTool         as Transient;
  TheFunction          as any)


	---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;
	    RecheckOnRegularity : Boolean from Standard = Standard_False)

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