CompuCell3D::CellVelocityData Class Reference

#include <CellVelocityData.h>

Collaboration diagram for CompuCell3D::CellVelocityData:

List of all members.

Public Member Functions

CellVelocityData (cldeque< Coordinates3D< float > >::size_type _cldequeCapacity, cldeque< Coordinates3D< float > >::size_type _enoughDataThreshold)

void setCldequeCapacity (cldeque< Coordinates3D< float > >::size_type _capacity)

void setEnoughDataThreshold (cldeque< Coordinates3D< float > >::size_type _threshold)

CellVelocityData ()

~CellVelocityData ()

Coordinates3D< float > operator[] (cldeque< Coordinates3D< float > >::size_type idx)

Coordinates3D< float > getVelocityData (cldeque< Coordinates3D< float > >::size_type idx)

void setInstantenousVelocity (Coordinates3D< float > &_vel)

void setInstantenousVelocity (float x, float y, float z)

Coordinates3D< float > getInstantenousVelocity ()

void setAverageVelocity (Coordinates3D< float > &_vel)

void setAverageVelocity (float x, float y, float z)

Coordinates3D< float > getAverageVelocity ()

Coordinates3D< float > getLastCM ()

Coordinates3D< float > getLatestAverageVelocity ()

void push_front (Coordinates3D< float > &_com)

void push_front (float _x, float _y, float _z)

void resize (cldeque< Coordinates3D< float > >::size_type _new_size)

void produceVelocityHistoryFromSource (const CellVelocityData *source)

cldeque< Coordinates3D< float >
>::size_type size ()

Public Attributes

cldeque< Coordinates3D< float > > * cellCOMPtr

main member

cldeque< float > * timePtr

Coordinates3D< float > velocity

bool enoughData

unsigned short numberOfSamples

Private Attributes

cldeque< Coordinates3D< float >
>::size_type cldequeCapacity

cldeque< Coordinates3D< float >
>::size_type enoughDataThreshold

Detailed Description

Author:: m

Definition at line 16 of file CellVelocityData.h.

Constructor & Destructor Documentation

CompuCell3D::CellVelocityData::CellVelocityData	(	cldeque< Coordinates3D< float > >::size_type	_cldequeCapacity,
		cldeque< Coordinates3D< float > >::size_type	_enoughDataThreshold
	)			`[inline]`

Definition at line 24 of file CellVelocityData.h.

References cldeque< T >::assign(), cellCOMPtr, cldequeCapacity, timePtr, and velocity.

CompuCell3D::CellVelocityData::CellVelocityData ( )

Definition at line 9 of file CellVelocityData.cpp.

References cldeque< T >::assign(), cellCOMPtr, cldequeCapacity, and velocity.

CompuCell3D::CellVelocityData::~CellVelocityData ( )

Definition at line 20 of file CellVelocityData.cpp.

References cellCOMPtr.

Member Function Documentation

void CompuCell3D::CellVelocityData::setCldequeCapacity ( cldeque< Coordinates3D< float > >::size_type _capacity ) [inline]

Definition at line 43 of file CellVelocityData.h.

References ASSERT_OR_THROW, cldequeCapacity, and enoughDataThreshold.

void CompuCell3D::CellVelocityData::setEnoughDataThreshold ( cldeque< Coordinates3D< float > >::size_type _threshold ) [inline]

Definition at line 51 of file CellVelocityData.h.

References ASSERT_OR_THROW, cldequeCapacity, and enoughDataThreshold.

Coordinates3D<float> CompuCell3D::CellVelocityData::operator[] ( cldeque< Coordinates3D< float > >::size_type idx ) [inline]

Definition at line 65 of file CellVelocityData.h.

References cellCOMPtr.

Coordinates3D<float> CompuCell3D::CellVelocityData::getVelocityData ( cldeque< Coordinates3D< float > >::size_type idx ) [inline]

Definition at line 70 of file CellVelocityData.h.

References cellCOMPtr.

void CompuCell3D::CellVelocityData::setInstantenousVelocity ( Coordinates3D< float > & _vel ) [inline]

Definition at line 74 of file CellVelocityData.h.

References velocity.

void CompuCell3D::CellVelocityData::setInstantenousVelocity	(	float	x,
		float	y,
		float	z
	)			`[inline]`

Definition at line 78 of file CellVelocityData.h.

References velocity, Coordinates3D< T >::XRef(), Coordinates3D< T >::YRef(), and Coordinates3D< T >::ZRef().

Coordinates3D<float> CompuCell3D::CellVelocityData::getInstantenousVelocity ( ) [inline]

Definition at line 84 of file CellVelocityData.h.

References velocity.

void CompuCell3D::CellVelocityData::setAverageVelocity ( Coordinates3D< float > & _vel ) [inline]

Definition at line 88 of file CellVelocityData.h.

References velocity.

void CompuCell3D::CellVelocityData::setAverageVelocity	(	float	x,
		float	y,
		float	z
	)			`[inline]`

Definition at line 92 of file CellVelocityData.h.

References velocity, Coordinates3D< T >::XRef(), Coordinates3D< T >::YRef(), and Coordinates3D< T >::ZRef().

Coordinates3D<float> CompuCell3D::CellVelocityData::getAverageVelocity ( ) [inline]

Definition at line 98 of file CellVelocityData.h.

References velocity.

Referenced by CC3DTransaction::fillVelocity().

Coordinates3D<float> CompuCell3D::CellVelocityData::getLastCM ( ) [inline]

Definition at line 103 of file CellVelocityData.h.

