Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::MetaDataObjectBase Class Reference

#include <itkMetaDataObjectBase.h>

Inheritance diagram for itk::MetaDataObjectBase:

Inheritance graph
[legend]
Collaboration diagram for itk::MetaDataObjectBase:

Collaboration graph
[legend]
List of all members.

Detailed Description

The MetaDataObjectBase class is designed as the common interface for MetaDataObject's. This class is intended as the value part of the (key,value) pair to be stored in a MetaDataDictionary.

Author:
Hans J. Johnson

Definition at line 38 of file itkMetaDataObjectBase.h.

Public Types

typedef SmartPointer< const
Self
ConstPointer
typedef SmartPointer< SelfPointer
typedef MetaDataObjectBase Self
typedef LightObject 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
virtual const char * GetNameOfClass () const
virtual int GetReferenceCount () const
void Print (std::ostream &os, Indent indent=0) const
virtual void Print (std::ostream &os) const
virtual void Register () const
virtual void SetReferenceCount (int)
virtual void UnRegister () const

Static Public Member Functions

static void BreakOnError ()

Protected Member Functions

 MetaDataObjectBase ()
virtual void PrintTrailer (std::ostream &os, Indent indent) const
*Default destructor *virtual ~MetaDataObjectBase ()

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

typedef SmartPointer<const Self> itk::MetaDataObjectBase::ConstPointer
 

Reimplemented from itk::LightObject.

Reimplemented in itk::MetaDataObject< MetaDataObjectType >.

Definition at line 45 of file itkMetaDataObjectBase.h.

typedef SmartPointer<Self> itk::MetaDataObjectBase::Pointer
 

Reimplemented from itk::LightObject.

Reimplemented in itk::MetaDataObject< MetaDataObjectType >.

Definition at line 44 of file itkMetaDataObjectBase.h.

typedef MetaDataObjectBase itk::MetaDataObjectBase::Self
 

Smart pointer typedef support.

Reimplemented from itk::LightObject.

Reimplemented in itk::MetaDataObject< MetaDataObjectType >.

Definition at line 42 of file itkMetaDataObjectBase.h.

typedef LightObject itk::MetaDataObjectBase::Superclass
 

Reimplemented in itk::MetaDataObject< MetaDataObjectType >.

Definition at line 43 of file itkMetaDataObjectBase.h.


Constructor & Destructor Documentation

* Default destructor* virtual itk::MetaDataObjectBase::~MetaDataObjectBase  )  [protected, virtual]
 

itk::MetaDataObjectBase::MetaDataObjectBase  )  [protected]
 


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.

virtual const std::type_info& itk::MetaDataObjectBase::GetMetaDataObjectTypeInfo void   )  const [virtual]
 

Author:
Hans J. Johnson
Returns:
A constant reference to a std::type_info object

Reimplemented in itk::MetaDataObject< MetaDataObjectType >.

virtual const char* itk::MetaDataObjectBase::GetMetaDataObjectTypeName void   )  const [virtual]
 

Author:
Hans J. Johnson
Returns:
A pointer to a const char array containing the unique type name.

Reimplemented in itk::MetaDataObject< MetaDataObjectType >.

virtual const char* itk::MetaDataObjectBase::GetNameOfClass  )  const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::LightObject.

Reimplemented in itk::MetaDataObject< MetaDataObjectType >.

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

Gets the reference count on this object.

Definition at line 98 of file itkLightObject.h.

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

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.

virtual void itk::MetaDataObjectBase::Print std::ostream &  os  )  const [virtual]
 

Defines the default behavior for printing out this element

Parameters:
os An output stream

Reimplemented in itk::MetaDataObject< MetaDataObjectType >.

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.

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:
Generated at Sun Jul 9 20:42:47 2006 for ITK by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2000