CompuCell3D::BoxWatcher Class Reference

#include <BoxWatcher.h>

Inheritance diagram for CompuCell3D::BoxWatcher:

[legend]

Collaboration diagram for CompuCell3D::BoxWatcher:

[legend]

List of all members.

Public Member Functions
	BoxWatcher ()
virtual	~BoxWatcher ()
virtual void	init (Simulator *simulator, CC3DXMLElement *_xmlData=0)
virtual void	extraInit (Simulator *simulator)
virtual void	start ()
virtual void	step (const unsigned int currentStep)
virtual void	finish ()
Point3D	getMinCoordinates ()
Point3D	getMaxCoordinates ()
Point3D *	getMinCoordinatesPtr ()
Point3D *	getMaxCoordinatesPtr ()
Point3D	getMargins ()
virtual void	update (CC3DXMLElement *_xmlData, bool _fullInitFlag=false)
virtual std::string	steerableName ()
virtual std::string	toString ()
Private Member Functions
void	adjustBox ()
void	adjustCoordinates (Point3D pt)
bool	checkIfFrozen (unsigned char _type)
Private Attributes
WatchableField3D< CellG * > *	cellFieldG
Simulator *	sim
Potts3D *	potts
Dim3D	fieldDim
Point3D	minCoordinates
Point3D	maxCoordinates
std::vector< unsigned char >	frozenTypeVector
unsigned int	xMargin
unsigned int	yMargin
unsigned int	zMargin

---

Detailed Description

Definition at line 44 of file BoxWatcher.h.

---

Constructor & Destructor Documentation

BoxWatcher::BoxWatcher

(

)

Definition at line 38 of file BoxWatcher.cpp.

BoxWatcher::~BoxWatcher

(

)

[virtual]

Definition at line 40 of file BoxWatcher.cpp.

---

Member Function Documentation

void BoxWatcher::adjustBox

(

)

[private]

Definition at line 114 of file BoxWatcher.cpp.

References xml_python_expat_1::a, adjustCoordinates(), cellFieldG, checkIfFrozen(), fieldDim, maxCoordinates, minCoordinates, potts, CompuCell3D::Potts3D::setMaxCoordinates(), CompuCell3D::Potts3D::setMinCoordinates(), CompuCell3D::CellG::type, CompuCell3D::Point3D::x, xMargin, CompuCell3D::Point3D::y, yMargin, CompuCell3D::Point3D::z, and zMargin.

Referenced by start(), and step().

void BoxWatcher::adjustCoordinates

(

Point3D

pt

)

[private]

Definition at line 165 of file BoxWatcher.cpp.

References maxCoordinates, minCoordinates, CompuCell3D::Point3D::x, CompuCell3D::Point3D::y, and CompuCell3D::Point3D::z.

Referenced by adjustBox().

bool BoxWatcher::checkIfFrozen

(

unsigned char

_type

)

[private]

Definition at line 185 of file BoxWatcher.cpp.

References frozenTypeVector.

Referenced by adjustBox().

void BoxWatcher::init	(	Simulator *	simulator,
		CC3DXMLElement *	_xmlData = 0
	)			[virtual]

Reimplemented from CompuCell3D::SimObject.

Definition at line 48 of file BoxWatcher.cpp.

References cellFieldG, fieldDim, CompuCell3D::Potts3D::getCellFieldG(), CompuCell3D::Simulator::getPotts(), maxCoordinates, minCoordinates, potts, CompuCell3D::Simulator::registerSteerableObject(), sim, update(), CompuCell3D::Point3D::x, CompuCell3D::Point3D::y, and CompuCell3D::Point3D::z.

Referenced by CompuCell3D::FlexibleDiffusionSolverFE::extraInit(), and CompuCell3D::FastDiffusionSolver2DFE::extraInit().

void BoxWatcher::extraInit

(

Simulator *

simulator

)

[virtual]

Reimplemented from CompuCell3D::SimObject.

Definition at line 67 of file BoxWatcher.cpp.

References frozenTypeVector, CompuCell3D::Potts3D::getFrozenTypeVector(), and potts.

void BoxWatcher::start

(

)

[virtual]

Implements CompuCell3D::Steppable.

Definition at line 88 of file BoxWatcher.cpp.

References adjustBox(), fieldDim, maxCoordinates, minCoordinates, CompuCell3D::Point3D::x, CompuCell3D::Point3D::y, and CompuCell3D::Point3D::z.

void BoxWatcher::step

(

const unsigned int

currentStep

)

