LayoutIndex Class Reference

#include <DataIndex.H>

Inheritance diagram for LayoutIndex:

Inheritance graph
[legend]

List of all members.


Detailed Description

An index for LayoutIterator.

Public Member Functions

 LayoutIndex ()
virtual ~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
int datInd () const
 LayoutIndex (const LayoutIndex &a_input)
virtual void output () const

Private Member Functions

 LayoutIndex (int a_indexIntoBoxes, int a_indexIntoData, const int *a_layoutID)

Private Attributes

int m_index
int m_datInd
const int * m_layoutIntPtr

Friends

class DataIterator
class LayoutIterator
class TimedDataIterator
class NeighborIterator
class BoxLayout
class DataIndex
class DisjointBoxLayout

Constructor & Destructor Documentation

LayoutIndex::LayoutIndex (  )  [inline]

virtual LayoutIndex::~LayoutIndex (  )  [inline, virtual]

LayoutIndex::LayoutIndex ( const LayoutIndex a_input  )  [inline]

References m_datInd, m_index, and m_layoutIntPtr.

LayoutIndex::LayoutIndex ( int  a_indexIntoBoxes,
int  a_indexIntoData,
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.

int LayoutIndex::datInd (  )  const [inline]

References m_datInd, and m_index.

Referenced by LayoutData< T >::operator[]().

virtual void LayoutIndex::output (  )  const [inline, virtual]

Print to the given output stream in ASCII.

References m_datInd, m_index, and pout().


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]

friend class DisjointBoxLayout [friend]


Member Data Documentation

int LayoutIndex::m_index [private]

int LayoutIndex::m_datInd [private]

Referenced by datInd(), LayoutIndex(), and output().

const int* LayoutIndex::m_layoutIntPtr [private]


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

Generated on Fri Jul 21 03:43:08 2017 for Chombo + EB by  doxygen 1.5.5