1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-05-01 10:26:12 +03:00
occt/src/Interface/Interface_EntityIterator.cdl
dln 6268cc68d7 0024885: Getting rid of "TKAdvTools" toolkit
"TKAdvTools" toolkit was deleted.
And packages from this toolkit were:
- GraphDS -> deleted
- GraphTools -> moved to WOK
- Dynamic -> deleted
- Materials -> deleted
- Expr -> moved to TKMath
- ExprIntrp -> moved to TKMath
- TKAdvTools -> deleted
All references of the "TKAdvTools" toolkit were removed
2014-05-22 17:21:44 +04:00

93 lines
3.4 KiB
Plaintext

-- Created on: 1992-02-03
-- Created by: Christian CAILLET
-- 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.
class EntityIterator from Interface
---Purpose : Defines an Iterator on Entities.
-- Allows considering of various criteria
uses Transient, HSequenceOfTransient from TColStd,
IntVal, InterfaceModel
raises NoMoreObject, NoSuchObject
is
Create returns EntityIterator;
---Purpose : Defines an empty iterator (see AddList & AddItem)
Create (list : HSequenceOfTransient) returns EntityIterator;
---Purpose : Defines an iterator on a list, directly i.e. without copying it
AddList (me : in out; list : HSequenceOfTransient);
---Purpose : Gets a list of entities and adds its to the iteration list
AddItem (me : in out; anentity : any Transient);
---Purpose : Adds to the iteration list a defined entity
GetOneItem (me : in out; anentity : any Transient) is static;
---Purpose : same as AddItem (kept for compatibility)
Reset (me : in out) is protected;
---Purpose : Allows subclasses of EntityIterator to reevaluate an iteration
SelectType (me : in out; atype : Type; keep : Boolean);
---Purpose : Selects entities with are Kind of a given type, keep only
-- them (is keep is True) or reject only them (if keep is False)
NbEntities (me) returns Integer is static;
---Purpose : Returns count of entities which will be iterated on
-- Calls Start if not yet done
NbTyped (me; type : Type) returns Integer is static;
---Purpose : Returns count of entities of a given type (kind of)
Typed (me; type : Type) returns EntityIterator;
---Purpose : Returns the list of entities of a given type (kind of)
Start (me) is virtual;
---Purpose : Allows re-iteration (useless for the first iteration)
More (me) returns Boolean;
---Purpose : Says if there are other entities (vertices) to iterate
-- the first time, calls Start
Next (me) raises NoMoreObject;
---Purpose : Sets iteration to the next entity (vertex) to give
Value (me) returns any Transient raises NoSuchObject;
---Purpose : Returns the current Entity iterated, to be used by Interface
-- tools
---C++ : return const &
Content (me) returns HSequenceOfTransient;
---Purpose : Returns the content of the Iterator, accessed through a Handle
-- to be used by a frontal-engine logic
-- Returns an empty Sequence if the Iterator is empty
-- Calls Start if not yet done
Destroy (me : in out) is virtual;
---Purpose : Clears data of iteration
---C++: alias "Standard_EXPORT virtual ~Interface_EntityIterator() { Destroy();}"
fields
thecurr : IntVal;
thelist : HSequenceOfTransient;
end EntityIterator;