ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Private Attributes | List of all members
itk::MetaDataDictionary Class Reference

#include <itkMetaDataDictionary.h>

+ Collaboration diagram for itk::MetaDataDictionary:

Detailed Description

Provides a mechanism for storing a collection of arbitrary data types.

Author
Hans J. Johnson

The MetaDataDictionary, along with the MetaDataObject derived template classes, is designed to provide a mechanism for storing a collection of arbitrary data types. The main motivation for such a collection is to associate arbitrary data elements with itk DataObjects.

Examples:
Examples/Filtering/DiffusionTensor3DReconstructionImageFilter.cxx, Examples/IO/DicomImageReadChangeHeaderWrite.cxx, Examples/IO/DicomImageReadPrintTags.cxx, Examples/IO/DicomSeriesReadPrintTags.cxx, Examples/IO/ImageReadDicomSeriesWrite.cxx, and WikiExamples/DICOM/ResampleDICOM.cxx.

Definition at line 40 of file itkMetaDataDictionary.h.

Public Types

typedef
MetaDataDictionaryMapType::const_iterator 
ConstIterator
 
typedef
MetaDataDictionaryMapType::iterator 
Iterator
 
typedef std::map< std::string,
MetaDataObjectBase::Pointer
MetaDataDictionaryMapType
 
typedef MetaDataDictionary Self
 

Public Member Functions

Iterator Begin ()
 
ConstIterator Begin () const
 
void Clear ()
 
Iterator End ()
 
ConstIterator End () const
 
bool Erase (const std::string &)
 
Iterator Find (const std::string &key)
 
ConstIterator Find (const std::string &key) const
 
const MetaDataObjectBaseGet (const std::string &) const
 
std::vector< std::string > GetKeys () const
 
bool HasKey (const std::string &) const
 
 MetaDataDictionary ()
 
 MetaDataDictionary (const MetaDataDictionary &)
 
MetaDataDictionaryoperator= (const MetaDataDictionary &)
 
MetaDataObjectBase::Pointeroperator[] (const std::string &)
 
const MetaDataObjectBaseoperator[] (const std::string &) const
 
virtual void Print (std::ostream &os) const
 
void Set (const std::string &, MetaDataObjectBase *)
 
virtual ~MetaDataDictionary ()
 

Private Attributes

MetaDataDictionaryMapTypem_Dictionary
 

Member Typedef Documentation

typedef MetaDataDictionaryMapType::const_iterator itk::MetaDataDictionary::ConstIterator

Definition at line 54 of file itkMetaDataDictionary.h.

typedef MetaDataDictionaryMapType::iterator itk::MetaDataDictionary::Iterator

Definition at line 53 of file itkMetaDataDictionary.h.

Definition at line 52 of file itkMetaDataDictionary.h.

Definition at line 43 of file itkMetaDataDictionary.h.

Constructor & Destructor Documentation

itk::MetaDataDictionary::MetaDataDictionary ( )
itk::MetaDataDictionary::MetaDataDictionary ( const MetaDataDictionary )
virtual itk::MetaDataDictionary::~MetaDataDictionary ( )
virtual

Member Function Documentation

Iterator itk::MetaDataDictionary::Begin ( )
Warning
the following functions SHOULD NOT be used with the visual studio 6 compiler since iterator outside of the dll context cannot be dereferenced safely Returns an iterator to the beginning of the map
Examples:
WikiExamples/DICOM/ResampleDICOM.cxx.
ConstIterator itk::MetaDataDictionary::Begin ( ) const
void itk::MetaDataDictionary::Clear ( )

remove all MetaObjects from dictionary

Iterator itk::MetaDataDictionary::End ( )

Returns an iterator to the end of the map

Examples:
WikiExamples/DICOM/ResampleDICOM.cxx.
ConstIterator itk::MetaDataDictionary::End ( ) const
bool itk::MetaDataDictionary::Erase ( const std::string &  )
Iterator itk::MetaDataDictionary::Find ( const std::string &  key)

Returns an iterator matching the string key

ConstIterator itk::MetaDataDictionary::Find ( const std::string &  key) const
const MetaDataObjectBase* itk::MetaDataDictionary::Get ( const std::string &  ) const
std::vector< std::string > itk::MetaDataDictionary::GetKeys ( ) const

Returns a vector of keys to the key/value entries in the dictionary. Iterate through the dictionary using these keys.

Examples:
Examples/Filtering/DiffusionTensor3DReconstructionImageFilter.cxx.
bool itk::MetaDataDictionary::HasKey ( const std::string &  ) const

Referenced by itk::ExposeMetaData().

MetaDataDictionary& itk::MetaDataDictionary::operator= ( const MetaDataDictionary )
MetaDataObjectBase::Pointer& itk::MetaDataDictionary::operator[] ( const std::string &  )
const MetaDataObjectBase* itk::MetaDataDictionary::operator[] ( const std::string &  ) const
virtual void itk::MetaDataDictionary::Print ( std::ostream &  os) const
virtual

Defines the default behavior for printing out this element

Parameters
osAn output stream
void itk::MetaDataDictionary::Set ( const std::string &  ,
MetaDataObjectBase  
)

Member Data Documentation

MetaDataDictionaryMapType* itk::MetaDataDictionary::m_Dictionary
private

Definition at line 116 of file itkMetaDataDictionary.h.


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