MOAB: Mesh Oriented datABase  (version 5.2.1)
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

CoremyCore
 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

destructor

Definition at line 16 of file SetIterator.cpp.

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

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:
coreMOAB Core instance
ent_setEntitySet to which this iterator corresponds
chunk_sizeChunk size of this iterator
ent_typeEntity type for this iterator
ent_dimEntity 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;
    };

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:
arrArray of entities returned.
atendReturns 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

check for entity validity before returning handles

Definition at line 85 of file SetIterator.hpp.

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

handle for entity set corresponding to this iterator

Definition at line 73 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]

List of all members.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines