CompuCell3D::BoundaryData Class Reference

#include <BoundaryTracker.h>

List of all members.

Public Member Functions
	BoundaryData (long _pixelIndex=0, short _numberOfForeignNeighbors=0)
bool	operator< (const BoundaryData &_rhs) const
	have to define < operator if using a class in the set and no < operator is defined for this class
bool	operator== (const BoundaryData &_rhs) const
void	incrementNumberOfForeignNeighbors (const BoundaryData &_boundaryData) const
void	decrementNumberOfForeignNeighbors (const BoundaryData &_boundaryData) const
	Note : You should NEVER change this way class members that are used in <operator this will corrupt set container.
bool	OKToRemove () const
	BoundaryData (long _pixelIndex=0, short _numberOfForeignNeighbors=0)
bool	operator< (const BoundaryData &_rhs) const
	have to define < operator if using a class in the set and no < operator is defined for this class
bool	operator== (const BoundaryData &_rhs) const
void	incrementNumberOfForeignNeighbors (const BoundaryData &_boundaryData) const
void	decrementNumberOfForeignNeighbors (const BoundaryData &_boundaryData) const
	Note : You should NEVER change this way class members that are used in <operator this will corrupt set container.
bool	OKToRemove () const
Public Attributes
long	pixelIndex
	members
short	numberOfForeignNeighbors

---

Detailed Description

Definition at line 14 of file BoundaryTracker.h.

---

Constructor & Destructor Documentation

CompuCell3D::BoundaryData::BoundaryData	(	long	_pixelIndex = 0,
		short	_numberOfForeignNeighbors = 0
	)			[inline]

Definition at line 21 of file BoundaryTracker.h.

CompuCell3D::BoundaryData::BoundaryData	(	long	_pixelIndex = 0,
		short	_numberOfForeignNeighbors = 0
	)			[inline]

Definition at line 21 of file CellBoundaryTracker.h.

---

Member Function Documentation

bool CompuCell3D::BoundaryData::operator<

(

const BoundaryData &

_rhs

)

const [inline]

have to define < operator if using a class in the set and no < operator is defined for this class

Definition at line 27 of file BoundaryTracker.h.

References pixelIndex.

bool CompuCell3D::BoundaryData::operator==

(

const BoundaryData &

_rhs

)

const [inline]

Definition at line 31 of file BoundaryTracker.h.

References pixelIndex.

void CompuCell3D::BoundaryData::incrementNumberOfForeignNeighbors

(

const BoundaryData &

_boundaryData

)

const [inline]

had to do this dirty trick to work around a problem that iterators of a set give access in read-only mode Note : You should NEVER change this way class members that are used in <operator this will corrupt set container CAUTION: DO NOT TRY TO MODIFY pixelIndex - you will corrupt set container

Definition at line 39 of file BoundaryTracker.h.

void CompuCell3D::BoundaryData::decrementNumberOfForeignNeighbors

(

const BoundaryData &

_boundaryData

)

const [inline]

Note : You should NEVER change this way class members that are used in <operator this will corrupt set container.

Definition at line 45 of file BoundaryTracker.h.

bool CompuCell3D::BoundaryData::OKToRemove

(

)

const [inline]

Definition at line 50 of file BoundaryTracker.h.

References numberOfForeignNeighbors.

bool CompuCell3D::BoundaryData::operator<

(

const BoundaryData &

_rhs

)

const [inline]

have to define < operator if using a class in the set and no < operator is defined for this class

Definition at line 27 of file CellBoundaryTracker.h.

References pixelIndex.

bool CompuCell3D::BoundaryData::operator==

(

const BoundaryData &

_rhs

)

const [inline]

Definition at line 31 of file CellBoundaryTracker.h.

References pixelIndex.

void CompuCell3D::BoundaryData::incrementNumberOfForeignNeighbors

(

const BoundaryData &

_boundaryData

)

const [inline]

had to do this dirty trick to work around a problem that iterators of a set give access in read-only mode Note : You should NEVER change this way class members that are used in <operator this will corrupt set container CAUTION: DO NOT TRY TO MODIFY pixelIndex - you will corrupt set container

Definition at line 39 of file CellBoundaryTracker.h.

void CompuCell3D::BoundaryData::decrementNumberOfForeignNeighbors

(

const BoundaryData &

_boundaryData

)

const [inline]

Note : You should NEVER change this way class members that are used in <operator this will corrupt set container.

Definition at line 45 of file CellBoundaryTracker.h.

bool CompuCell3D::BoundaryData::OKToRemove

(

)

const [inline]

Definition at line 50 of file CellBoundaryTracker.h.

References numberOfForeignNeighbors.

---

Member Data Documentation

long CompuCell3D::BoundaryData::pixelIndex

members

Definition at line 53 of file BoundaryTracker.h.

Referenced by operator<(), and operator==().

short CompuCell3D::BoundaryData::numberOfForeignNeighbors

Definition at line 54 of file BoundaryTracker.h.

Referenced by OKToRemove().

---

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

• CompuCell/DOXYGEN/core/CompuCell3D/plugins/BoundaryTracker/BoundaryTracker.h
• CompuCell/DOXYGEN/core/CompuCell3D/plugins/CellBoundaryTracker/CellBoundaryTracker.h