SENSEI
A frame work for generic in situ analytics
sensei::ArrayRequirementsIterator Class Reference

Iterate over the mesh's arrays. More...

#include <DataRequirements.h>

Public Types

enum  { MODE_ARRAY, MODE_ASSOCIATION }
 

Public Member Functions

 ArrayRequirementsIterator (const DataRequirements::AssocArrayMapType &aa)
 
void SetMode (int mode)
 Set the mode of operator++. More...
 
 operator bool () const
 Test if the iterator is finished. More...
 
int Association ()
 returns the type of requirement (point,cell, etc) More...
 
const std::vector< std::string > & Arrays ()
 Get the next group of requied arrays. More...
 
const std::string & Array ()
 Get the next requied array. More...
 
ArrayRequirementsIteratoroperator++ ()
 Advance the iterator. More...
 
ArrayRequirementsIteratorNextAssociation ()
 move to the next group od arrays More...
 
ArrayRequirementsIteratorNextArray ()
 advance to the next array More...
 

Detailed Description

Iterate over the mesh's arrays.

One can iterate either over associations and access all of an associations arrays or one by one over the arrays.

Member Function Documentation

◆ Array()

const std::string& sensei::ArrayRequirementsIterator::Array ( )
inline

Get the next requied array.

◆ Arrays()

const std::vector<std::string>& sensei::ArrayRequirementsIterator::Arrays ( )
inline

Get the next group of requied arrays.

◆ Association()

int sensei::ArrayRequirementsIterator::Association ( )
inline

returns the type of requirement (point,cell, etc)

◆ NextArray()

ArrayRequirementsIterator& sensei::ArrayRequirementsIterator::NextArray ( )
inline

advance to the next array

◆ NextAssociation()

ArrayRequirementsIterator& sensei::ArrayRequirementsIterator::NextAssociation ( )
inline

move to the next group od arrays

◆ operator bool()

sensei::ArrayRequirementsIterator::operator bool ( ) const
inline

Test if the iterator is finished.

◆ operator++()

ArrayRequirementsIterator& sensei::ArrayRequirementsIterator::operator++ ( )
inline

Advance the iterator.

◆ SetMode()

void sensei::ArrayRequirementsIterator::SetMode ( int  mode)
inline

Set the mode of operator++.


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