itkMetaDataDictionary.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkMetaDataDictionary_h
#define itkMetaDataDictionary_h
 
#include "itkMetaDataObjectBase.h"
#include <vector>
#include <map>
#include <string>
#include <memory>
 
namespace itk
{
class ITKCommon_EXPORT MetaDataDictionary
{
public:
  using Self = MetaDataDictionary;
  virtual void
  Print(std::ostream & os) const;
 
  // Declare the datastructure that will be used to hold the
  // dictionary.
  using MetaDataDictionaryMapType = std::map<std::string, MetaDataObjectBase::Pointer>;
  using Iterator = MetaDataDictionaryMapType::iterator;
  using ConstIterator = MetaDataDictionaryMapType::const_iterator;
 
  // Constructor
  MetaDataDictionary();
  // Copy Constructor
  MetaDataDictionary(const MetaDataDictionary &);
  MetaDataDictionary(MetaDataDictionary &&) = default;
  // operator =
  MetaDataDictionary &
  operator=(const MetaDataDictionary &);
  MetaDataDictionary &
  operator=(MetaDataDictionary &&) = default;
 
  // 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 &);
 
  // \brief Get a constant point to a DataObject
  //
  // If the key does not exist then nullptr is returned.
  const MetaDataObjectBase * operator[](const std::string &) const;
 
  const MetaDataObjectBase *
  Get(const std::string &) const;
  void
  Set(const std::string &, MetaDataObjectBase *);
  bool
  HasKey(const std::string &) const;
 
  bool
  Erase(const std::string &);
 
  // Blacklisted by igenerator.py
  Iterator
  Begin();
  // Blacklisted by igenerator.py
  ConstIterator
  Begin() const;
 
  // Blacklisted by igenerator.py
  Iterator
  End();
  // Blacklisted by igenerator.py
  ConstIterator
  End() const;
 
  Iterator
  Find(const std::string & key);
 
  ConstIterator
  Find(const std::string & key) const;
 
  void
  Clear();
 
  void
  Swap(MetaDataDictionary & other);
 
private:
  bool
  MakeUnique();
 
  std::shared_ptr<MetaDataDictionaryMapType> m_Dictionary;
};
 
inline void
swap(MetaDataDictionary & a, MetaDataDictionary & b)
{
  a.Swap(b);
}
 
} // namespace itk
#endif // itkMetaDataDictionary_h