moab::SetIterator Class Reference

A class to iterator over MOAB Meshsets. More...

#include <SetIterator.hpp>

Inheritance diagram for moab::SetIterator:

Collaboration diagram for moab::SetIterator:

Public Member Functions
virtual	~SetIterator ()
	destructor More...
EntityHandle	ent_set () const
	get the ent set for this iterator More...
unsigned int	chunk_size () const
	get the chunk size of this iterator More...
EntityType	ent_type () const
	get the entity type for this iterator More...
int	ent_dimension () const
	get the dimension for this iterator More...
virtual ErrorCode	get_next_arr (std::vector< EntityHandle > &arr, bool &atend)=0
	get the next chunkSize entities Return the next chunkSize entities. More...
virtual ErrorCode	reset ()=0
	reset the iterator to the beginning of the set More...

Protected Member Functions
	SetIterator (Core *core, EntityHandle eset, unsigned int chunk_sz, EntityType ent_tp, int ent_dim, bool check_valid=false)
	Constructor. More...

Protected Attributes
Core *	myCore
	Core instance. More...
EntityHandle	entSet
	handle for entity set corresponding to this iterator More...
unsigned int	chunkSize
	chunk size of this iterator More...
EntityType	entType
	entity type this iterator iterates over More...
int	entDimension
	dimension this iterator iterates over More...
bool	checkValid
	check for entity validity before returning handles More...

Friends
class	Core

Detailed Description

A class to iterator over MOAB Meshsets.

Definition at line 14 of file SetIterator.hpp.

Constructor & Destructor Documentation

~SetIterator()

moab::SetIterator::~SetIterator ( )

virtual

destructor

Definition at line 16 of file SetIterator.cpp.

{
    myCore->remove_set_iterator( this );
}

References myCore, and moab::Core::remove_set_iterator().

SetIterator()

moab::SetIterator::SetIterator ( Core *  core, EntityHandle  eset, unsigned int  chunk_sz, EntityType  ent_tp, int  ent_dim, bool  check_valid = false  )

inlineprotected

Constructor.

Parameters

core	MOAB Core instance
ent_set	EntitySet to which this iterator corresponds
chunk_size	Chunk size of this iterator
ent_type	Entity type for this iterator
ent_dim	Entity dimension for this iterator

Definition at line 64 of file SetIterator.hpp.

        : myCore( core ), entSet( eset ), chunkSize( chunk_sz ), entType( ent_tp ), entDimension( ent_dim ),
          checkValid( check_valid ) {};

Member Function Documentation

chunk_size()

unsigned int moab::SetIterator::chunk_size ( ) const

inline

get the chunk size of this iterator

Definition at line 29 of file SetIterator.hpp.

    {
        return chunkSize;
    };

References chunkSize.

ent_dimension()

int moab::SetIterator::ent_dimension ( ) const

inline

get the dimension for this iterator

Definition at line 41 of file SetIterator.hpp.

    {
        return entDimension;
    };

References entDimension.

ent_set()

EntityHandle moab::SetIterator::ent_set ( ) const

inline

get the ent set for this iterator

Definition at line 23 of file SetIterator.hpp.

    {
        return entSet;
    };

References entSet.

ent_type()

EntityType moab::SetIterator::ent_type ( ) const

inline

get the entity type for this iterator

Definition at line 35 of file SetIterator.hpp.

    {
        return entType;
    };

References entType.

get_next_arr()

virtual ErrorCode moab::SetIterator::get_next_arr ( std::vector< EntityHandle > &  arr, bool &  atend  )

pure virtual

get the next chunkSize entities Return the next chunkSize entities.

Parameters

arr	Array of entities returned.
atend	Returns true if iterator is at the end of iterable values, otherwise false

Implemented in moab::VectorSetIterator, and moab::RangeSetIterator.

reset()

virtual ErrorCode moab::SetIterator::reset ( )

pure virtual

reset the iterator to the beginning of the set

Implemented in moab::VectorSetIterator, and moab::RangeSetIterator.

Friends And Related Function Documentation

Core

friend class Core

friend

Definition at line 17 of file SetIterator.hpp.

Member Data Documentation

checkValid

bool moab::SetIterator::checkValid

protected

check for entity validity before returning handles

Definition at line 89 of file SetIterator.hpp.

Referenced by moab::RangeSetIterator::get_next_arr(), and moab::VectorSetIterator::get_next_arr().

chunkSize

unsigned int moab::SetIterator::chunkSize

protected

chunk size of this iterator

Definition at line 80 of file SetIterator.hpp.

Referenced by chunk_size(), moab::VectorSetIterator::get_next_arr(), moab::RangeSetIterator::get_next_by_dimension(), and moab::RangeSetIterator::get_next_by_type().

entDimension

int moab::SetIterator::entDimension

protected

dimension this iterator iterates over

Definition at line 86 of file SetIterator.hpp.

Referenced by ent_dimension(), moab::RangeSetIterator::get_next_arr(), moab::VectorSetIterator::get_next_arr(), and moab::RangeSetIterator::get_next_by_dimension().

entSet

EntityHandle moab::SetIterator::entSet

protected

handle for entity set corresponding to this iterator

Definition at line 77 of file SetIterator.hpp.

Referenced by moab::RangeSetIterator::build_pair_vec(), ent_set(), moab::RangeSetIterator::get_next_arr(), and moab::VectorSetIterator::get_next_arr().

entType

EntityType moab::SetIterator::entType

protected

entity type this iterator iterates over

Definition at line 83 of file SetIterator.hpp.

Referenced by ent_type(), moab::VectorSetIterator::get_next_arr(), moab::RangeSetIterator::get_next_by_dimension(), and moab::RangeSetIterator::get_next_by_type().

myCore

Core* moab::SetIterator::myCore

protected

Core instance.

Definition at line 74 of file SetIterator.hpp.

Referenced by moab::RangeSetIterator::build_pair_vec(), moab::RangeSetIterator::get_next_arr(), moab::VectorSetIterator::get_next_arr(), and ~SetIterator().

---

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

• SetIterator.hpp
• SetIterator.cpp