Interface_EntityIterator Class Reference

Defines an Iterator on Entities. Allows considering of various criteria. More...

#include <Interface_EntityIterator.hxx>

Inheritance diagram for Interface_EntityIterator:

Public Member Functions
	Interface_EntityIterator ()
	Defines an empty iterator (see AddList & AddItem)
	Interface_EntityIterator (const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &list)
	Defines an iterator on a list, directly i.e. without copying it.
void	AddList (const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &list)
	Gets a list of entities and adds its to the iteration list.
void	AddItem (const occ::handle< Standard_Transient > &anentity)
	Adds to the iteration list a defined entity.
void	GetOneItem (const occ::handle< Standard_Transient > &anentity)
	same as AddItem (kept for compatibility)
void	SelectType (const occ::handle< Standard_Type > &atype, const bool 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)
int	NbEntities () const
	Returns count of entities which will be iterated on Calls Start if not yet done.
int	NbTyped (const occ::handle< Standard_Type > &type) const
	Returns count of entities of a given type (kind of)
Interface_EntityIterator	Typed (const occ::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)
bool	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 occ::handle< Standard_Transient > &	Value () const
	Returns the current Entity iterated, to be used by Interface tools.
occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > >	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.
void	Destroy ()
	Clears data of iteration.
virtual	~Interface_EntityIterator ()
	Destructor.

Protected Member Functions
void	Reset ()
	Allows subclasses of EntityIterator to reevaluate an iteration.

Detailed Description

Defines an Iterator on Entities. Allows considering of various criteria.

Constructor & Destructor Documentation

Interface_EntityIterator() [1/2]

Interface_EntityIterator::Interface_EntityIterator

(

)

Defines an empty iterator (see AddList & AddItem)

Interface_EntityIterator() [2/2]

Interface_EntityIterator::Interface_EntityIterator

(

const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &

list

)

Defines an iterator on a list, directly i.e. without copying it.

~Interface_EntityIterator()

virtual Interface_EntityIterator::~Interface_EntityIterator ( )

virtual

Destructor.

Member Function Documentation

AddItem()

void Interface_EntityIterator::AddItem

(

const occ::handle< Standard_Transient > &

anentity

)

Adds to the iteration list a defined entity.

AddList()

void Interface_EntityIterator::AddList

(

const occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > &

list

)

Gets a list of entities and adds its to the iteration list.

Content()

occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > Interface_EntityIterator::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.

Destroy()

void Interface_EntityIterator::Destroy

(

)

Clears data of iteration.

GetOneItem()

void Interface_EntityIterator::GetOneItem

(

const occ::handle< Standard_Transient > &

anentity

)

same as AddItem (kept for compatibility)

More()

bool Interface_EntityIterator::More

(

)

const

Says if there are other entities (vertices) to iterate the first time, calls Start.

NbEntities()

int Interface_EntityIterator::NbEntities

(

)

const

Returns count of entities which will be iterated on Calls Start if not yet done.

NbTyped()

int Interface_EntityIterator::NbTyped

(

const occ::handle< Standard_Type > &

type

)

const

Returns count of entities of a given type (kind of)

Next()

void Interface_EntityIterator::Next

(

)

const

Sets iteration to the next entity (vertex) to give.

Reset()

void Interface_EntityIterator::Reset ( )

protected

Allows subclasses of EntityIterator to reevaluate an iteration.

SelectType()

void Interface_EntityIterator::SelectType	(	const occ::handle< Standard_Type > &	atype,
		const bool	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)

Start()

virtual void Interface_EntityIterator::Start ( ) const

virtual

Allows re-iteration (useless for the first iteration)

Typed()

Interface_EntityIterator Interface_EntityIterator::Typed

(

const occ::handle< Standard_Type > &

type

)

const

Returns the list of entities of a given type (kind of)

Value()

const occ::handle< Standard_Transient > & Interface_EntityIterator::Value

(

)

const

Returns the current Entity iterated, to be used by Interface tools.

---

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

• Interface_EntityIterator.hxx