mitk::PropertyList Class Reference

Key-value list holding instances of BaseProperty. More...

#include <mitkPropertyList.h>

Inheritance diagram for mitk::PropertyList:

Collaboration diagram for mitk::PropertyList:

Public Types
typedef PropertyList	Self
typedef itk::Object	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
typedef std::map< std::string, BaseProperty::Pointer >	PropertyMap
typedef std::pair< std::string, BaseProperty::Pointer >	PropertyMapElementType

Public Member Functions
virtual std::vector< std::string >	GetClassHierarchy () const
virtual const char *	GetClassName () const
Pointer	Clone () const
mitk::BaseProperty *	GetProperty (const std::string &propertyKey) const
	Get a property by its name. More...
void	SetProperty (const std::string &propertyKey, BaseProperty *property)
	Set a property in the list/map by value. More...
void	ReplaceProperty (const std::string &propertyKey, BaseProperty *property)
	Set a property object in the list/map by reference. More...
void	ConcatenatePropertyList (PropertyList *pList, bool replace=false)
	Set a property object in the list/map by reference. More...
template<typename T >
bool	GetPropertyValue (const char *propertyKey, T &value) const
	Convenience access method for GenericProperty<T> properties (T being the type of the second parameter) More...
bool	GetBoolProperty (const char *propertyKey, bool &boolValue) const
	Convenience method to access the value of a BoolProperty. More...
bool	Get (const char *propertyKey, bool &boolValue) const
	ShortCut for the above method. More...
void	SetBoolProperty (const char *propertyKey, bool boolValue)
	Convenience method to set the value of a BoolProperty. More...
void	Set (const char *propertyKey, bool boolValue)
	ShortCut for the above method. More...
bool	GetIntProperty (const char *propertyKey, int &intValue) const
	Convenience method to access the value of an IntProperty. More...
bool	Get (const char *propertyKey, int &intValue) const
	ShortCut for the above method. More...
void	SetIntProperty (const char *propertyKey, int intValue)
	Convenience method to set the value of an IntProperty. More...
void	Set (const char *propertyKey, int intValue)
	ShortCut for the above method. More...
bool	GetFloatProperty (const char *propertyKey, float &floatValue) const
	Convenience method to access the value of a FloatProperty. More...
bool	Get (const char *propertyKey, float &floatValue) const
	ShortCut for the above method. More...
void	SetFloatProperty (const char *propertyKey, float floatValue)
	Convenience method to set the value of a FloatProperty. More...
void	Set (const char *propertyKey, float floatValue)
	ShortCut for the above method. More...
bool	GetDoubleProperty (const char *propertyKey, double &doubleValue) const
	Convenience method to access the value of a DoubleProperty. More...
bool	Get (const char *propertyKey, double &doubleValue) const
	ShortCut for the above method. More...
void	SetDoubleProperty (const char *propertyKey, double doubleValue)
	Convenience method to set the value of a DoubleProperty. More...
void	Set (const char *propertyKey, double doubleValue)
	ShortCut for the above method. More...
bool	GetStringProperty (const char *propertyKey, std::string &stringValue) const
	Convenience method to access the value of a StringProperty. More...
bool	Get (const char *propertyKey, std::string &stringValue) const
	ShortCut for the above method. More...
void	SetStringProperty (const char *propertyKey, const char *stringValue)
	Convenience method to set the value of a StringProperty. More...
void	Set (const char *propertyKey, const char *stringValue)
	ShortCut for the above method. More...
void	Set (const char *propertyKey, const std::string &stringValue)
	ShortCut for the above method. More...
virtual unsigned long	GetMTime () const override
	Get the timestamp of the last change of the map or the last change of one of the properties store in the list (whichever is later). More...
bool	DeleteProperty (const std::string &propertyKey)
	Remove a property from the list/map. More...
const PropertyMap *	GetMap () const
bool	IsEmpty () const
virtual void	Clear ()

Static Public Member Functions
static const char *	GetStaticNameOfClass ()
static Pointer	New ()

Protected Member Functions
	PropertyList ()
	PropertyList (const PropertyList &other)
virtual	~PropertyList ()

Protected Attributes
PropertyMap	m_Properties
	Map of properties. More...

Detailed Description

Key-value list holding instances of BaseProperty.

This list is meant to hold an arbitrary list of "properties", which should describe the object associated with this list.

Usually you will use PropertyList as part of a DataNode object - in this context the properties describe the data object held by the DataNode (e.g. whether the object is rendered at all, which color is used for rendering, what name should be displayed for the object, etc.)

