mitkTemporoSpatialStringProperty.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 mitkTemporoSpatialStringProperty_h
#define mitkTemporoSpatialStringProperty_h
 
#include <itkConfigure.h>
 
#include <mitkBaseProperty.h>
#include <MitkCoreExports.h>
 
#include <mitkTimeGeometry.h>
 
#include <string>
 
namespace mitk
{
  class MITKCORE_EXPORT TemporoSpatialStringProperty : public BaseProperty
  {
  public:
    typedef ::itk::IndexValueType IndexValueType;
 
    typedef std::string ValueType;
 
    mitkClassMacro(TemporoSpatialStringProperty, BaseProperty);
 
    itkFactorylessNewMacro(Self);
 
    itkCloneMacro(Self);
    mitkNewMacro1Param(TemporoSpatialStringProperty, const char*);
    mitkNewMacro1Param(TemporoSpatialStringProperty, const std::string &);
 
    ValueType GetValue() const;
 
    ValueType GetValue(const TimeStepType &timeStep,
                       const IndexValueType &zSlice,
                       bool allowCloseTime = false,
                       bool allowCloseSlice = false) const;
 
    ValueType GetValueBySlice(const IndexValueType &zSlice, bool allowClose = false) const;
 
    ValueType GetValueByTimeStep(const TimeStepType &timeStep, bool allowClose = false) const;
 
    bool HasValue() const;
 
    bool HasValue(const TimeStepType &timeStep,
                  const IndexValueType &zSlice,
                  bool allowCloseTime = false,
                  bool allowCloseSlice = false) const;
 
    bool HasValueBySlice(const IndexValueType &zSlice, bool allowClose = false) const;
 
    bool HasValueByTimeStep(const TimeStepType &timeStep, bool allowClose = false) const;
 
    std::vector<IndexValueType> GetAvailableSlices(const TimeStepType& timeStep) const;
 
    std::vector<TimeStepType> GetAvailableTimeSteps(const IndexValueType& slice) const;
 
    std::vector<TimeStepType> GetAvailableTimeSteps() const;
 
    std::vector<IndexValueType> GetAvailableSlices() const;
 
    void SetValue(const TimeStepType &timeStep, const IndexValueType &zSlice, const ValueType &value);
 
    void SetValue(const ValueType &value);
 
    std::string GetValueAsString() const override;
 
    bool IsUniform() const;
 
    bool ToJSON(nlohmann::json& j) const override;
 
    bool FromJSON(const nlohmann::json& j) override;
 
    using BaseProperty::operator=;
 
  protected:
    typedef std::map<IndexValueType, std::string> SliceMapType;
    typedef std::map<TimeStepType, SliceMapType> TimeMapType;
 
    TimeMapType m_Values;
 
    TemporoSpatialStringProperty(const char *string = nullptr);
    TemporoSpatialStringProperty(const std::string &s);
 
    TemporoSpatialStringProperty(const TemporoSpatialStringProperty &);
 
    std::pair<bool, ValueType> CheckValue(const TimeStepType &timeStep,
                                          const IndexValueType &zSlice,
                                          bool allowCloseTime = false,
                                          bool allowCloseSlice = false) const;
 
    mitkCloneMacro(TemporoSpatialStringProperty);
 
  private:
    // purposely not implemented
    TemporoSpatialStringProperty &operator=(const TemporoSpatialStringProperty &);
 
    bool IsEqual(const BaseProperty &property) const override;
    bool Assign(const BaseProperty &property) override;
  };
 
  namespace PropertyPersistenceSerialization
  {
    MITKCORE_EXPORT std::string serializeTemporoSpatialStringPropertyToJSON(const mitk::BaseProperty *prop);
  }
 
  namespace PropertyPersistenceDeserialization
  {
    MITKCORE_EXPORT mitk::BaseProperty::Pointer deserializeJSONToTemporoSpatialStringProperty(const std::string &value);
  }
 
  TemporoSpatialStringProperty::Pointer MITKCORE_EXPORT ExtractTimeStepFromTemporoSpatialStringProperty(const TemporoSpatialStringProperty* tsProperty, TimeStepType ts);
 
 
} // namespace mitk
 
#endif