mitk::TemporoSpatialStringProperty Class Reference

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)
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)
	~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 82 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 83 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

Definition at line 28 of file mitkTemporoSpatialStringProperty.cpp.

References m_Values.

TemporoSpatialStringProperty() [2/3]

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

protected

Definition at line 38 of file mitkTemporoSpatialStringProperty.cpp.

References m_Values.

TemporoSpatialStringProperty() [3/3]

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

protected

Definition at line 45 of file mitkTemporoSpatialStringProperty.cpp.

References m_Values.

Member Function Documentation

CheckValue()

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 87 of file mitkTemporoSpatialStringProperty.cpp.

References m_Values.

Referenced by GetValue(), and HasValue().

Clone()

Pointer mitk::TemporoSpatialStringProperty::Clone

(

)

const

GetAvailableSlices()

std::vector< mitk::TemporoSpatialStringProperty::IndexValueType > mitk::TemporoSpatialStringProperty::GetAvailableSlices

(

const TimeStepType &

timeStep

)

const

Definition at line 172 of file mitkTemporoSpatialStringProperty.cpp.

References m_Values.

GetAvailableTimeSteps()

std::vector< mitk::TimeStepType > mitk::TemporoSpatialStringProperty::GetAvailableTimeSteps

(

)

const

Definition at line 191 of file mitkTemporoSpatialStringProperty.cpp.

References m_Values.

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]

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 73 of file mitkTemporoSpatialStringProperty.cpp.

References m_Values.

Referenced by GetValueAsString(), GetValueBySlice(), GetValueByTimeStep(), mitk::CustomTagParser::ParseDicomProperty(), and mitk::DICOMSegmentationIO::Read().

GetValue() [2/2]

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 129 of file mitkTemporoSpatialStringProperty.cpp.

References CheckValue().

GetValueAsString()

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

overridevirtual

Reimplemented from mitk::BaseProperty.

Definition at line 61 of file mitkTemporoSpatialStringProperty.cpp.

References GetValue().

Referenced by mitk::DICOMSegmentationIO::Read().

GetValueBySlice()

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

Definition at line 137 of file mitkTemporoSpatialStringProperty.cpp.

References GetValue().

GetValueByTimeStep()

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

Definition at line 143 of file mitkTemporoSpatialStringProperty.cpp.

References GetValue().

HasValue() [1/2]

bool mitk::TemporoSpatialStringProperty::HasValue

(

)

const

Definition at line 149 of file mitkTemporoSpatialStringProperty.cpp.

References m_Values.

Referenced by HasValueBySlice(), and HasValueByTimeStep().

HasValue() [2/2]

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

Definition at line 154 of file mitkTemporoSpatialStringProperty.cpp.

References CheckValue().

HasValueBySlice()

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

Definition at line 162 of file mitkTemporoSpatialStringProperty.cpp.

References HasValue().

HasValueByTimeStep()

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

Definition at line 167 of file mitkTemporoSpatialStringProperty.cpp.

References HasValue().

New() [1/3]

static Pointer mitk::TemporoSpatialStringProperty::New ( )

static

Referenced by mitk::SourceImageRelationRule::CreateNewSourceImageSequenceItem(), mitk::DICOMPMPropertyHelper::DeriveDICOMPMProperties(), mitk::DICOMSegmentationPropertyHelper::DeriveDICOMSegmentationProperties(), mitk::DICOMQIPropertyHelper::DeriveDICOMSourceProperties(), mitk::PropertyPersistenceDeserialization::deserializeJSONToTemporoSpatialStringProperty(), mitk::GetDICOMPropertyForDICOMValuesFunctor(), mitk::DICOMSegmentationIO::Read(), mitk::DICOMSegmentationPropertyHelper::SetDICOMSegmentProperties(), and mitk::SetProperties().

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.

SetValue() [1/2]

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

Definition at line 203 of file mitkTemporoSpatialStringProperty.cpp.

References m_Values.

Referenced by SetValue().

SetValue() [2/2]

void mitk::TemporoSpatialStringProperty::SetValue

(

const ValueType &

value

)

Definition at line 222 of file mitkTemporoSpatialStringProperty.cpp.

References m_Values, and SetValue().

Member Data Documentation

m_Values

TimeMapType mitk::TemporoSpatialStringProperty::m_Values

protected

Definition at line 85 of file mitkTemporoSpatialStringProperty.h.

Referenced by CheckValue(), GetAvailableSlices(), GetAvailableTimeSteps(), GetValue(), HasValue(), SetValue(), and TemporoSpatialStringProperty().

---

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

• mitkTemporoSpatialStringProperty.h
• mitkTemporoSpatialStringProperty.cpp