mitkVectorProperty.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 mitkVectorProperty_h
#define mitkVectorProperty_h
 
// MITK
#include <MitkCoreExports.h>
#include <mitkBaseProperty.h>
 
// STL
#include <vector>
 
namespace mitk
{
  template <typename D>
  struct VectorPropertyDataType
  {
    static const char *prefix() { return "Invalid"; }
  };
 
  template <typename DATATYPE>
  class MITKCORE_EXPORT VectorProperty : public BaseProperty
  {
  public:
    typedef std::vector<DATATYPE> VectorType;
 
    // Manually expand most of mitkClassMacro:
    //   mitkClassMacro(VectorProperty<DATATYPE>, mitk::BaseProperty);
    // This manual expansion is done to override explicitly
    // the GetNameOfClass() and GetStaticNameOfClass() methods
    typedef VectorProperty<DATATYPE> Self;
    typedef BaseProperty SuperClass;
    typedef itk::SmartPointer<Self> Pointer;
    typedef itk::SmartPointer<const Self> ConstPointer;
    std::vector<std::string> GetClassHierarchy() const override { return mitk::GetClassHierarchy<Self>(); }
 
    static const char *GetStaticNameOfClass()
    {
      // concatenate a prefix dependent on the template type and our own classname
      static std::string nameOfClass = std::string(VectorPropertyDataType<DATATYPE>::prefix()).append("VectorProperty");
      return nameOfClass.c_str();
    }
 
    const char *GetNameOfClass() const override { return this->GetStaticNameOfClass(); }
    itkFactorylessNewMacro(Self);
    itkCloneMacro(Self);
 
    std::string GetValueAsString() const override;
 
    virtual const VectorType &GetValue() const;
 
    virtual void SetValue(const VectorType &parameter_vector);
 
    bool ToJSON(nlohmann::json& j) const override;
 
    bool FromJSON(const nlohmann::json& j) override;
 
  protected:
    VectorProperty() = default;
    VectorProperty(const Self &other) : BaseProperty(other), m_PropertyContent(other.m_PropertyContent) {}
 
    mitkCloneMacro(Self);
 
  private:
    VectorProperty &operator=(const Self &);
 
    bool IsEqual(const BaseProperty &an_other_property) const override;
 
    bool Assign(const BaseProperty &an_other_property) override;
 
    VectorType m_PropertyContent;
  };
 
#define MITK_DECLARE_VECTOR_PROPERTY(TYPE, PREFIX)                                                                     \
                                                                                                                       \
  typedef VectorProperty<TYPE> PREFIX##VectorProperty;                                                                 \
                                                                                                                       \
  template <>                                                                                                          \
                                                                                                                       \
  struct VectorPropertyDataType<TYPE>                                                                                  \
  {                                                                                                                    \
    static const char *prefix() { return #PREFIX; }                                                                    \
  };
 
#define MITK_DEFINE_VECTOR_PROPERTY(TYPE) template class VectorProperty<TYPE>;
 
  MITK_DECLARE_VECTOR_PROPERTY(double, Double)
  MITK_DECLARE_VECTOR_PROPERTY(int, Int)
 
} // namespace
 
#endif