Property for time and space resolved string values. More...

#include <mitkTemporoSpatialStringProperty.h>

Inheritance diagram for mitk::TemporoSpatialStringProperty:

Collaboration diagram for mitk::TemporoSpatialStringProperty:

[legend]

Public Types
typedef ::itk::IndexValueType	IndexValueType

typedef std::string	ValueType

typedef TemporoSpatialStringProperty	Self

typedef BaseProperty	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Types inherited from mitk::BaseProperty
typedef BaseProperty	Self

typedef itk::Object	Superclass

typedef itk::SmartPointer< Self >	Pointer

typedef itk::SmartPointer< const Self >	ConstPointer

Public Member Functions
virtual std::vector< std::string >	GetClassHierarchy () const override

virtual const char *	GetClassName () const

Pointer	Clone () const

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
	Serialize property value(s) to JSON. More...

bool	FromJSON (const nlohmann::json &j) override
	Deserialize property value(s) from JSON. More...

BaseProperty &	operator= (const BaseProperty &property)
	Assigns property to this BaseProperty instance. More...

Public Member Functions inherited from mitk::BaseProperty
Pointer	Clone () const

bool	operator== (const BaseProperty &property) const
	Subclasses must implement IsEqual(const BaseProperty&) to support comparison. More...

BaseProperty &	operator= (const BaseProperty &property)
	Assigns property to this BaseProperty instance. More...

bool	AssignProperty (const BaseProperty &property)
	Assigns property to this BaseProperty instance. More...

Static Public Member Functions
static const char *	GetStaticNameOfClass ()

static Pointer	New ()

static Pointer	New (const char *_arg)

static Pointer	New (const std::string &_arg)

Static Public Member Functions inherited from mitk::BaseProperty
static const char *	GetStaticNameOfClass ()

Protected Types
typedef std::map< IndexValueType, std::string >	SliceMapType

typedef std::map< TimeStepType, SliceMapType >	TimeMapType

Protected Member Functions
	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

Protected Member Functions inherited from mitk::BaseProperty
	BaseProperty ()

	BaseProperty (const BaseProperty &other)

	~BaseProperty () override

Protected Attributes
TimeMapType	m_Values

Additional Inherited Members
Static Public Attributes inherited from mitk::BaseProperty
static const std::string	VALUE_CANNOT_BE_CONVERTED_TO_STRING
	Default return value if a property which can not be returned as string. More...

Detailed Description

Property for time and space resolved string values.

Definition at line 36 of file mitkTemporoSpatialStringProperty.h.

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer<const Self> mitk::TemporoSpatialStringProperty::ConstPointer

Definition at line 42 of file mitkTemporoSpatialStringProperty.h.

◆ IndexValueType

typedef ::itk::IndexValueType mitk::TemporoSpatialStringProperty::IndexValueType

Definition at line 39 of file mitkTemporoSpatialStringProperty.h.

◆ Pointer

typedef itk::SmartPointer<Self> mitk::TemporoSpatialStringProperty::Pointer

Definition at line 42 of file mitkTemporoSpatialStringProperty.h.

◆ Self

typedef TemporoSpatialStringProperty mitk::TemporoSpatialStringProperty::Self

Definition at line 42 of file mitkTemporoSpatialStringProperty.h.

◆ SliceMapType

typedef std::map<IndexValueType, std::string> mitk::TemporoSpatialStringProperty::SliceMapType

protected

Definition at line 96 of file mitkTemporoSpatialStringProperty.h.

◆ Superclass

typedef BaseProperty mitk::TemporoSpatialStringProperty::Superclass

Definition at line 42 of file mitkTemporoSpatialStringProperty.h.

◆ TimeMapType

typedef std::map<TimeStepType, SliceMapType> mitk::TemporoSpatialStringProperty::TimeMapType

protected

Definition at line 97 of file mitkTemporoSpatialStringProperty.h.

◆ ValueType

typedef std::string mitk::TemporoSpatialStringProperty::ValueType

Definition at line 40 of file mitkTemporoSpatialStringProperty.h.

Constructor & Destructor Documentation

◆ TemporoSpatialStringProperty() [1/3]

