itk::MetaDataObject< MetaDataObjectType > Class Template Reference

#include <itkMetaDataObject.h>

Inheritance diagram for itk::MetaDataObject< MetaDataObjectType >:

[legend]Collaboration diagram for itk::MetaDataObject< MetaDataObjectType >:

[legend]List of all members.

---

Detailed Description

template<class MetaDataObjectType>
class itk::MetaDataObject< MetaDataObjectType >

Author:

Hans J. Johnson 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 dependant 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 61 of file itkMetaDataObject.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef MetaDataObject	Self
typedef MetaDataObjectBase	Superclass
Public Member Functions
virtual Pointer	CreateAnother () const
virtual void	Delete ()
virtual const std::type_info &	GetMetaDataObjectTypeInfo (void) const
virtual const char *	GetMetaDataObjectTypeName (void) const
const MetaDataObjectType &	GetMetaDataObjectValue (void) const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
	itkFactorylessNewMacro (Self)
	MetaDataObject (const MetaDataObject< MetaDataObjectType > &TemplateObject)
	MetaDataObject (const MetaDataObjectType InitializerValue)
	MetaDataObject (void)
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Print (std::ostream &os) const
virtual void	Register () const
void	SetMetaDataObjectValue (const MetaDataObjectType &NewValue)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
virtual	~MetaDataObject (void)
Static Public Member Functions
static void	BreakOnError ()
Protected Member Functions
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Static Protected Member Functions
static Pointer	New (void)
Protected Attributes
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Methods invoked by virtual Print() to print information about the object *including superclasses.Typically not called by the user(use Print()*instead) but used in the hierarchical print process to combine the *output of several classes.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

Member Typedef Documentation

template<class MetaDataObjectType> typedef SmartPointer<const Self> itk::MetaDataObject< MetaDataObjectType >::ConstPointer

Reimplemented from itk::MetaDataObjectBase. Definition at line 68 of file itkMetaDataObject.h.

template<class MetaDataObjectType> typedef SmartPointer<Self> itk::MetaDataObject< MetaDataObjectType >::Pointer

Reimplemented from itk::MetaDataObjectBase. Definition at line 67 of file itkMetaDataObject.h.

template<class MetaDataObjectType> typedef MetaDataObject itk::MetaDataObject< MetaDataObjectType >::Self

Smart pointer typedef support. Reimplemented from itk::MetaDataObjectBase. Definition at line 65 of file itkMetaDataObject.h.

template<class MetaDataObjectType> typedef MetaDataObjectBase itk::MetaDataObject< MetaDataObjectType >::Superclass

Reimplemented from itk::MetaDataObjectBase. Definition at line 66 of file itkMetaDataObject.h.

---

Constructor & Destructor Documentation

template<class MetaDataObjectType> itk::MetaDataObject< MetaDataObjectType >::MetaDataObject (  void   )

Author: Hans J. Johnson Default constructor with no initialization.

template<class MetaDataObjectType> virtual itk::MetaDataObject< MetaDataObjectType >::~MetaDataObject (  void   )  [virtual]

Author: Hans J. Johnson Default virtual Destructor

template<class MetaDataObjectType> itk::MetaDataObject< MetaDataObjectType >::MetaDataObject (  const MetaDataObjectType  InitializerValue  )

Author: Hans J. Johnson Initializer constructor that sets m_MetaDataObjectValue to InitializerValue

template<class MetaDataObjectType> itk::MetaDataObject< MetaDataObjectType >::MetaDataObject (  const MetaDataObject< MetaDataObjectType > &  TemplateObject  )

Author: Hans J. Johnson Copy constructor that sets m_MetaDataObjectValue to TemplateObject.m_MetaDataObjectValue

---

Member Function Documentation

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual Pointer itk::LightObject::CreateAnother (   )  const [virtual, inherited]

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 in itk::Object.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

template<class MetaDataObjectType> virtual const std::type_info& itk::MetaDataObject< MetaDataObjectType >::GetMetaDataObjectTypeInfo (  void   )  const [virtual]

Author: Hans J. Johnson The definition of this function is necessary to fulfill the interface of the MetaDataObjectBase Returns: A constant reference to a std::type_info object Reimplemented from itk::MetaDataObjectBase.

template<class MetaDataObjectType> virtual const char* itk::MetaDataObject< MetaDataObjectType >::GetMetaDataObjectTypeName (  void   )  const [virtual]

Author: Hans J. Johnson The definition of this function is necessary to fulfill the interface of the MetaDataObjectBase Returns: A pointer to a const char array containing the unique type name. Reimplemented from itk::MetaDataObjectBase.

template<class MetaDataObjectType> const MetaDataObjectType& itk::MetaDataObject< MetaDataObjectType >::GetMetaDataObjectValue (  void   )  const

Author: Hans J. Johnson Function to return the stored value of type MetaDataObjectType. Returns: a constant reference to a MetaDataObjectType Referenced by itk::ExposeMetaData().

template<class MetaDataObjectType> virtual const char* itk::MetaDataObject< MetaDataObjectType >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::MetaDataObjectBase.

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

template<class MetaDataObjectType> itk::MetaDataObject< MetaDataObjectType >::itkFactorylessNewMacro (  Self   )

Method for creation through the object factory.

static Pointer itk::MetaDataObjectBase::New (  void   )  [static, protected, inherited]

Method for creation through the object factory. Reimplemented from itk::LightObject.

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

template<class MetaDataObjectType> virtual void itk::MetaDataObject< MetaDataObjectType >::Print (  std::ostream &  os  )  const [virtual]

Defines the default behavior for printing out this element Parameters: os  An output stream Reimplemented from itk::MetaDataObjectBase.

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::LightObject::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented in itk::Object.

template<class MetaDataObjectType> void itk::MetaDataObject< MetaDataObjectType >::SetMetaDataObjectValue (  const MetaDataObjectType &  NewValue  )

Author: Hans J. Johnson Function to set the stored value of type MetaDataObjectType. Parameters: A  constant reference to at MetaDataObjectType. Referenced by itk::EncapsulateMetaData().

virtual void itk::LightObject::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count on this object. This is a dangerous method, use it with care. Reimplemented in itk::Object.

virtual void itk::LightObject::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented in itk::Object.

---

Member Data Documentation

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual Print () to print information about the object * including superclasses. Typically not called by the user (use Print() * instead) but used in the hierarchical print process to combine the * output of several classes. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkMetaDataObject.h

---