mitkEnumerationProperty.h

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

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

#ifndef mitkEnumerationProperty_h
#define mitkEnumerationProperty_h

#include <mitkBaseProperty.h>

#include <map>
#include <string>

#ifdef _MSC_VER
#  pragma warning(push)
#  pragma warning(disable: 4522) // "multiple assignment operators specified"
#endif

namespace mitk
{
  class MITKCORE_EXPORT EnumerationProperty : public BaseProperty
  {
  public:
    mitkClassMacro(EnumerationProperty, BaseProperty);
    itkFactorylessNewMacro(Self);
    itkCloneMacro(Self);

    typedef unsigned int IdType;

    typedef std::map<IdType, std::string> EnumIdsContainerType;

    typedef std::map<std::string, IdType> EnumStringsContainerType;

    typedef EnumIdsContainerType::const_iterator EnumConstIterator;

    virtual bool AddEnum(const std::string &name, const IdType &id);

    virtual bool SetValue(const std::string &name);

    virtual bool SetValue(const IdType &id);

    virtual IdType GetValueAsId() const;

    std::string GetValueAsString() const override;

    virtual void Clear();

    virtual EnumIdsContainerType::size_type Size() const;

    virtual EnumConstIterator Begin() const;

    virtual EnumConstIterator End() const;

    virtual std::string GetEnumString(const IdType &id) const;

    virtual IdType GetEnumId(const std::string &name) const;

    virtual bool IsValidEnumerationValue(const IdType &id) const;

    virtual bool IsValidEnumerationValue(const std::string &name) const;

    const EnumIdsContainerType &GetEnumIds() const;
    const EnumStringsContainerType &GetEnumStrings() const;

    EnumIdsContainerType &GetEnumIds();
    EnumStringsContainerType &GetEnumStrings();

    using BaseProperty::operator=;
    EnumerationProperty & operator=(const EnumerationProperty &) = delete;

  protected:
    EnumerationProperty();

    EnumerationProperty(const EnumerationProperty &);

    bool IsEqual(const BaseProperty &property) const override;
    bool Assign(const BaseProperty &property) override;

    mitkCloneMacro(Self);

  private:
    IdType m_CurrentValue;

    typedef std::map<std::string, EnumIdsContainerType> IdMapForClassNameContainerType;
    typedef std::map<std::string, EnumStringsContainerType> StringMapForClassNameContainerType;

    EnumIdsContainerType m_IdMap;
    EnumStringsContainerType m_NameMap;
  };
}

#ifdef _MSC_VER
#  pragma warning(pop)
#endif

#endif