The values in the list are not fixed, you may introduce any kind of property that seems useful - all you have to do is inherit from BaseProperty.

The list is organized as a key-value pairs, i.e.

• "name" : pointer to a StringProperty
• "visible" : pointer to a BoolProperty
• "color" : pointer to a ColorProperty
• "volume" : pointer to a FloatProperty

Please see the documentation of SetProperty and ReplaceProperty for two quite different semantics. Normally SetProperty is what you want - this method will try to change the value of an existing property and will not allow you to replace e.g. a ColorProperty with an IntProperty.

Definition at line 64 of file mitkPropertyList.h.

Member Typedef Documentation

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

Definition at line 67 of file mitkPropertyList.h.

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

Definition at line 67 of file mitkPropertyList.h.

typedef std::map<std::string, BaseProperty::Pointer> mitk::PropertyList::PropertyMap

Map structure to hold the properties: the map key is a string, the value consists of the actual property object (BaseProperty).

Definition at line 78 of file mitkPropertyList.h.

typedef std::pair<std::string, BaseProperty::Pointer> mitk::PropertyList::PropertyMapElementType

Definition at line 79 of file mitkPropertyList.h.

typedef PropertyList mitk::PropertyList::Self

Definition at line 67 of file mitkPropertyList.h.

typedef itk::Object mitk::PropertyList::Superclass

Definition at line 67 of file mitkPropertyList.h.

Constructor & Destructor Documentation

mitk::PropertyList::PropertyList ( )

protected

Definition at line 96 of file mitkPropertyList.cpp.

mitk::PropertyList::PropertyList ( const PropertyList &  other )

protected

Definition at line 100 of file mitkPropertyList.cpp.

References m_Properties.

mitk::PropertyList::~PropertyList ( )

protectedvirtual

Definition at line 108 of file mitkPropertyList.cpp.

Member Function Documentation

void mitk::PropertyList::Clear ( )

virtual

Definition at line 149 of file mitkPropertyList.cpp.

Referenced by mitk::SceneReaderV1::ClearNodePropertyListWithExceptions().

Pointer mitk::PropertyList::Clone

(

)

const

Referenced by mitk::LabelSet::AddLabel().

void mitk::PropertyList::ConcatenatePropertyList	(	PropertyList *	pList,
		bool	replace = false
	)

Set a property object in the list/map by reference.

Definition at line 167 of file mitkPropertyList.cpp.

References GetMap().

Referenced by mitk::SceneReaderV1::ClearNodePropertyListWithExceptions(), and mitk::DicomSeriesReader::LoadDicom().

bool mitk::PropertyList::DeleteProperty

(

const std::string &

propertyKey

)

Remove a property from the list/map.

Definition at line 135 of file mitkPropertyList.cpp.

Referenced by mitk::Gizmo::RemoveGizmoFromNode().

bool mitk::PropertyList::Get	(	const char *	propertyKey,
		bool &	boolValue
	)		const

ShortCut for the above method.

Definition at line 291 of file mitkPropertyList.cpp.

bool mitk::PropertyList::Get	(	const char *	propertyKey,
		int &	intValue
	)		const

ShortCut for the above method.

Definition at line 296 of file mitkPropertyList.cpp.

bool mitk::PropertyList::Get	(	const char *	propertyKey,
		float &	floatValue
	)		const

ShortCut for the above method.

Definition at line 301 of file mitkPropertyList.cpp.

bool mitk::PropertyList::Get	(	const char *	propertyKey,
		double &	doubleValue
	)		const

ShortCut for the above method.

Definition at line 306 of file mitkPropertyList.cpp.

bool mitk::PropertyList::Get	(	const char *	propertyKey,
		std::string &	stringValue
	)		const

ShortCut for the above method.

Definition at line 311 of file mitkPropertyList.cpp.

bool mitk::PropertyList::GetBoolProperty	(	const char *	propertyKey,
		bool &	boolValue
	)		const

Convenience method to access the value of a BoolProperty.

Definition at line 191 of file mitkPropertyList.cpp.

References mitk::GenericProperty< T >::GetValue().

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

inlinevirtual

Definition at line 67 of file mitkPropertyList.h.

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

virtual

bool mitk::PropertyList::GetDoubleProperty	(	const char *	propertyKey,
		double &	doubleValue
	)		const

Convenience method to access the value of a DoubleProperty.

