Field3D
|
#include <Field.h>
Public Types | |
typedef FieldBase | class_type |
typedef boost::intrusive_ptr< FieldBase > | Ptr |
![]() | |
typedef boost::intrusive_ptr< RefBase > | Ptr |
typedef boost::weak_ptr< RefBase > | WeakPtr |
Public Member Functions | |
Constructors, destructors, copying | |
FieldBase () | |
Constructor. | |
FieldBase (const FieldBase &) | |
Copy Constructor. | |
virtual | ~FieldBase () |
Destructor. | |
To be implemented by subclasses | |
virtual std::string | className () const =0 |
Returns the class name of the object. Used by the class pool and when writing the data to disk. | |
virtual std::string | classType () const =0 |
Returns the full class type string. | |
virtual Ptr | clone () const =0 |
Returns a pointer to a copy of the field, pure virtual so ensure derived classes properly implement it. | |
Metadata | |
FieldMetadata & | metadata () |
accessor to the m_metadata class | |
const FieldMetadata & | metadata () const |
Read only access to the m_metadata class. | |
void | copyMetadata (const FieldBase &field) |
Copies the metadata from a second field. | |
![]() | |
void | ref () const |
Used by boost::intrusive_pointer. | |
size_t | refcnt () |
Used by boost::intrusive_pointer. | |
void | unref () const |
Used by boost::intrusive_pointer. | |
WeakPtr | weakPtr () const |
RefBase () | |
RefBase (const RefBase &) | |
Copy constructor. | |
RefBase & | operator= (const RefBase &) |
Assignment operator. | |
virtual | ~RefBase () |
Destructor. | |
virtual bool | checkRTTI (const char *typenameStr)=0 |
This function is only implemented by concrete classes and triggers the actual RTTI check through matchRTTI();. | |
bool | matchRTTI (const char *typenameStr) |
Performs a check to see if the given typename string matches this class' This needs to be implemented in -all- subclasses, even abstract ones. | |
![]() | |
virtual void | metadataHasChanged (const std::string &) |
Alerts the callback holder that the metadata has changed. | |
Static Public Member Functions | |
static const char * | staticClassName () |
static const char * | staticClassType () |
static const char * | staticClassType () |
Public Attributes | |
std::string | attribute |
Optional name of the attribute the field represents. | |
std::string | name |
Optional name of the field. | |
Private Attributes | |
FieldMetadata | m_metadata |
metadata | |
This class provides a common base for all Field objects. It serves the purpose of providing the className() virtual function and as a container for the metadata map
typedef boost::intrusive_ptr<FieldBase> FieldBase::Ptr |
typedef FieldBase FieldBase::class_type |
FIELD3D_NAMESPACE_OPEN FieldBase::FieldBase | ( | ) |
Constructor.
Definition at line 54 of file Field.cpp.
References m_metadata, and RefBase::RefBase().
Referenced by copyMetadata(), FieldBase(), and FieldRes::FieldRes().
FieldBase::FieldBase | ( | const FieldBase & | other | ) |
Copy Constructor.
Definition at line 61 of file Field.cpp.
References attribute, FieldBase(), m_metadata, name, and RefBase::RefBase().
|
virtual |
|
inlinestatic |
Definition at line 118 of file Field.h.
Referenced by staticClassType().
|
inlinestatic |
|
pure virtual |
Returns the class name of the object. Used by the class pool and when writing the data to disk.
|
pure virtual |
Returns the full class type string.
|
pure virtual |
Returns a pointer to a copy of the field, pure virtual so ensure derived classes properly implement it.
Implemented in DenseField< Data_T >, DenseField< Data_T >::const_iterator, DenseField< Data_T >::iterator, DenseField< double >, DenseField< double >, DenseField< float >, DenseField< float >, DenseField< half >, DenseField< half >, DenseField< V3d >, DenseField< V3d >, DenseField< V3f >, DenseField< V3f >, DenseField< V3h >, DenseField< V3h >, EmptyField< Data_T >, EmptyField< float >, EmptyField< float >, MACField< Data_T >, MACField< Data_T >::const_mac_comp_iterator, MACField< Data_T >::mac_comp_iterator, MACField< V3d >, MACField< V3d >, MACField< V3f >, MACField< V3f >, MACField< V3h >, MACField< V3h >, MIPDenseField< Data_T >, MIPField< Field_T >, MIPField< DenseField< Data_T > >, MIPField< SparseField< Data_T > >, MIPSparseField< Data_T >, Ptr< float >, Ptr< float >, real_t< Data_T >, real_t< Data_T >, SparseField< Data_T >::block_iterator, SparseField< Data_T >, SparseField< Data_T >::const_iterator, SparseField< Data_T >::iterator, SparseField< double >, SparseField< double >, SparseField< float >, SparseField< float >, SparseField< half >, SparseField< half >, SparseField< V3d >, SparseField< V3d >, SparseField< V3f >, SparseField< V3f >, SparseField< V3h >, and SparseField< V3h >.
Referenced by FieldRes::FieldRes().
|
inline |
accessor to the m_metadata class
Definition at line 155 of file Field.h.
References m_metadata.
Referenced by detail::adjustedMIPFieldMapping(), copyMetadata(), MIPField< Field_T >::mappingChanged(), Field3DInputFile::readProxyLayer(), Field3DInputFileHDF5::readProxyLayer(), MIPBase< Data_T >::setMIPOffset(), ProceduralField< half >::typedFloatMetadata(), ProceduralField< half >::typedFloatMetadata(), ProceduralField< half >::typedFloatMetadata(), ProceduralField< half >::typedFloatMetadata(), ProceduralField< half >::typedFloatMetadata(), ProceduralField< half >::typedFloatMetadata(), ProceduralField< half >::typedIntMetadata(), ProceduralField< half >::typedIntMetadata(), ProceduralField< half >::typedIntMetadata(), ProceduralField< half >::typedIntMetadata(), ProceduralField< half >::typedIntMetadata(), and ProceduralField< half >::typedIntMetadata().
|
inline |
Read only access to the m_metadata class.
Definition at line 159 of file Field.h.
References m_metadata.
|
inline |
Copies the metadata from a second field.
Definition at line 163 of file Field.h.
References FieldBase(), m_metadata, and metadata().
std::string FieldBase::name |
Optional name of the field.
Definition at line 171 of file Field.h.
Referenced by FieldBase(), match(), match(), Field3DInputFile::readLayer(), Field3DInputFileHDF5::readLayer(), Field3DInputFile::readProxyLayer(), Field3DInputFileHDF5::readProxyLayer(), MIPField< Field_T >::syncLevelInfo(), ProceduralField< half >::typedFloatMetadata(), ProceduralField< half >::typedFloatMetadata(), ProceduralField< half >::typedFloatMetadata(), ProceduralField< half >::typedFloatMetadata(), ProceduralField< half >::typedFloatMetadata(), ProceduralField< half >::typedFloatMetadata(), ProceduralField< half >::typedIntMetadata(), ProceduralField< half >::typedIntMetadata(), ProceduralField< half >::typedIntMetadata(), ProceduralField< half >::typedIntMetadata(), ProceduralField< half >::typedIntMetadata(), ProceduralField< half >::typedIntMetadata(), Field3DOutputFile::writeLayer(), Field3DOutputFileHDF5::writeScalarLayer(), and Field3DOutputFileHDF5::writeVectorLayer().
std::string FieldBase::attribute |
Optional name of the attribute the field represents.
Definition at line 173 of file Field.h.
Referenced by FieldBase(), match(), match(), Field3DInputFile::readLayer(), Field3DInputFileHDF5::readLayer(), Field3DInputFile::readProxyLayer(), Field3DInputFileHDF5::readProxyLayer(), MIPField< Field_T >::syncLevelInfo(), Field3DOutputFile::writeLayer(), Field3DOutputFileHDF5::writeScalarLayer(), and Field3DOutputFileHDF5::writeVectorLayer().
|
private |
metadata
Definition at line 180 of file Field.h.
Referenced by copyMetadata(), FieldBase(), FieldBase(), metadata(), and metadata().