[virtual]

Implements CompuCell3D::Steppable.

Definition at line 101 of file BoxWatcher.cpp.

References adjustBox(), fieldDim, maxCoordinates, minCoordinates, CompuCell3D::Point3D::x, CompuCell3D::Point3D::y, and CompuCell3D::Point3D::z.

virtual void CompuCell3D::BoxWatcher::finish

(

)

[inline, virtual]

Implements CompuCell3D::Steppable.

Definition at line 72 of file BoxWatcher.h.

Point3D BoxWatcher::getMinCoordinates

(

)

Definition at line 43 of file BoxWatcher.cpp.

References minCoordinates.

Point3D BoxWatcher::getMaxCoordinates

(

)

Definition at line 44 of file BoxWatcher.cpp.

References minCoordinates.

Point3D* CompuCell3D::BoxWatcher::getMinCoordinatesPtr

(

)

[inline]

Definition at line 76 of file BoxWatcher.h.

Referenced by CompuCell3D::FastDiffusionSolver2DFE::diffuseSingleField().

Point3D* CompuCell3D::BoxWatcher::getMaxCoordinatesPtr

(

)

[inline]

Definition at line 77 of file BoxWatcher.h.

Referenced by CompuCell3D::FastDiffusionSolver2DFE::diffuseSingleField().

Point3D BoxWatcher::getMargins

(

)

Definition at line 46 of file BoxWatcher.cpp.

References xMargin, yMargin, and zMargin.

void BoxWatcher::update	(	CC3DXMLElement *	_xmlData,
		bool	_fullInitFlag = false
	)			[virtual]

Reimplemented from CompuCell3D::SteerableObject.

Definition at line 195 of file BoxWatcher.cpp.

References CC3DXMLElement::findElement(), CC3DXMLElement::getFirstElement(), CC3DXMLElement::getUInt(), xMargin, yMargin, and zMargin.

Referenced by init().

std::string BoxWatcher::steerableName

(

)

[virtual]

Reimplemented from CompuCell3D::SteerableObject.

Definition at line 211 of file BoxWatcher.cpp.

References toString().

std::string BoxWatcher::toString

(

)

[virtual]

Reimplemented from CompuCell3D::Steppable.

Definition at line 206 of file BoxWatcher.cpp.

Referenced by steerableName().

---

Member Data Documentation

WatchableField3D<CellG *>* CompuCell3D::BoxWatcher::cellFieldG [private]

Definition at line 46 of file BoxWatcher.h.

Referenced by adjustBox(), and init().

Simulator* CompuCell3D::BoxWatcher::sim [private]

Definition at line 47 of file BoxWatcher.h.

Referenced by init().

Potts3D* CompuCell3D::BoxWatcher::potts [private]

Definition at line 48 of file BoxWatcher.h.

Referenced by adjustBox(), extraInit(), and init().

Dim3D CompuCell3D::BoxWatcher::fieldDim [private]

Definition at line 49 of file BoxWatcher.h.

Referenced by adjustBox(), init(), start(), and step().

Point3D CompuCell3D::BoxWatcher::minCoordinates [private]

Definition at line 51 of file BoxWatcher.h.

Referenced by adjustBox(), adjustCoordinates(), getMaxCoordinates(), getMinCoordinates(), init(), start(), and step().

Point3D CompuCell3D::BoxWatcher::maxCoordinates [private]

Definition at line 52 of file BoxWatcher.h.

Referenced by adjustBox(), adjustCoordinates(), init(), start(), and step().

std::vector<unsigned char> CompuCell3D::BoxWatcher::frozenTypeVector [private]

Definition at line 53 of file BoxWatcher.h.

Referenced by checkIfFrozen(), and extraInit().

unsigned int CompuCell3D::BoxWatcher::xMargin [private]

Definition at line 58 of file BoxWatcher.h.

Referenced by adjustBox(), getMargins(), and update().

unsigned int CompuCell3D::BoxWatcher::yMargin [private]

Definition at line 59 of file BoxWatcher.h.

Referenced by adjustBox(), getMargins(), and update().

unsigned int CompuCell3D::BoxWatcher::zMargin [private]

Definition at line 60 of file BoxWatcher.h.

Referenced by adjustBox(), getMargins(), and update().

---

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

• CompuCell/DOXYGEN/core/CompuCell3D/steppables/BoxWatcher/BoxWatcher.h
• CompuCell/DOXYGEN/core/CompuCell3D/steppables/BoxWatcher/BoxWatcher.cpp