Definition at line 316 of file mitkPropertyList.cpp.

References mitk::GenericProperty< T >::GetValue().

bool mitk::PropertyList::GetFloatProperty	(	const char *	propertyKey,
		float &	floatValue
	)		const

Convenience method to access the value of a FloatProperty.

Definition at line 217 of file mitkPropertyList.cpp.

References mitk::GenericProperty< T >::GetValue().

bool mitk::PropertyList::GetIntProperty	(	const char *	propertyKey,
		int &	intValue
	)		const

Convenience method to access the value of an IntProperty.

Definition at line 204 of file mitkPropertyList.cpp.

References mitk::GenericProperty< T >::GetValue().

const PropertyMap* mitk::PropertyList::GetMap ( ) const

inline

Definition at line 232 of file mitkPropertyList.h.

Referenced by mitk::DataStorageSelection::AddListener(), CheckAllPropertiesAreInOtherList(), ConcatenatePropertyList(), mitk::Equal(), mitk::DataStorage::GetGroupTags(), mitk::LabelSetIOHelper::GetLabelAsTiXmlElement(), mitk::GetPropertyByDICOMTagPath(), mitk::Label::Label(), QmitkPropertiesTableModel::Reset(), TestAllProperties(), and mitk::PropertyListsXmlFileReaderAndWriter::WriteLists().

unsigned long mitk::PropertyList::GetMTime ( ) const

overridevirtual

Get the timestamp of the last change of the map or the last change of one of the properties store in the list (whichever is later).

Consider the list as changed when any of the properties has changed recently.

Definition at line 116 of file mitkPropertyList.cpp.

Referenced by mitk::MITKRegistrationWrapperMapperBase::GenerateDataForRenderer(), mitk::RegEvaluationMapper2D::GenerateDataForRenderer(), mitk::ContourModelMapper2D::Update(), mitk::ContourModelMapper3D::Update(), mitk::ContourModelSetMapper3D::Update(), mitk::RegEvaluationMapper2D::Update(), mitk::ImageVtkMapper2D::Update(), mitk::DoseImageVtkMapper2D::Update(), and mitk::SurfaceVtkMapper2D::Update().

mitk::BaseProperty * mitk::PropertyList::GetProperty

(

const std::string &

propertyKey

)

const

Get a property by its name.

Definition at line 23 of file mitkPropertyList.cpp.

References m_Properties.

Referenced by mitk::SceneReaderV1::ClearNodePropertyListWithExceptions(), mitk::GetBackwardsCompatibleDICOMProperty(), mitk::Label::Label(), and mitk::PlaneGeometryDataVtkMapper3D::ProcessNode().

template<typename T >

bool mitk::PropertyList::GetPropertyValue ( const char *  propertyKey, T &  value  ) const

inline

Convenience access method for GenericProperty<T> properties (T being the type of the second parameter)

Returns

true property was found

Definition at line 116 of file mitkPropertyList.h.

References mitk::GenericProperty< T >::GetValue().

Referenced by mitk::NavigationDataDisplacementFilter::SetParameters(), and mitk::CameraVisualization::SetParameters().

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

inlinestatic

Definition at line 67 of file mitkPropertyList.h.

bool mitk::PropertyList::GetStringProperty	(	const char *	propertyKey,
		std::string &	stringValue
	)		const

Convenience method to access the value of a StringProperty.

Definition at line 230 of file mitkPropertyList.cpp.

References mitk::StringProperty::GetValue().

Referenced by mitk::GetBackwardsCompatibleDICOMProperty().

bool mitk::PropertyList::IsEmpty ( ) const

inline

Definition at line 233 of file mitkPropertyList.h.

Referenced by mitk::SceneIO::SaveScene().

static Pointer mitk::PropertyList::New ( )

static

Method for creation through the object factory.

