Field3D
|
This subclass of Field does not store any data. More...
#include <EmptyField.h>
Public Types | |
typedef EmptyField< Data_T > | class_type |
typedef boost::intrusive_ptr < EmptyField > | Ptr |
typedef std::vector< Ptr > | Vec |
This is a convenience typedef for the list that Field3DInputFile::readScalarLayers() and Field3DInputFile::readVectorLayers() will return its data in. | |
Public Member Functions | |
virtual void | clear (const Data_T &value) |
Clears all the voxels in the storage. | |
const Data_T & | constantvalue () const |
Returns the constant value. | |
void | setConstantvalue (const Data_T &val) |
Sets the constant value. | |
Constructors & destructor | |
EmptyField () | |
Constructs an empty buffer. | |
From Field | |
virtual Data_T | value (int i, int j, int k) const |
Read access to a voxel. The coordinates are in integer voxel space . | |
virtual long long int | memSize () const |
Returns the memory usage (in bytes) | |
From WritableField | |
virtual Data_T & | lvalue (int i, int j, int k) |
Write access to a voxel. The coordinates are global coordinates. | |
From FieldBase | |
virtual std::string | className () const |
Returns the class name of the object. Used by the class pool and when writing the data to disk. | |
virtual FieldBase::Ptr | clone () const |
Returns a pointer to a copy of the field, pure virtual so ensure derived classes properly implement it. | |
Static Public Member Functions | |
static DEFINE_FIELD_RTTI_CONCRETE_CLASS const char * | classType () |
RTTI replacement. | |
Protected Attributes | |
Data_T | m_constantData |
Field constant value. | |
Data_T | m_default |
Field default value. | |
Data_T | m_ignoredData |
Dummy variable for assignment. | |
Private Types | |
typedef ResizableField< Data_T > | base |
Convenience typedef for referring to base class. |
This subclass of Field does not store any data.
Its primary purpose is to be used as a proxy field. It can carry the same resolution, metadata and mapping as a regular field.
Usage is similar to a DenseField, except that it does not contain any data. It stores a default value that may be set and queried, so it can be treated as a constant field.
Definition at line 81 of file EmptyField.h.
typedef boost::intrusive_ptr<EmptyField> EmptyField< Data_T >::Ptr |
Reimplemented from ResizableField< Data_T >.
Definition at line 88 of file EmptyField.h.
typedef std::vector<Ptr> EmptyField< Data_T >::Vec |
This is a convenience typedef for the list that Field3DInputFile::readScalarLayers() and Field3DInputFile::readVectorLayers() will return its data in.
Reimplemented from Field< Data_T >.
Definition at line 89 of file EmptyField.h.
typedef EmptyField<Data_T> EmptyField< Data_T >::class_type |
Reimplemented from ResizableField< Data_T >.
Definition at line 121 of file EmptyField.h.
typedef ResizableField<Data_T> EmptyField< Data_T >::base [private] |
Convenience typedef for referring to base class.
Reimplemented from ResizableField< Data_T >.
Definition at line 165 of file EmptyField.h.
EmptyField< Data_T >::EmptyField | ( | ) |
Constructs an empty buffer.
Definition at line 174 of file EmptyField.h.
Referenced by EmptyField< Data_T >::clone().
: base() { // Empty }
void EmptyField< Data_T >::clear | ( | const Data_T & | value | ) | [virtual] |
Clears all the voxels in the storage.
Reimplemented from WritableField< Data_T >.
Definition at line 183 of file EmptyField.h.
{ m_constantData = m_default = value; }
const Data_T & EmptyField< Data_T >::constantvalue | ( | ) | const [inline] |
void EmptyField< Data_T >::setConstantvalue | ( | const Data_T & | val | ) | [inline] |
Data_T EmptyField< Data_T >::value | ( | int | i, |
int | j, | ||
int | k | ||
) | const [virtual] |
Read access to a voxel. The coordinates are in integer voxel space .
Implements Field< Data_T >.
Definition at line 191 of file EmptyField.h.
References UNUSED.
{ assert (i >= base::m_dataWindow.min.x); assert (i <= base::m_dataWindow.max.x); assert (j >= base::m_dataWindow.min.y); assert (j <= base::m_dataWindow.max.y); assert (k >= base::m_dataWindow.min.z); assert (k <= base::m_dataWindow.max.z); UNUSED(i); UNUSED(j); UNUSED(k); // Access data return m_default; }
long long int EmptyField< Data_T >::memSize | ( | ) | const [virtual] |
Returns the memory usage (in bytes)
Reimplemented from FieldRes.
Definition at line 211 of file EmptyField.h.
{ long long int superClassMemSize = base::memSize(); return sizeof(*this) + superClassMemSize; }
static DEFINE_FIELD_RTTI_CONCRETE_CLASS const char* EmptyField< Data_T >::classType | ( | ) | [inline, static] |
RTTI replacement.
Reimplemented from ResizableField< Data_T >.
Definition at line 125 of file EmptyField.h.
Referenced by EmptyField< Data_T >::className().
{ return "EmptyField"; }
Data_T & EmptyField< Data_T >::lvalue | ( | int | i, |
int | j, | ||
int | k | ||
) | [virtual] |
Write access to a voxel. The coordinates are global coordinates.
Implements WritableField< Data_T >.
Definition at line 220 of file EmptyField.h.
References UNUSED.
{ assert (i >= base::m_dataWindow.min.x); assert (i <= base::m_dataWindow.max.x); assert (j >= base::m_dataWindow.min.y); assert (j <= base::m_dataWindow.max.y); assert (k >= base::m_dataWindow.min.z); assert (k <= base::m_dataWindow.max.z); UNUSED(i); UNUSED(j); UNUSED(k); // Access data return m_ignoredData; }
virtual std::string EmptyField< Data_T >::className | ( | ) | const [inline, virtual] |
Returns the class name of the object. Used by the class pool and when writing the data to disk.
Implements FieldBase.
Definition at line 142 of file EmptyField.h.
References EmptyField< Data_T >::classType().
{ return std::string(classType()); }
virtual FieldBase::Ptr EmptyField< Data_T >::clone | ( | ) | const [inline, virtual] |
Returns a pointer to a copy of the field, pure virtual so ensure derived classes properly implement it.
Implements FieldBase.
Definition at line 145 of file EmptyField.h.
References EmptyField< Data_T >::EmptyField().
{ return Ptr(new EmptyField(*this)); }
Data_T EmptyField< Data_T >::m_default [protected] |
Field default value.
Definition at line 155 of file EmptyField.h.
Data_T EmptyField< Data_T >::m_ignoredData [protected] |
Dummy variable for assignment.
Definition at line 157 of file EmptyField.h.
Data_T EmptyField< Data_T >::m_constantData [protected] |
Field constant value.
Definition at line 159 of file EmptyField.h.