OrientationIter Class Reference

An Iterator over the Orientation of Faces of a Box. More...

#include <Orientation.H>

List of all members.

Public Member Functions

 OrientationIter ()
 The default constructor.
 OrientationIter (const Orientation &_face)
 Construct an iterator on the Orientation.
 OrientationIter (const OrientationIter &it)
 The copy constructor.
OrientationIteroperator= (const OrientationIter &it)
 The assignment operator.
void rewind ()
 Reset (rewind) the iterator.
Orientation operator() () const
 Return the orientation of the face.
 operator void * ()
 Cast to void*. Used to test if iterator is valid.
OrientationIteroperator-- ()
 Pre-decrement.
OrientationIteroperator++ ()
 Pre-increment.
OrientationIter operator-- (int)
 Post-decrement.
OrientationIter operator++ (int)
 Post-increment.
bool operator== (const OrientationIter &oi) const
 The equality operator.
bool operator!= (const OrientationIter &oi) const
 The inequality operator.

Protected Member Functions

 OrientationIter (int _face)
bool ok () const

Protected Attributes

int face


Detailed Description

An Iterator over the Orientation of Faces of a Box.

Constructor & Destructor Documentation

OrientationIter::OrientationIter (  )  [inline]

The default constructor.

Referenced by operator++(), and operator--().

OrientationIter::OrientationIter ( const Orientation _face  )  [inline]

Construct an iterator on the Orientation.

OrientationIter::OrientationIter ( const OrientationIter it  )  [inline]

The copy constructor.

References BL_ASSERT, face, and ok().

OrientationIter::OrientationIter ( int  _face  )  [inline, protected]


Member Function Documentation

OrientationIter & OrientationIter::operator= ( const OrientationIter it  )  [inline]

The assignment operator.

References BL_ASSERT, face, and ok().

void OrientationIter::rewind (  )  [inline]

Reset (rewind) the iterator.

References face.

Orientation OrientationIter::operator() (  )  const [inline]

Return the orientation of the face.

References BL_ASSERT, face, and ok().

OrientationIter::operator void * (  )  [inline]

Cast to void*. Used to test if iterator is valid.

References face.

OrientationIter & OrientationIter::operator-- (  )  [inline]

Pre-decrement.

References BL_ASSERT, face, and ok().

OrientationIter & OrientationIter::operator++ (  )  [inline]

Pre-increment.

References BL_ASSERT, face, and ok().

OrientationIter OrientationIter::operator-- ( int   )  [inline]

Post-decrement.

References BL_ASSERT, face, ok(), and OrientationIter().

OrientationIter OrientationIter::operator++ ( int   )  [inline]

Post-increment.

References BL_ASSERT, face, ok(), and OrientationIter().

bool OrientationIter::operator== ( const OrientationIter oi  )  const [inline]

The equality operator.

References BL_ASSERT, face, and ok().

bool OrientationIter::operator!= ( const OrientationIter oi  )  const [inline]

The inequality operator.

References BL_ASSERT, face, and ok().

bool OrientationIter::ok (  )  const [inline, protected]


Member Data Documentation

int OrientationIter::face [protected]


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

Generated on Fri Nov 21 10:11:02 2008 for AMRParticlePaths by  doxygen 1.5.5