moab::SetIterator Class Reference

#include <SetIterator.hpp>

Inheritance diagram for moab::SetIterator:

Collaboration diagram for moab::SetIterator:

Public Member Functions
virtual	~SetIterator ()
	destructor
EntityHandle	ent_set () const
	get the ent set for this iterator
unsigned int	chunk_size () const
	get the chunk size of this iterator
EntityType	ent_type () const
	get the entity type for this iterator
int	ent_dimension () const
	get the dimension for this iterator
virtual ErrorCode	get_next_arr (std::vector< EntityHandle > &arr, bool &atend)=0
	get the next chunkSize entities Return the next chunkSize entities.
virtual ErrorCode	reset ()=0
	reset the iterator to the beginning of the set
Protected Member Functions
	SetIterator (Core *core, EntityHandle eset, unsigned int chunk_sz, EntityType ent_tp, int ent_dim, bool check_valid=false)
	Constructor.
Protected Attributes
Core *	myCore
	Core instance.
EntityHandle	entSet
	handle for entity set corresponding to this iterator
unsigned int	chunkSize
	chunk size of this iterator
EntityType	entType
	entity type this iterator iterates over
int	entDimension
	dimension this iterator iterates over
bool	checkValid
	check for entity validity before returning handles
Friends
class	Core

---

Detailed Description

Definition at line 14 of file SetIterator.hpp.

---

Constructor & Destructor Documentation

moab::SetIterator::~SetIterator

(

)

[virtual]

destructor

Definition at line 16 of file SetIterator.cpp.

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

{
    myCore->remove_set_iterator( this );
}

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

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

unsigned int moab::SetIterator::chunk_size

(

)

const [inline]

get the chunk size of this iterator

Definition at line 29 of file SetIterator.hpp.

References chunkSize.

    {
        return chunkSize;
    };

int moab::SetIterator::ent_dimension

(

)

const [inline]

get the dimension for this iterator

Definition at line 41 of file SetIterator.hpp.

References entDimension.

    {
        return entDimension;
    };

EntityHandle moab::SetIterator::ent_set

(

)

const [inline]

get the ent set for this iterator

Definition at line 23 of file SetIterator.hpp.

References entSet.

    {
        return entSet;
    };

EntityType moab::SetIterator::ent_type

(

)

const [inline]

get the entity type for this iterator

Definition at line 35 of file SetIterator.hpp.

References entType.

    {
        return entType;
    };

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.

Referenced by query_elem_to_vert_iters(), query_vert_to_elem_iters(), and test_iterator().

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

friend class Core [friend]

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

Definition at line 17 of file SetIterator.hpp.

---

Member Data Documentation

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().

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().

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().

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().

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().

Core* moab::SetIterator::myCore [protected]

Core instance.

Definition at line 71 of file SetIterator.hpp.

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

List of all members.

---

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

• SetIterator.hpp
• SetIterator.cpp