CompuCell3D::Field3DIndex Class Reference

#include <Field3DIndex.h>

List of all members.

Public Member Functions
	Field3DIndex ()
	Field3DIndex (const Dim3D &_dim)
long	index (const Point3D &pt) const
Point3D	index2Point (long _index) const
long	getMaxIndex () const
Private Attributes
int	x_size
int	y_size
int	z_size
int	xy_size
int	maxIndex

---

Detailed Description

Definition at line 14 of file Field3DIndex.h.

---

Constructor & Destructor Documentation

CompuCell3D::Field3DIndex::Field3DIndex

(

)

[inline]

Definition at line 16 of file Field3DIndex.h.

Field3DIndex::Field3DIndex

(

const Dim3D &

_dim

)

Definition at line 5 of file Field3DIndex.cpp.

References index(), maxIndex, x_size, y_size, and z_size.

---

Member Function Documentation

long CompuCell3D::Field3DIndex::index

(

const Point3D &

pt

)

const [inline]

Definition at line 23 of file Field3DIndex.h.

References CompuCell3D::Point3D::x, x_size, CompuCell3D::Point3D::y, y_size, and CompuCell3D::Point3D::z.

Referenced by CompuCell3D::NeighborTrackerPlugin::field3DChange(), CompuCell3D::CellBoundaryTrackerPlugin::field3DChange(), Field3DIndex(), CompuCell3D::AdjacentNeighbor::initialize(), CompuCell3D::CellBoundaryTrackerPlugin::testLatticeSanity(), and CompuCell3D::CellBoundaryTrackerPlugin::testLatticeSanityFull().

Point3D CompuCell3D::Field3DIndex::index2Point

(

long

_index

)

const [inline]

Definition at line 28 of file Field3DIndex.h.

References x_size, and xy_size.

Referenced by CompuCell3D::CellBoundaryTrackerPlugin::testLatticeSanity(), and CompuCell3D::CellBoundaryTrackerPlugin::testLatticeSanityFull().

long CompuCell3D::Field3DIndex::getMaxIndex

(

)

const [inline]

Definition at line 36 of file Field3DIndex.h.

References maxIndex.

Referenced by CompuCell3D::CellBoundaryTrackerPlugin::init().

---

Member Data Documentation

int CompuCell3D::Field3DIndex::x_size [private]

Definition at line 39 of file Field3DIndex.h.

Referenced by Field3DIndex(), index(), and index2Point().

int CompuCell3D::Field3DIndex::y_size [private]

Definition at line 40 of file Field3DIndex.h.

Referenced by Field3DIndex(), and index().

int CompuCell3D::Field3DIndex::z_size [private]

Definition at line 41 of file Field3DIndex.h.

Referenced by Field3DIndex().

int CompuCell3D::Field3DIndex::xy_size [private]

Definition at line 42 of file Field3DIndex.h.

Referenced by index2Point().

int CompuCell3D::Field3DIndex::maxIndex [private]

Definition at line 43 of file Field3DIndex.h.

Referenced by Field3DIndex(), and getMaxIndex().

---

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

• CompuCell/DOXYGEN/core/CompuCell3D/Field3D/Field3DIndex.h
• CompuCell/DOXYGEN/core/CompuCell3D/Field3D/Field3DIndex.cpp