mitkEnumerationProperty.h

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.

This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.

See LICENSE.txt or http://www.mitk.org for details.

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

#ifndef _MITK_ENUMERATION_PROPERTY__H_
#define _MITK_ENUMERATION_PROPERTY__H_

#include "mitkBaseProperty.h"
#include <map>
#include <string>

namespace mitk
{
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable : 4522)
#endif

  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;

    virtual 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 &val) const;

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

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

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

    using BaseProperty::operator=;

  protected:
    EnumerationProperty();

    EnumerationProperty(const EnumerationProperty &);

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

    itk::LightObject::Pointer InternalClone() const override;

  private:
    // purposely not implemented
    EnumerationProperty &operator=(const EnumerationProperty &);
    IdType m_CurrentValue;

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

    static IdMapForClassNameContainerType s_IdMapForClassName;
    static StringMapForClassNameContainerType s_StringMapForClassName;
  };

#ifdef _MSC_VER
#pragma warning(pop)
#endif

} // namespace

#endif