mitk::TemporoSpatialStringProperty::TemporoSpatialStringProperty ( const char * string = nullptr )

protected

◆ TemporoSpatialStringProperty() [2/3]

mitk::TemporoSpatialStringProperty::TemporoSpatialStringProperty ( const std::string & s )

protected

◆ TemporoSpatialStringProperty() [3/3]

mitk::TemporoSpatialStringProperty::TemporoSpatialStringProperty ( const TemporoSpatialStringProperty & )

protected

Member Function Documentation

◆ CheckValue()

std::pair<bool, ValueType> mitk::TemporoSpatialStringProperty::CheckValue	(	const TimeStepType &	timeStep,
		const IndexValueType &	zSlice,
		bool	allowCloseTime = `false`,
		bool	allowCloseSlice = `false`
	)		const

protected

◆ Clone()

Pointer mitk::TemporoSpatialStringProperty::Clone ( ) const

◆ FromJSON()

bool mitk::TemporoSpatialStringProperty::FromJSON ( const nlohmann::json & j )

overridevirtual

Deserialize property value(s) from JSON.

Rely on exceptions for error handling when implementing deserialization.

Returns: False if not deserializable by design, true otherwise.

Implements mitk::BaseProperty.

◆ GetAvailableSlices() [1/2]

std::vector<IndexValueType> mitk::TemporoSpatialStringProperty::GetAvailableSlices ( ) const

return all slices stored in the property.

Remarks: not all time steps may contain all slices.

◆ GetAvailableSlices() [2/2]

std::vector<IndexValueType> mitk::TemporoSpatialStringProperty::GetAvailableSlices ( const TimeStepType & timeStep ) const

return all slices stored for the specified timestep.

◆ GetAvailableTimeSteps() [1/2]

std::vector<TimeStepType> mitk::TemporoSpatialStringProperty::GetAvailableTimeSteps ( ) const

return all time steps stored in the property.

◆ GetAvailableTimeSteps() [2/2]

std::vector<TimeStepType> mitk::TemporoSpatialStringProperty::GetAvailableTimeSteps ( const IndexValueType & slice ) const

return all time steps stored for the specified slice.

◆ GetClassHierarchy()

virtual std::vector<std::string> mitk::TemporoSpatialStringProperty::GetClassHierarchy ( ) const

inlineoverridevirtual

Reimplemented from mitk::BaseProperty.

Definition at line 42 of file mitkTemporoSpatialStringProperty.h.

◆ GetClassName()

virtual const char* mitk::TemporoSpatialStringProperty::GetClassName ( ) const

virtual

Reimplemented from mitk::BaseProperty.

◆ GetStaticNameOfClass()

static const char* mitk::TemporoSpatialStringProperty::GetStaticNameOfClass ( )

inlinestatic

Definition at line 42 of file mitkTemporoSpatialStringProperty.h.

◆ GetValue() [1/2]

ValueType mitk::TemporoSpatialStringProperty::GetValue ( ) const

Returns the value of the first time point in the first slice. If now value is set it returns an empty string.

◆ GetValue() [2/2]

ValueType mitk::TemporoSpatialStringProperty::GetValue	(	const TimeStepType &	timeStep,
		const IndexValueType &	zSlice,
		bool	allowCloseTime = `false`,
		bool	allowCloseSlice = `false`
	)		const

Returns the value of the passed time step and slice. If it does not exist and allowedClosed is true it will look for the closest value. If nothing could be found an empty string will be returned.

◆ GetValueAsString()

std::string mitk::TemporoSpatialStringProperty::GetValueAsString ( ) const

overridevirtual

Reimplemented from mitk::BaseProperty.

◆ GetValueBySlice()

ValueType mitk::TemporoSpatialStringProperty::GetValueBySlice	(	const IndexValueType &	zSlice,
		bool	allowClose = `false`
	)		const

◆ GetValueByTimeStep()

ValueType mitk::TemporoSpatialStringProperty::GetValueByTimeStep	(	const TimeStepType &	timeStep,
		bool	allowClose = `false`
	)		const

◆ HasValue() [1/2]

bool mitk::TemporoSpatialStringProperty::HasValue ( ) const

