template <class T> class FaceIterator

Iterator for moving through the faces of classes

Inheritance:

public members:

Constructors, destructors, defines

FaceIterator ()

FaceIterator (const T& tx, int idirin, EIType::FaceIteratorType Eloc)

FaceIterator (const FaceIterator <T>& tx)

void define (const T& tx, int idirin, EIType::FaceIteratorType Eloc)

~FaceIterator ()

Modification functions

void begin()

void next()

Access functions

const Face & operator() () const

int index()

bool ok()

FaceIterator ()

Default constructor. This constructs an invalid iterator. The user must call define before using.

FaceIterator (const T& tx, int idirin, EIType::FaceIteratorType Eloc)

constructor

Arguments:
tx (not modified) is a class containing a Vector of Faces.
idirin (not modified) is the direction normal to the faces.
Returns: none.
This:
This object is modified.

FaceIterator (const FaceIterator <T>& tx)

copy constructor

Arguments:
tx (not modified) is another FaceIterator.
Returns: none.
This:
This object is modified.

void define (const T& tx, int idirin, EIType::FaceIteratorType Eloc)

Define which Vector of Faces is associated with this iterator.

Arguments:
tx (not modified) is a class containing a Vector of Faces.
idirin (not modified) is the direction normal to the faces.
Returns: none.
This:
This object is modified.

~FaceIterator ()

Default destructor.

void begin ()

Sets the iterator to the first face.

Arguments: none.
Returns: none.
This:
This object is modified.

void next ()

Advances the iterator to the next face.

Arguments: none.
Returns: none.
This:
This object is modified.

const Face & operator() () const

Returns the value of the face for the current iteration.

Arguments: none.
Returns:
Returns the value of the face for the current iteration.
This:
This object is not modified.

int index ()

Returns the index of the face for the current iteration.

Arguments: none.
Returns:
Returns the index of the face for the current iteration.
This:
This object is not modified.

bool ok ()

Checks to see if there is a next face.

Arguments: none.
Returns:
true if there is a next face.
false otherwise.
This:
This object is not modified.

this page has been generated automatically by doc++