Files
OCCT/src/GraphTools/GraphTools_ConnectedVerticesIterator.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

109 lines
3.6 KiB
Plaintext
Executable File

-- Created on: 1993-03-18
-- Created by: Denis PASCAL
-- Copyright (c) 1993-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.
generic class ConnectedVerticesIterator from GraphTools
(Graph as any;
Vertex as any;
GIterator as any;
CVIterator as any)
--generic class ConnectedVerticesIterator from GraphTools
-- (Graph as any;
-- Vertex as any;
-- GIterator as GraphIterator (Graph,Vertex))
-- CVIterator as ConnectedVerticesFromIterator
---Purpose: In a graph, returns subsets of a list of vertices in
-- which all vertices are connected.
is
Create
---Purpose: Create an empty algorithm.
returns ConnectedVerticesIterator from GraphTools;
Create (G : Graph)
---Purpose: Create the algorithm setting each vertex of <G>
-- reached by GIterator tool, as initial conditions.
-- Use Perform method before visting the result of
-- the algorithm.
returns ConnectedVerticesIterator from GraphTools;
FromGraph (me : in out; G : Graph);
---Purpose: Add each vertex of <G> reached by GIterator tool
-- as initial conditions. Use Perform method
-- before visiting the result of the algorithm.
---Level: Public;
FromVertex (me : in out; V : Vertex);
---Purpose: Add <V> as research condition. This method is
-- cumulative. User must used Perform method before
-- visting the result of the algorithm.
---Level: Public
Reset (me : in out);
---Purpose: Reset the algorithm. It may be reused with new
-- initial conditions.
---Level: Public
Perform (me : in out; G : Graph);
---Purpose: Peform the algorithm in <G> from initial setted
-- conditions.
---Level: Public
More(me)
---Purpose: Returns TRUE if there are others subset of
-- connected vertices.
---Level: Public
returns Boolean from Standard;
Next (me : in out);
---Purpose: Set the iterator to the next subset of connected
-- vertices.
---Level: Public
NbVertices (me)
returns Integer from Standard;
---Purpose: Returns number of vertices of the current subset
-- of connected vertices.
---Level: Public
Value (me; index : Integer from Standard)
returns any Vertex;
---Purpose: Returns a vertex member of the current subset of
-- connected vertices.
---Level: Public
---C++: return const&
fields
myIterator : CVIterator;
end ConnectedVerticesIterator;