CompuCell3D::Array3DField3DAdapter< T > Class Template Reference

#include <Array3D.h>

Inheritance diagram for CompuCell3D::Array3DField3DAdapter< T >:

[legend]

Collaboration diagram for CompuCell3D::Array3DField3DAdapter< T >:

[legend]

List of all members.

Public Member Functions
	Array3DField3DAdapter ()
virtual	~Array3DField3DAdapter ()
Array3D< T > *	getArray3DPtr ()
Array3D< T >::ContainerType &	getContainer ()
virtual void	setDim (const Dim3D theDim)
virtual Dim3D	getDim () const
virtual bool	isValid (const Point3D &pt) const
virtual void	set (const Point3D &pt, const T value)
virtual T	get (const Point3D &pt) const
virtual T	getByIndex (long _offset) const
virtual void	setByIndex (long _offset, const T _value)
Protected Attributes
Array3D< T > *	array3DPtr
Dim3D	dim
Array3D< T >::ContainerType *	containerPtr

---

Detailed Description

template<typename T>
class CompuCell3D::Array3DField3DAdapter< T >

Definition at line 47 of file Array3D.h.

---

Constructor & Destructor Documentation

template<typename T>

CompuCell3D::Array3DField3DAdapter< T >::Array3DField3DAdapter

(

)

[inline]

Definition at line 49 of file Array3D.h.

template<typename T>

virtual CompuCell3D::Array3DField3DAdapter< T >::~Array3DField3DAdapter

(

)

[inline, virtual]

Definition at line 50 of file Array3D.h.

---

Member Function Documentation

template<typename T>

Array3D<T>* CompuCell3D::Array3DField3DAdapter< T >::getArray3DPtr

(

)

[inline]

Definition at line 56 of file Array3D.h.

template<typename T>

Array3D<T>::ContainerType& CompuCell3D::Array3DField3DAdapter< T >::getContainer

(

)

[inline]

Definition at line 57 of file Array3D.h.

template<typename T>

virtual void CompuCell3D::Array3DField3DAdapter< T >::setDim

(

const Dim3D

theDim

)

[inline, virtual]

Change the dimensions of the field dynamically

Parameters:

theDim

New dimensions.

Reimplemented from CompuCell3D::Field3DImpl< T >.

Definition at line 58 of file Array3D.h.

References TypeChangeWatcherExample::dim, and xml_python_expat_1::t.

template<typename T>

virtual Dim3D CompuCell3D::Array3DField3DAdapter< T >::getDim

(

)

const [inline, virtual]

Returns:

The dimensions of this field.

Reimplemented from CompuCell3D::Field3DImpl< T >.

Definition at line 77 of file Array3D.h.

References TypeChangeWatcherExample::dim.

template<typename T>

virtual bool CompuCell3D::Array3DField3DAdapter< T >::isValid

(

const Point3D &

pt

)

const [inline, virtual]

Parameters:

pt

A coordinate in 3D space.

Returns:

True if the coordinate is in this field false otherwise.

Reimplemented from CompuCell3D::Field3DImpl< T >.

Definition at line 78 of file Array3D.h.

References TypeChangeWatcherExample::dim, CompuCell3D::Point3D::x, CompuCell3D::Point3D::y, and CompuCell3D::Point3D::z.

template<typename T>

virtual void CompuCell3D::Array3DField3DAdapter< T >::set	(	const Point3D &	pt,
		const T	value
	)			[inline, virtual]

Set a field element. If the value was already set it will be overwritten. If pt is out of range then a BasicException will be thrown.

Parameters:

	pt	The coordinate of the element.
	value	The new value.

Reimplemented from CompuCell3D::Field3DImpl< T >.

Definition at line 83 of file Array3D.h.

template<typename T>

virtual T CompuCell3D::Array3DField3DAdapter< T >::get

(

const Point3D &

pt

)

const [inline, virtual]

If pt is out of range a BasicException will be thrown.

Parameters:

pt

The coordinates of the field element.

Returns:

The value of the element at pt.

Reimplemented from CompuCell3D::Field3DImpl< T >.

Definition at line 88 of file Array3D.h.

template<typename T>

virtual T CompuCell3D::Array3DField3DAdapter< T >::getByIndex

(

long

_offset

)

const [inline, virtual]

If _offset is out of range either a BasicException will be thrown or a function will return default value for the field element

Parameters:

_offset

offset of the field element in the internal field array.

Returns:

The value of the element at _offset.

Reimplemented from CompuCell3D::Field3DImpl< T >.

Definition at line 92 of file Array3D.h.

template<typename T>

virtual void CompuCell3D::Array3DField3DAdapter< T >::setByIndex	(	long	_offset,
		const T	value
	)			[inline, virtual]

If _offset is out of range either nothing is done

Parameters:

_offset

offset of the field element in the internal field array.

Returns:

The value of the element at _offset.

Reimplemented from CompuCell3D::Field3DImpl< T >.

Definition at line 95 of file Array3D.h.

---

Member Data Documentation

template<typename T>

Array3D<T>* CompuCell3D::Array3DField3DAdapter< T >::array3DPtr [protected]

Definition at line 99 of file Array3D.h.

template<typename T>

Dim3D CompuCell3D::Array3DField3DAdapter< T >::dim [protected]

Reimplemented from CompuCell3D::Field3DImpl< T >.

Definition at line 100 of file Array3D.h.

template<typename T>

Array3D<T>::ContainerType* CompuCell3D::Array3DField3DAdapter< T >::containerPtr [protected]

Definition at line 101 of file Array3D.h.

---

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

• CompuCell/DOXYGEN/core/CompuCell3D/Field3D/Array3D.h