itkMetaDataDictionary.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkMetaDataDictionary.h,v $
  Language:  C++
  Date:      $Date: 2009-02-05 22:04:15 $
  Version:   $Revision: 1.22 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkMetaDataDictionary_h
#define __itkMetaDataDictionary_h

#include "itkMetaDataObjectBase.h"
#include <vector>
#include <map>
#include <string>

namespace itk
{

class ITKCommon_EXPORT MetaDataDictionary
{
public:
  typedef MetaDataDictionary Self;
  virtual void Print(std::ostream& os) const;

  // Declare the datastructure that will be used to hold the
  // dictionary. 
  class MetaDataDictionaryMapType 
    : public std::map<std::string, MetaDataObjectBase::Pointer>
    {
    };

  typedef MetaDataDictionaryMapType::iterator       Iterator;
  typedef MetaDataDictionaryMapType::const_iterator ConstIterator;

  // Constructor
  MetaDataDictionary();
  // Copy Constructor
  MetaDataDictionary(const MetaDataDictionary&);
  // operator =
  void operator=(const MetaDataDictionary&);

  // Destructor
  virtual ~MetaDataDictionary();

  std::vector<std::string> GetKeys() const;

  // Implement map's api. On some Micorsoft compilers, stl containers
  // cannot be exported. This causes problems when building DLL's.
  // Here we inherit privately from std::map and provide a simple
  // API. The implementation will be in the DLL.
  MetaDataObjectBase::Pointer &operator [](const std::string &);
  const MetaDataObjectBase   * operator [](const std::string &) const;
  bool HasKey (const std::string &) const;


#if !defined(CABLE_CONFIGURATION)
  Iterator  Begin();
  ConstIterator  Begin() const;
#endif


#if !defined(CABLE_CONFIGURATION)
  Iterator  End();
  ConstIterator  End() const;
#endif


#if !defined(CABLE_CONFIGURATION)
  Iterator  Find(const std::string & key);
  ConstIterator  Find(const std::string & key) const;
#endif


private:
  MetaDataDictionaryMapType *m_Dictionary;
};

}
#endif // __itkMetaDataDictionary_h