LayoutIndex Class Reference

#include <DataIndex.H>

Inheritance diagram for LayoutIndex:

[legend]

List of all members.

---

Detailed Description

An index for LayoutIterator.

Public Member Functions
	LayoutIndex ()
	~LayoutIndex ()
bool	operator== (const LayoutIndex &a_rhs) const
bool	eq (const LayoutIndex &a_rhs) const
bool	operator!= (const LayoutIndex &a_rhs) const
bool	isNull () const
	returns 'true' if this DataIndex has been null constructed.
int	intCode () const
Private Member Functions
	LayoutIndex (int a_index, const int *a_layoutID)
Private Attributes
int	m_index
const int *	m_layoutIntPtr
Friends
class	DataIterator
class	LayoutIterator
class	TimedDataIterator
class	NeighborIterator
class	BoxLayout
class	DataIndex

---

Constructor & Destructor Documentation

LayoutIndex::LayoutIndex

(

)

[inline]

LayoutIndex::~LayoutIndex

(

)

[inline]

LayoutIndex::LayoutIndex	(	int	a_index,
		const int *	a_layoutID
	)			[inline, private]

---

Member Function Documentation

bool LayoutIndex::operator==

(

const LayoutIndex &

a_rhs

)

const [inline]

References m_index.

bool LayoutIndex::eq

(

const LayoutIndex &

a_rhs

)

const [inline]

bool LayoutIndex::operator!=

(

const LayoutIndex &

a_rhs

)

const [inline]

bool LayoutIndex::isNull

(

)

const [inline]

returns 'true' if this DataIndex has been null constructed.

References m_layoutIntPtr.

int LayoutIndex::intCode

(

)

const [inline]

References m_index.

---

Friends And Related Function Documentation

friend class DataIterator [friend]

Reimplemented in DataIndex.

friend class LayoutIterator [friend]

Reimplemented in DataIndex.

friend class TimedDataIterator [friend]

Reimplemented in DataIndex.

friend class NeighborIterator [friend]

Reimplemented in DataIndex.

friend class BoxLayout [friend]

Reimplemented in DataIndex.

friend class DataIndex [friend]

---

Member Data Documentation

int LayoutIndex::m_index [private]

Referenced by LayoutIterator::begin(), BoxLayout::get(), BoxLayout::index(), BoxLayout::indexI(), intCode(), NeighborIterator::operator++(), LayoutIterator::operator++(), operator==(), BoxLayout::operator[](), BoxLayout::procID(), BoxLayout::ref(), and BoxLayout::setProcID().

const int* LayoutIndex::m_layoutIntPtr [private]

Referenced by BoxLayout::check(), and isNull().

---

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

• DataIndex.H