1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-21 10:13:43 +03:00
occt/src/GraphTools/GraphTools_BFSIterator.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

80 lines
2.7 KiB
Plaintext
Executable File

-- Created on: 1992-10-12
-- Created by: Denis PASCAL
-- Copyright (c) 1992-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 BFSIterator from GraphTools
(Graph as any;
Vertex as any;
VHasher as any;
VIterator as any)
--generic class BFSIterator from GraphTools
-- (Graph as any;
-- Vertex as any;
-- VHasher as MapHasher from TCollection (Vertex);
-- VIterator as VertexIterator (Graph,Vertex))
---Purpose: This generic class implement the Breadth First Search
-- algorithm from a Vertex with an iterator to reached
-- adjacent vertices of a given one. The interface of
-- this algorithm is made as an iterator.
raises NoMoreObject from Standard,
NoSuchObject from Standard
class BFSMap instantiates IndexedMap from TCollection (Vertex,VHasher);
is
Create
returns BFSIterator;
---Purpose: Create an empty iterator.
Perform (me : in out; G : Graph; V : Vertex);
---Purpose: Initializes the research from <V> member vertex of <G>.
---Level: Public
More (me) returns Boolean from Standard;
---Purpose: Returns True if there are other vertices.
---Level: Public
Next(me : in out)
---Purpose: Set the iterator to the next vertex.
---Level: Public
raises NoMoreObject from Standard;
Value(me) returns any Vertex
---Purpose: returns the vertex value for the current
-- position of the iterator.
---Level: Public
---C++: return const &
raises NoSuchObject from Standard;
fields
myVisited : BFSMap from GraphTools;
myCurrentIndex : Integer from Standard;
end BFSIterator;