|
Field3D
|
#include <Field.h>
Public Types | |
| typedef FieldBase | class_type |
| typedef boost::intrusive_ptr< FieldBase > | Ptr |
Public Types inherited from RefBase | |
| typedef boost::intrusive_ptr< RefBase > | Ptr |
| typedef boost::weak_ptr< RefBase > | WeakPtr |
Public Member Functions | |
Constructors, destructors, copying | |
| FieldBase () | |
| Constructor. More... | |
| FieldBase (const FieldBase &) | |
| Copy Constructor. More... | |
| virtual | ~FieldBase () |
| Destructor. More... | |
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. More... | |
| virtual std::string | classType () const =0 |
| Returns the full class type string. More... | |
| virtual Ptr | clone () const =0 |
| Returns a pointer to a copy of the field, pure virtual so ensure derived classes properly implement it. More... | |
Metadata | |
| FieldMetadata & | metadata () |
| accessor to the m_metadata class More... | |
| const FieldMetadata & | metadata () const |
| Read only access to the m_metadata class. More... | |
| void | copyMetadata (const FieldBase &field) |
| Copies the metadata from a second field. More... | |
Public Member Functions inherited from RefBase | |
| void | ref () const |
| Used by boost::intrusive_pointer. More... | |
| size_t | refcnt () |
| Used by boost::intrusive_pointer. More... | |
| void | unref () const |
| Used by boost::intrusive_pointer. More... | |
| WeakPtr | weakPtr () const |
| RefBase () | |
| RefBase (const RefBase &) | |
| Copy constructor. More... | |
| RefBase & | operator= (const RefBase &) |
| Assignment operator. More... | |
| virtual | ~RefBase () |
| Destructor. More... | |
| virtual bool | checkRTTI (const char *typenameStr)=0 |
| This function is only implemented by concrete classes and triggers the actual RTTI check through matchRTTI();. More... | |
| 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. More... | |
Public Member Functions inherited from MetadataCallback | |
| virtual void | metadataHasChanged (const std::string &) |
| Alerts the callback holder that the metadata has changed. More... | |
Static Public Member Functions | |
| static const char * | staticClassName () |
| static const char * | staticClassType () |
Static Public Member Functions inherited from RefBase | |
| static const char * | staticClassType () |
Public Attributes | |
| std::string | attribute |
| Optional name of the attribute the field represents. More... | |
| std::string | name |
| Optional name of the field. More... | |
Private Attributes | |
| FieldMetadata | m_metadata |
| metadata More... | |
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 | ( | ) |
| FieldBase::FieldBase | ( | const FieldBase & | other | ) |
Copy Constructor.
Definition at line 61 of file Field.cpp.
References m_metadata.
|
virtual |
|
inlinestatic |
|
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 >, EmptyField< Data_T >, MACField< Data_T >, MIPField< Field_T >, MIPField< DenseField< Data_T > >, MIPField< SparseField< Data_T > >, MIPSparseField< Data_T >, MIPDenseField< Data_T >, and SparseField< Data_T >.
|
inline |
accessor to the m_metadata class
Definition at line 155 of file Field.h.
Referenced by detail::adjustedMIPFieldMapping(), copyMetadata(), Field3DInputFile::readProxyLayer(), and Field3DInputFileHDF5::readProxyLayer().
|
inline |
|
inline |
Copies the metadata from a second field.
Definition at line 163 of file Field.h.
References metadata().
| std::string FieldBase::name |
Optional name of the field.
Definition at line 171 of file Field.h.
Referenced by match(), Field3DInputFile::readLayer(), Field3DInputFileHDF5::readLayer(), Field3DInputFileHDF5::readProxyLayer(), Field3DInputFile::readProxyLayer(), DenseField< Data_T >::staticClassType(), Field< Data_T >::staticClassType(), WritableField< Data_T >::staticClassType(), ResizableField< Data_T >::staticClassType(), MACField< Data_T >::staticClassType(), MIPBase< Data_T >::staticClassType(), MIPField< Field_T >::staticClassType(), ProceduralField< Data_T >::staticClassType(), SparseField< Data_T >::staticClassType(), Field3DOutputFile::writeLayer(), and Field3DOutputFileHDF5::writeScalarLayer().
| std::string FieldBase::attribute |
Optional name of the attribute the field represents.
Definition at line 173 of file Field.h.
Referenced by match(), Field3DInputFile::readLayer(), Field3DInputFileHDF5::readLayer(), Field3DInputFileHDF5::readProxyLayer(), Field3DInputFile::readProxyLayer(), Field3DOutputFile::writeLayer(), and Field3DOutputFileHDF5::writeScalarLayer().
|
private |