mitk::IPropertyAliases Class Reference

Interface of property aliases service. More...

#include <mitkIPropertyAliases.h>

Inheritance diagram for mitk::IPropertyAliases:

Public Member Functions
virtual	~IPropertyAliases ()
virtual bool	AddAlias (const std::string &propertyName, const std::string &alias, const std::string &className="")=0
	Add an alias for a specific property. More...
virtual std::vector< std::string >	GetAliases (const std::string &propertyName, const std::string &className="")=0
	Get aliases for a specific property. More...
virtual std::string	GetPropertyName (const std::string &alias, const std::string &className="")=0
	Get property name that is associated to specific alias. More...
virtual bool	HasAliases (const std::string &propertyName, const std::string &className="")=0
	Check if a specific property has aliases. More...
virtual void	RemoveAlias (const std::string &propertyName, const std::string &alias, const std::string &className="")=0
	Remove specific alias of a certain property. More...
virtual void	RemoveAliases (const std::string &propertyName, const std::string &className="")=0
	Remove all aliases of a specific property. More...
virtual void	RemoveAllAliases (const std::string &className="")=0
	Remove all aliases of all properties. More...

Detailed Description

Interface of property aliases service.

This service allows you to manage aliases of property names. A property name can be mapped to more than one alias and aliases can be restricted to specific data node types. The property view prefers to display aliases instead of genuine property names.

Definition at line 35 of file mitkIPropertyAliases.h.

Constructor & Destructor Documentation

mitk::IPropertyAliases::~IPropertyAliases ( )

virtual

Definition at line 19 of file mitkIPropertyAliases.cpp.

Member Function Documentation

virtual bool mitk::IPropertyAliases::AddAlias ( const std::string &  propertyName, const std::string &  alias, const std::string &  className = ""  )

pure virtual

Add an alias for a specific property.

Parameters

[in]	propertyName	Name of the property.
[in]	alias	Alias for the property.
[in]	className	Optional data node class name to which this alias is restricted.

Returns

False if alias is an empty string.

Implemented in mitk::PropertyAliases.

Referenced by mitkPropertyAliasesTest(), mitk::PlaneGeometryDataMapper2D::SetDefaultProperties(), and mitk::SurfaceVtkMapper2D::SetDefaultProperties().

virtual std::vector<std::string> mitk::IPropertyAliases::GetAliases ( const std::string &  propertyName, const std::string &  className = ""  )

pure virtual

Get aliases for a specific property.

Parameters

[in]	propertyName	Name of the property.
[in]	className	Optional data node class name to which the returned aliases are restricted.

Returns

Aliases that match the input criteria.

Implemented in mitk::PropertyAliases.

Referenced by mitkPropertyAliasesTest().

virtual std::string mitk::IPropertyAliases::GetPropertyName ( const std::string &  alias, const std::string &  className = ""  )

pure virtual

Get property name that is associated to specific alias.

Parameters

[in]	alias	Alias of the property.
[in]	className	Optional data node class name to which the alias is restricted.

Returns

Associated property name or empty string if no property name was found.

Implemented in mitk::PropertyAliases.

Referenced by mitkPropertyAliasesTest().

virtual bool mitk::IPropertyAliases::HasAliases ( const std::string &  propertyName, const std::string &  className = ""  )

pure virtual

Check if a specific property has aliases.

Parameters

[in]	propertyName	Name of the property.
[in]	className	Optional data node class name to which the aliases are restricted.

Returns

True if the property has aliases, false otherwise.

Implemented in mitk::PropertyAliases.

virtual void mitk::IPropertyAliases::RemoveAlias ( const std::string &  propertyName, const std::string &  alias, const std::string &  className = ""  )

pure virtual

Remove specific alias of a certain property.

Parameters

[in]	propertyName	Name of the property.
[in]	alias	Alias of the property.
[in]	className	Optional data node class name to which the alias is restricted.

Implemented in mitk::PropertyAliases.

virtual void mitk::IPropertyAliases::RemoveAliases ( const std::string &  propertyName, const std::string &  className = ""  )

pure virtual

Remove all aliases of a specific property.

Parameters

[in]	propertyName	Name of the property.
[in]	className	Optional data node class name to which the aliases are restricted.

Implemented in mitk::PropertyAliases.

virtual void mitk::IPropertyAliases::RemoveAllAliases ( const std::string &  className = "" )

pure virtual

Remove all aliases of all properties.

Parameters

[in]

className

Optional data node class name to which the removal is restricted.

Implemented in mitk::PropertyAliases.

---

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

• mitkIPropertyAliases.h
• mitkIPropertyAliases.cpp