mitkPropertyList.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 mitkPropertyList_h
#define mitkPropertyList_h
 
#include <mitkIPropertyOwner.h>
#include <mitkGenericProperty.h>
 
#include <nlohmann/json_fwd.hpp>
 
namespace mitk
{
  class MITKCORE_EXPORT PropertyList : public itk::Object, public IPropertyOwner
  {
  public:
    mitkClassMacroItkParent(PropertyList, itk::Object);
 
    itkFactorylessNewMacro(Self);
    itkCloneMacro(Self);
 
    typedef std::map<std::string, BaseProperty::Pointer> PropertyMap;
    typedef std::pair<std::string, BaseProperty::Pointer> PropertyMapElementType;
 
    // IPropertyProvider
    BaseProperty::ConstPointer GetConstProperty(const std::string &propertyKey, const std::string &contextName = "", bool fallBackOnDefaultContext = true) const override;
    std::vector<std::string> GetPropertyKeys(const std::string &contextName = "", bool includeDefaultContext = false) const override;
    std::vector<std::string> GetPropertyContextNames() const override;
 
    // IPropertyOwner
    BaseProperty * GetNonConstProperty(const std::string &propertyKey, const std::string &contextName = "", bool fallBackOnDefaultContext = true) override;
    void SetProperty(const std::string &propertyKey, BaseProperty *property, const std::string &contextName = "", bool fallBackOnDefaultContext = false) override;
    void RemoveProperty(const std::string &propertyKey, const std::string &contextName = "", bool fallBackOnDefaultContext = false) override;
 
    mitk::BaseProperty *GetProperty(const std::string &propertyKey) const;
 
    void ReplaceProperty(const std::string &propertyKey, BaseProperty *property);
 
    void ConcatenatePropertyList(PropertyList *pList, bool replace = false);
 
    //##Documentation
    //## @brief Convenience access method for GenericProperty<T> properties
    //## (T being the type of the second parameter)
    //## @return @a true property was found
    template <typename T>
    bool GetPropertyValue(const char *propertyKey, T &value) const
    {
      GenericProperty<T> *gp = dynamic_cast<GenericProperty<T> *>(GetProperty(propertyKey));
      if (gp != nullptr)
      {
        value = gp->GetValue();
        return true;
      }
      return false;
    }
 
    bool GetBoolProperty(const char *propertyKey, bool &boolValue) const;
    bool Get(const char *propertyKey, bool &boolValue) const;
 
    void SetBoolProperty(const char *propertyKey, bool boolValue);
    void Set(const char *propertyKey, bool boolValue);
 
    bool GetIntProperty(const char *propertyKey, int &intValue) const;
    bool Get(const char *propertyKey, int &intValue) const;
 
    void SetIntProperty(const char *propertyKey, int intValue);
    void Set(const char *propertyKey, int intValue);
 
    bool GetFloatProperty(const char *propertyKey, float &floatValue) const;
    bool Get(const char *propertyKey, float &floatValue) const;
 
    void SetFloatProperty(const char *propertyKey, float floatValue);
    void Set(const char *propertyKey, float floatValue);
 
    bool GetDoubleProperty(const char *propertyKey, double &doubleValue) const;
    bool Get(const char *propertyKey, double &doubleValue) const;
 
    void SetDoubleProperty(const char *propertyKey, double doubleValue);
    void Set(const char *propertyKey, double doubleValue);
 
    bool GetStringProperty(const char *propertyKey, std::string &stringValue) const;
    bool Get(const char *propertyKey, std::string &stringValue) const;
 
    void SetStringProperty(const char *propertyKey, const char *stringValue);
    void Set(const char *propertyKey, const char *stringValue);
    void Set(const char *propertyKey, const std::string &stringValue);
 
    itk::ModifiedTimeType GetMTime() const override;
 
    bool DeleteProperty(const std::string &propertyKey);
 
    const PropertyMap *GetMap() const { return &m_Properties; }
    bool IsEmpty() const { return m_Properties.empty(); }
    virtual void Clear();
 
    void ToJSON(nlohmann::json& j) const;
 
    void FromJSON(const nlohmann::json& j);
 
  protected:
    PropertyList();
    PropertyList(const PropertyList &other);
 
    ~PropertyList() override;
 
    PropertyMap m_Properties;
 
  private:
    itk::LightObject::Pointer InternalClone() const override;
  };
 
} // namespace mitk
 
#endif