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

itkMetaDataObject.h File Reference

Go to the source code of this file.

Namespaces

namespace  itk

Classes

class  itk::MetaDataObject< MetaDataObjectType >

Defines

#define ITK_IMAGE_TYPE_METADATAPRINT(STORAGE_TYPE)

Functions

template<class T> void EncapsulateMetaData (MetaDataDictionary &Dictionary, const char *key, const T &invalue)
template<class T> bool ExposeMetaData (MetaDataDictionary &Dictionary, const std::string key, T &outval)
template<class T> bool ExposeMetaData (MetaDataDictionary &Dictionary, const char *const key, T &outval)

Define Documentation

#define ITK_IMAGE_TYPE_METADATAPRINT (  STORAGE_TYPE   ) 
 

Value:

ITK_IMAGE_TYPE_METADATAPRINT An ungly macro to facilitate creating a simple implementation of the MetaDataObject<Type>::Print() function for itk::Image<STORAGE_TYPE,[1-8]>Pointer
Parameters:
STORAGE_TYPE The storage type of the image type to print.
Definition at line 293 of file itkMetaDataObject.h.

#define ITK_OBJECT_TYPE_METADATAPRINT_1COMMA (  TYPE_NAME_PART1,
TYPE_NAME_PART2   ) 
 

Value:

void \
  itk::MetaDataObject<TYPE_NAME_PART1,TYPE_NAME_PART2> \
  ::Print(std::ostream& os) const \
{ \
  this->m_MetaDataObjectValue->Print(os); \
} \
void \
  itk::MetaDataObject<const TYPE_NAME_PART1,TYPE_NAME_PART2> \
  ::Print(std::ostream& os) const \
{ \
  this->m_MetaDataObjectValue->Print(os); \
}
ITK_OBJECT_TYPE_METADATAPRINT_1COMMA An ungly macro to facilitate creating a simple implementation of the MetaDataObject<Type>::Print() function for itk::Objects that have 1 comma in their type definition
Parameters:
TYPE_NAME_PART1 
TYPE_NAME_PART2 
Definition at line 271 of file itkMetaDataObject.h.

#define NATIVE_TYPE_METADATAPRINT (  TYPE_NAME   ) 
 

Value:

void \
  itk::MetaDataObject<TYPE_NAME> \
  ::Print(std::ostream& os) const \
{ \
  os << this->m_MetaDataObjectValue << std::endl; \
} \
void \
  itk::MetaDataObject<const TYPE_NAME> \
  ::Print(std::ostream& os) const \
{ \
  os << this->m_MetaDataObjectValue << std::endl; \
}
NATIVE_TYPE_METADATAPRINT An ungly macro to facilitate creating a simple implementation of the MetaDataObject<Type>::Print() function for types that have operator<< defined.
Parameters:
TYPE_NAME the native type parameter type
Definition at line 248 of file itkMetaDataObject.h.

Function Documentation

template<class T>
void EncapsulateMetaData (  MetaDataDictionary &  Dictionary,
const char *  key,
const T &  invalue
)  [inline]
 

Definition at line 169 of file itkMetaDataObject.h.

template<class T>
void EncapsulateMetaData (  MetaDataDictionary &  Dictionary,
const std::string &  key,
const T &  invalue
)  [inline]
 

EncapsulateMetaData is a convenience function that encapsulates raw MetaData into a MetaDataObject that can be put into the MetaDataDictionary.

Parameters:
value the value of type T that is to be encapsulated.
Returns:
A smartpointer ot a MetaDataObject that is suitable for insertion into a MetaDataDictionary.
Definition at line 160 of file itkMetaDataObject.h.

template<class T>
bool ExposeMetaData (  MetaDataDictionary &  Dictionary,
const char *const  key,
T &  outval
)  [inline]
 

Definition at line 234 of file itkMetaDataObject.h.

template<class T>
bool ExposeMetaData (  MetaDataDictionary &  Dictionary,
const std::string  key,
T &  outval
)  [inline]
 

FindValInDictionary provides a shortcut for pulling a value of type T out of a MetaDataDictionary. If Dictionary[key] isn't set, return false, otherwise copy into outval reference and return true.

Parameters:
Dictionary -- reference to a dictionary key -- string identifier for this object
outval -- where to store value found in table.
Definition at line 184 of file itkMetaDataObject.h.

Generated at Sun Apr 1 02:48:19 2007 for ITK by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2000