◆ HasValue() [2/2]

bool mitk::TemporoSpatialStringProperty::HasValue	(	const TimeStepType &	timeStep,
		const IndexValueType &	zSlice,
		bool	allowCloseTime = `false`,
		bool	allowCloseSlice = `false`
	)		const

◆ HasValueBySlice()

bool mitk::TemporoSpatialStringProperty::HasValueBySlice	(	const IndexValueType &	zSlice,
		bool	allowClose = `false`
	)		const

◆ HasValueByTimeStep()

bool mitk::TemporoSpatialStringProperty::HasValueByTimeStep	(	const TimeStepType &	timeStep,
		bool	allowClose = `false`
	)		const

◆ IsUniform()

bool mitk::TemporoSpatialStringProperty::IsUniform ( ) const

Indicates of all values (all time steps, all slices) are the same, or if at least one value stored in the property is different. If IsUniform==true one can i.a. use GetValueAsString() without the loss of information to retrieve the stored value.

◆ New() [1/3]

static Pointer mitk::TemporoSpatialStringProperty::New ( )

static

◆ New() [2/3]

static Pointer mitk::TemporoSpatialStringProperty::New ( const char * _arg )

inlinestatic

Definition at line 47 of file mitkTemporoSpatialStringProperty.h.

◆ New() [3/3]

static Pointer mitk::TemporoSpatialStringProperty::New ( const std::string & _arg )

inlinestatic

Definition at line 48 of file mitkTemporoSpatialStringProperty.h.

◆ operator=()

BaseProperty& mitk::BaseProperty::operator=

Assigns property to this BaseProperty instance.

Subclasses must implement Assign(const BaseProperty&) and call the superclass Assign method for proper handling of polymorphic assignments. The assignment operator of the subclass should be disabled and the baseclass operator should be made visible using "using" statements.

◆ SetValue() [1/2]

void mitk::TemporoSpatialStringProperty::SetValue	(	const TimeStepType &	timeStep,
		const IndexValueType &	zSlice,
		const ValueType &	value
	)

◆ SetValue() [2/2]

void mitk::TemporoSpatialStringProperty::SetValue ( const ValueType & value )

◆ ToJSON()

bool mitk::TemporoSpatialStringProperty::ToJSON ( nlohmann::json & j ) const

overridevirtual

Serialize property value(s) to JSON.

Rely on exceptions for error handling when implementing serialization.

Returns: False if not serializable by design, true otherwise.

Implements mitk::BaseProperty.

Member Data Documentation

◆ m_Values

TimeMapType mitk::TemporoSpatialStringProperty::m_Values

protected

Definition at line 99 of file mitkTemporoSpatialStringProperty.h.

The documentation for this class was generated from the following file:

mitkTemporoSpatialStringProperty.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ConstPointer

◆ IndexValueType

◆ Pointer

◆ Self

◆ SliceMapType

◆ Superclass

◆ TimeMapType

◆ ValueType

Constructor & Destructor Documentation

◆ TemporoSpatialStringProperty() [1/3]

◆ TemporoSpatialStringProperty() [2/3]

◆ TemporoSpatialStringProperty() [3/3]

Member Function Documentation

◆ CheckValue()

◆ Clone()

◆ FromJSON()

◆ GetAvailableSlices() [1/2]

◆ GetAvailableSlices() [2/2]

◆ GetAvailableTimeSteps() [1/2]

◆ GetAvailableTimeSteps() [2/2]

◆ GetClassHierarchy()

◆ GetClassName()

◆ GetStaticNameOfClass()

◆ GetValue() [1/2]

◆ GetValue() [2/2]

◆ GetValueAsString()

◆ GetValueBySlice()

◆ GetValueByTimeStep()

◆ HasValue() [1/2]

◆ HasValue() [2/2]

◆ HasValueBySlice()

◆ HasValueByTimeStep()

◆ IsUniform()

◆ New() [1/3]

◆ New() [2/3]

◆ New() [3/3]

◆ operator=()

◆ SetValue() [1/2]

◆ SetValue() [2/2]

◆ ToJSON()

Member Data Documentation

◆ m_Values