Referenced by mitk::Action::AddProperty(), mitk::BaseData::BaseData(), mitk::SceneReaderV1::ClearNodePropertyListWithExceptions(), mitk::DataNode::DataNode(), mitk::PropertyListDeserializerV1::Deserialize(), mitk::NavigationDataDisplacementFilter::GetParameters(), mitk::CameraVisualization::GetParameters(), mitk::NavigationDataSource::GetParameters(), mitk::IGTLMessageSource::GetParameters(), mitk::PersistenceService::GetPropertyList(), mitk::Overlay::GetPropertyList(), mitk::DataNode::GetPropertyList(), mitk::RenderingManager::InitializePropertyList(), mitkBaseDataTest(), mitkDCMPreloadedVolumeTest(), mitkDICOMPreloadedVolumeTest(), mitkEventConfigTest(), mitkPropertyListTest(), mitkPropertySerializationTest(), mitk::NonBlockingAlgorithm::NonBlockingAlgorithm(), mitk::StateMachineTransition::operator==(), mitk::Overlay::Overlay(), QmitkOverlayController::QmitkOverlayController(), mitk::PropertyListsXmlFileReaderAndWriter::ReadLists(), mitk::SceneIO::SaveScene(), mitk::PropertyListSerializer::Serialize(), mitk::XML2EventParser::StartElement(), mitk::StateMachineTransition::StateMachineTransition(), and mitk::ToFCameraDevice::ToFCameraDevice().

void mitk::PropertyList::ReplaceProperty	(	const std::string &	propertyKey,
		BaseProperty *	property
	)

Set a property object in the list/map by reference.

The actual OBJECT holding the value of the property is replaced by this function. This is useful if you want to change the type of the property, like from BoolProperty to StringProperty. Another use is to share one and the same property object among several ProperyList/DataNode objects, which makes them appear synchronized.

Definition at line 77 of file mitkPropertyList.cpp.

void mitk::PropertyList::Set	(	const char *	propertyKey,
		bool	boolValue
	)

ShortCut for the above method.

Definition at line 261 of file mitkPropertyList.cpp.

void mitk::PropertyList::Set	(	const char *	propertyKey,
		int	intValue
	)

ShortCut for the above method.

Definition at line 266 of file mitkPropertyList.cpp.

void mitk::PropertyList::Set	(	const char *	propertyKey,
		float	floatValue
	)

ShortCut for the above method.

Definition at line 271 of file mitkPropertyList.cpp.

void mitk::PropertyList::Set	(	const char *	propertyKey,
		double	doubleValue
	)

ShortCut for the above method.

Definition at line 276 of file mitkPropertyList.cpp.

void mitk::PropertyList::Set	(	const char *	propertyKey,
		const char *	stringValue
	)

ShortCut for the above method.

Definition at line 281 of file mitkPropertyList.cpp.

void mitk::PropertyList::Set	(	const char *	propertyKey,
		const std::string &	stringValue
	)

ShortCut for the above method.

Definition at line 286 of file mitkPropertyList.cpp.

void mitk::PropertyList::SetBoolProperty	(	const char *	propertyKey,
		bool	boolValue
	)

Convenience method to set the value of a BoolProperty.

Definition at line 246 of file mitkPropertyList.cpp.

References mitk::BoolProperty::New().

void mitk::PropertyList::SetDoubleProperty	(	const char *	propertyKey,
		double	doubleValue
	)

Convenience method to set the value of a DoubleProperty.

Definition at line 327 of file mitkPropertyList.cpp.

References mitk::DoubleProperty::New().

void mitk::PropertyList::SetFloatProperty	(	const char *	propertyKey,
		float	floatValue
	)

Convenience method to set the value of a FloatProperty.

Definition at line 251 of file mitkPropertyList.cpp.

References mitk::FloatProperty::New().

void mitk::PropertyList::SetIntProperty	(	const char *	propertyKey,
		int	intValue
	)

Convenience method to set the value of an IntProperty.

Definition at line 241 of file mitkPropertyList.cpp.

References mitk::IntProperty::New().

void mitk::PropertyList::SetProperty	(	const std::string &	propertyKey,
		BaseProperty *	property
	)

Set a property in the list/map by value.

The actual OBJECT holding the value of the property is not replaced, but its value is modified to match that of property. To really replace the object holding the property - which would make sense if you want to change the type (bool, string) of the property

• call ReplaceProperty.

Definition at line 34 of file mitkPropertyList.cpp.

References MITK_ERROR.

Referenced by QmitkBSplineRegistrationView::CalculateTransformation().

void mitk::PropertyList::SetStringProperty	(	const char *	propertyKey,
		const char *	stringValue
	)

Convenience method to set the value of a StringProperty.

Definition at line 256 of file mitkPropertyList.cpp.

References mitk::StringProperty::New().

Member Data Documentation

PropertyMap mitk::PropertyList::m_Properties

protected

Map of properties.

Definition at line 245 of file mitkPropertyList.h.

Referenced by GetProperty(), and PropertyList().

---

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

• mitkPropertyList.h
• mitkPropertyList.cpp