References cellCOMPtr.

Coordinates3D<float> CompuCell3D::CellVelocityData::getLatestAverageVelocity ( ) [inline]

Definition at line 108 of file CellVelocityData.h.

References cellCOMPtr, and enoughData.

void CompuCell3D::CellVelocityData::push_front ( Coordinates3D< float > & _com ) [inline]

Definition at line 116 of file CellVelocityData.h.

References cellCOMPtr, enoughData, enoughDataThreshold, numberOfSamples, and cldeque< T >::push_front().

void CompuCell3D::CellVelocityData::push_front	(	float	_x,
		float	_y,
		float	_z
	)			`[inline]`

Definition at line 130 of file CellVelocityData.h.

References cellCOMPtr, enoughData, enoughDataThreshold, numberOfSamples, and cldeque< T >::push_front().

void CompuCell3D::CellVelocityData::resize ( cldeque< Coordinates3D< float > >::size_type _new_size ) [inline]

Definition at line 145 of file CellVelocityData.h.

References cellCOMPtr, and cldeque< T >::setSize().

void CompuCell3D::CellVelocityData::produceVelocityHistoryFromSource ( const CellVelocityData * source )

assume that first place in deque is initialized to the correct COM

Definition at line 27 of file CellVelocityData.cpp.

References cellCOMPtr, enoughData, numberOfSamples, cldeque< T >::size(), and size().

cldeque<Coordinates3D<float> >::size_type CompuCell3D::CellVelocityData::size ( ) [inline]

Definition at line 151 of file CellVelocityData.h.

References cellCOMPtr, and cldeque< T >::size().

Referenced by produceVelocityHistoryFromSource().

Member Data Documentation

cldeque<Coordinates3D<float> >::size_type CompuCell3D::CellVelocityData::cldequeCapacity [private]

Definition at line 19 of file CellVelocityData.h.

Referenced by CellVelocityData(), setCldequeCapacity(), and setEnoughDataThreshold().

cldeque<Coordinates3D<float> >::size_type CompuCell3D::CellVelocityData::enoughDataThreshold [private]

Definition at line 20 of file CellVelocityData.h.

Referenced by push_front(), setCldequeCapacity(), and setEnoughDataThreshold().

cldeque<Coordinates3D<float> >* CompuCell3D::CellVelocityData::cellCOMPtr

main member

Definition at line 158 of file CellVelocityData.h.

Referenced by CellVelocityData(), getLastCM(), getLatestAverageVelocity(), getVelocityData(), operator[](), produceVelocityHistoryFromSource(), push_front(), resize(), size(), and ~CellVelocityData().

cldeque<float>* CompuCell3D::CellVelocityData::timePtr

Definition at line 160 of file CellVelocityData.h.

Referenced by CellVelocityData().

Coordinates3D<float> CompuCell3D::CellVelocityData::velocity

Definition at line 162 of file CellVelocityData.h.

Referenced by CellVelocityData(), getAverageVelocity(), getInstantenousVelocity(), setAverageVelocity(), and setInstantenousVelocity().

bool CompuCell3D::CellVelocityData::enoughData

Definition at line 164 of file CellVelocityData.h.

Referenced by getLatestAverageVelocity(), produceVelocityHistoryFromSource(), and push_front().

unsigned short CompuCell3D::CellVelocityData::numberOfSamples

Definition at line 165 of file CellVelocityData.h.

Referenced by produceVelocityHistoryFromSource(), and push_front().

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

CompuCell/DOXYGEN/core/CompuCell3D/plugins/CellVelocity/CellVelocityData.h
CompuCell/DOXYGEN/core/CompuCell3D/plugins/CellVelocity/CellVelocityData.cpp


Public Member Functions
	CellVelocityData (cldeque< Coordinates3D< float > >::size_type _cldequeCapacity, cldeque< Coordinates3D< float > >::size_type _enoughDataThreshold)
void	setCldequeCapacity (cldeque< Coordinates3D< float > >::size_type _capacity)
void	setEnoughDataThreshold (cldeque< Coordinates3D< float > >::size_type _threshold)
	CellVelocityData ()
	~CellVelocityData ()
Coordinates3D< float >	operator[] (cldeque< Coordinates3D< float > >::size_type idx)
Coordinates3D< float >	getVelocityData (cldeque< Coordinates3D< float > >::size_type idx)
void	setInstantenousVelocity (Coordinates3D< float > &_vel)
void	setInstantenousVelocity (float x, float y, float z)
Coordinates3D< float >	getInstantenousVelocity ()
void	setAverageVelocity (Coordinates3D< float > &_vel)
void	setAverageVelocity (float x, float y, float z)
Coordinates3D< float >	getAverageVelocity ()
Coordinates3D< float >	getLastCM ()
Coordinates3D< float >	getLatestAverageVelocity ()
void	push_front (Coordinates3D< float > &_com)
void	push_front (float _x, float _y, float _z)
void	resize (cldeque< Coordinates3D< float > >::size_type _new_size)
void	produceVelocityHistoryFromSource (const CellVelocityData *source)
cldeque< Coordinates3D< float > >::size_type	size ()
Public Attributes
cldeque< Coordinates3D< float > > *	cellCOMPtr
	main member
cldeque< float > *	timePtr
Coordinates3D< float >	velocity
bool	enoughData
unsigned short	numberOfSamples
Private Attributes
cldeque< Coordinates3D< float > >::size_type	cldequeCapacity
cldeque< Coordinates3D< float > >::size_type	enoughDataThreshold