Interface_EntityIterator Class Reference

Defines an Iterator on Entities, complying with GraphTools
needs. Allows considering of various criteria

#include <Interface_EntityIterator.hxx>

Inheritance diagram for Interface_EntityIterator:

Public Member Functions
DEFINE_STANDARD_ALLOC	Interface_EntityIterator ()
	Defines an empty iterator (see AddList & AddItem)
	Interface_EntityIterator (const Handle< TColStd_HSequenceOfTransient > &list)
	Defines an iterator on a list, directly i.e. without copying it
void	AddList (const Handle< TColStd_HSequenceOfTransient > &list)
	Gets a list of entities and adds its to the iteration list
void	AddItem (const Handle< Standard_Transient > &anentity)
	Adds to the iteration list a defined entity
void	GetOneItem (const Handle< Standard_Transient > &anentity)
	same as AddItem (kept for compatibility)
void	SelectType (const Handle< Standard_Type > &atype, const Standard_Boolean keep)
	Selects entities with are Kind of a given type, keep only them (is keep is True) or reject only them (if keep is False)
Standard_Integer	NbEntities () const
	Returns count of entities which will be iterated on Calls Start if not yet done
Standard_Integer	NbTyped (const Handle< Standard_Type > &type) const
	Returns count of entities of a given type (kind of)
Interface_EntityIterator	Typed (const Handle< Standard_Type > &type) const
	Returns the list of entities of a given type (kind of)
virtual void	Start () const
	Allows re-iteration (useless for the first iteration)
Standard_Boolean	More () const
	Says if there are other entities (vertices) to iterate the first time, calls Start
void	Next () const
	Sets iteration to the next entity (vertex) to give
const Handle_Standard_Transient &	Value () const
	Returns the current Entity iterated, to be used by Interface tools or by GraphTools (where Entity is a Vertex)
Handle_TColStd_HSequenceOfTransient	Content () const
	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
virtual void	Destroy ()
	Clears data of iteration
virtual	~Interface_EntityIterator ()
Protected Member Functions
void	Reset ()
	Allows subclasses of EntityIterator to reevaluate an iteration

---

Constructor & Destructor Documentation

DEFINE_STANDARD_ALLOC Interface_EntityIterator::Interface_EntityIterator

(

)

Interface_EntityIterator::Interface_EntityIterator

(

const Handle< TColStd_HSequenceOfTransient > &

list

)

virtual Interface_EntityIterator::~Interface_EntityIterator

(

)

[inline, virtual]

---

Member Function Documentation

void Interface_EntityIterator::AddItem

(

const Handle< Standard_Transient > &

anentity

)

void Interface_EntityIterator::AddList

(

const Handle< TColStd_HSequenceOfTransient > &

list

)

Handle_TColStd_HSequenceOfTransient Interface_EntityIterator::Content

(

)

const

virtual void Interface_EntityIterator::Destroy

(

)

[virtual]

void Interface_EntityIterator::GetOneItem

(

const Handle< Standard_Transient > &

anentity

)

Standard_Boolean Interface_EntityIterator::More

(

)

const

Standard_Integer Interface_EntityIterator::NbEntities

(

)

const

Standard_Integer Interface_EntityIterator::NbTyped

(

const Handle< Standard_Type > &

type

)

const

void Interface_EntityIterator::Next

(

)

const

void Interface_EntityIterator::Reset

(

)

[protected]

void Interface_EntityIterator::SelectType	(	const Handle< Standard_Type > &	atype,
		const Standard_Boolean	keep
	)

virtual void Interface_EntityIterator::Start

(

)

const [virtual]

Interface_EntityIterator Interface_EntityIterator::Typed

(

const Handle< Standard_Type > &

type

)

const

const Handle_Standard_Transient& Interface_EntityIterator::Value

(

)

const

---

The documentation for this class was generated from the following file:

• Interface_EntityIterator.hxx