ITK
4.6.0
Insight Segmentation and Registration Toolkit
|
#include <itkMetaDataObject.h>
Allows arbitrary data types to be stored as MetaDataObjectBase types, and to be stored in a MetaDataDictionary.
The MetaDataObject class is a templated class that is a specialization of the MetaDataObjectBase type. This class allows arbitrary data types to be stored as MetaDataObjectBase types, and to be stored in a MetaDataDictionary.
Any class or built in type that has valid copy constructor and operator= can be wrapped directly with this simple template type.
Classes or built in types that do not have valid copy constructors or operator= implemented will have to implement those functions by deriving from MetaDataObject<MetaDataObjectType> and redefining the copy constructor and initializing constructor and the Get/Set functions to work around those deficiencies.
The behavior of the MetaDataObject<Type>::Print() function has many plausible application dependent implementations. The default implementation prints the string "[UNKNOWN PRINT CHARACTERISTICS]" that works for all possible MetaDataObject types.
The application developer may overload the default implementation to provide a specialized Print() characteristics to produce results desirable for their application. A set of very crude Macros {NATIVE_TYPE_METADATAPRINT, ITK_OBJECT_TYPE_METADATAPRINT_1COMMA, ITK_IMAGE_TYPE_METADATAPRINT } are provided to facilitate a very simple implementation, and as an example.
Definition at line 73 of file itkMetaDataObject.h.
Public Types | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef MetaDataObject | Self |
typedef MetaDataObjectBase | Superclass |
Public Types inherited from itk::MetaDataObjectBase | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef MetaDataObjectBase | Self |
typedef LightObject | Superclass |
Public Types inherited from itk::LightObject | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightObject | Self |
Public Member Functions | |
virtual ::itk::LightObject::Pointer | CreateAnother (void) const |
virtual const std::type_info & | GetMetaDataObjectTypeInfo () const ITK_OVERRIDE |
virtual const char * | GetMetaDataObjectTypeName () const ITK_OVERRIDE |
const MetaDataObjectType & | GetMetaDataObjectValue () const |
virtual const char * | GetNameOfClass () const |
virtual void | Print (std::ostream &os) const ITK_OVERRIDE |
void | SetMetaDataObjectValue (const MetaDataObjectType &newValue) |
Public Member Functions inherited from itk::LightObject | |
virtual void | Delete () |
virtual int | GetReferenceCount () const |
itkCloneMacro (Self) | |
void | Print (std::ostream &os, Indent indent=0) const |
virtual void | Register () const |
virtual void | SetReferenceCount (int) |
virtual void | UnRegister () const |
Static Public Member Functions | |
static Pointer | New (void) |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
Protected Member Functions | |
MetaDataObject () | |
virtual | ~MetaDataObject () |
Protected Member Functions inherited from itk::MetaDataObjectBase | |
MetaDataObjectBase () | |
virtual | ~MetaDataObjectBase () |
Protected Member Functions inherited from itk::LightObject | |
virtual LightObject::Pointer | InternalClone () const |
LightObject () | |
virtual void | PrintHeader (std::ostream &os, Indent indent) const |
virtual void | PrintSelf (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Private Member Functions | |
MetaDataObject (const Self &) | |
void | operator= (const Self &) |
Private Attributes | |
MetaDataObjectType | m_MetaDataObjectValue |
Additional Inherited Members | |
Protected Types inherited from itk::LightObject | |
typedef int | InternalReferenceCountType |
Protected Attributes inherited from itk::LightObject | |
InternalReferenceCountType | m_ReferenceCount |
SimpleFastMutexLock | m_ReferenceCountLock |
typedef SmartPointer< const Self > itk::MetaDataObject< MetaDataObjectType >::ConstPointer |
Definition at line 81 of file itkMetaDataObject.h.
typedef SmartPointer< Self > itk::MetaDataObject< MetaDataObjectType >::Pointer |
Definition at line 80 of file itkMetaDataObject.h.
typedef MetaDataObject itk::MetaDataObject< MetaDataObjectType >::Self |
Smart pointer typedef support.
Definition at line 78 of file itkMetaDataObject.h.
typedef MetaDataObjectBase itk::MetaDataObject< MetaDataObjectType >::Superclass |
Definition at line 79 of file itkMetaDataObject.h.
|
protected |
|
protectedvirtual |
|
private |
|
virtual |
Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.
Reimplemented from itk::LightObject.
|
virtual |
The definition of this function is necessary to fulfill the interface of the MetaDataObjectBase
Reimplemented from itk::MetaDataObjectBase.
|
virtual |
The definition of this function is necessary to fulfill the interface of the MetaDataObjectBase
Reimplemented from itk::MetaDataObjectBase.
const MetaDataObjectType& itk::MetaDataObject< MetaDataObjectType >::GetMetaDataObjectValue | ( | ) | const |
Function to return the stored value of type MetaDataObjectType.
Referenced by itk::ExposeMetaData().
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::MetaDataObjectBase.
|
static |
Method for creation through the object factory.
Referenced by itk::EncapsulateMetaData().
|
private |
|
virtual |
Defines the default behavior for printing out this element
os | An output stream |
Reimplemented from itk::MetaDataObjectBase.
void itk::MetaDataObject< MetaDataObjectType >::SetMetaDataObjectValue | ( | const MetaDataObjectType & | newValue | ) |
Function to set the stored value of type MetaDataObjectType.
newValue | A constant reference to at MetaDataObjectType. |
|
private |
A variable to store this derived type.
Definition at line 137 of file itkMetaDataObject.h.