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

#include <mitkTemporoSpatialStringProperty.h>

Inheritance diagram for mitk::TemporoSpatialStringProperty:

Collaboration diagram for mitk::TemporoSpatialStringProperty:

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

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

void	SetValue (const ValueType &value)

virtual std::string	GetValueAsString () const override

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)

virtual	~BaseProperty ()

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 40 of file mitkTemporoSpatialStringProperty.h.

Member Typedef Documentation

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

Definition at line 46 of file mitkTemporoSpatialStringProperty.h.

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

Definition at line 43 of file mitkTemporoSpatialStringProperty.h.

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

Definition at line 46 of file mitkTemporoSpatialStringProperty.h.

typedef TemporoSpatialStringProperty mitk::TemporoSpatialStringProperty::Self

Definition at line 46 of file mitkTemporoSpatialStringProperty.h.

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

protected

Definition at line 83 of file mitkTemporoSpatialStringProperty.h.

typedef BaseProperty mitk::TemporoSpatialStringProperty::Superclass

Definition at line 46 of file mitkTemporoSpatialStringProperty.h.

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

protected

Definition at line 84 of file mitkTemporoSpatialStringProperty.h.

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

Definition at line 44 of file mitkTemporoSpatialStringProperty.h.

Constructor & Destructor Documentation

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

protected

Definition at line 32 of file mitkTemporoSpatialStringProperty.cpp.

References m_Values.

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

protected

Definition at line 42 of file mitkTemporoSpatialStringProperty.cpp.

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

protected

Definition at line 49 of file mitkTemporoSpatialStringProperty.cpp.

Member Function Documentation

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

protected

Definition at line 91 of file mitkTemporoSpatialStringProperty.cpp.

Pointer mitk::TemporoSpatialStringProperty::Clone ( ) const

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

Definition at line 176 of file mitkTemporoSpatialStringProperty.cpp.

Referenced by mitk::PropertyPersistenceSerialization::serializeTemporoSpatialStringPropertyToJSON().

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

Definition at line 195 of file mitkTemporoSpatialStringProperty.cpp.

Referenced by mitk::PropertyPersistenceSerialization::serializeTemporoSpatialStringPropertyToJSON().

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

inlineoverridevirtual

Reimplemented from mitk::BaseProperty.

Definition at line 46 of file mitkTemporoSpatialStringProperty.h.

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

virtual

Reimplemented from mitk::BaseProperty.

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

inlinestatic

Definition at line 46 of file mitkTemporoSpatialStringProperty.h.

mitk::TemporoSpatialStringProperty::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.

Definition at line 77 of file mitkTemporoSpatialStringProperty.cpp.

Referenced by mitk::PropertyPersistenceSerialization::serializeTemporoSpatialStringPropertyToJSON().

mitk::TemporoSpatialStringProperty::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.

Definition at line 133 of file mitkTemporoSpatialStringProperty.cpp.

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

overridevirtual

Reimplemented from mitk::BaseProperty.

Definition at line 65 of file mitkTemporoSpatialStringProperty.cpp.

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

Definition at line 141 of file mitkTemporoSpatialStringProperty.cpp.

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

Definition at line 147 of file mitkTemporoSpatialStringProperty.cpp.

bool mitk::TemporoSpatialStringProperty::HasValue ( ) const

Definition at line 153 of file mitkTemporoSpatialStringProperty.cpp.

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