#include <mitkPropertyAliases.h>

Inheritance diagram for mitk::PropertyAliases:

Collaboration diagram for mitk::PropertyAliases:

Public Member Functions
	PropertyAliases ()

	~PropertyAliases () override

bool	AddAlias (const std::string &propertyName, const std::string &alias, const std::string &className) override
	Add an alias for a specific property. More...

std::vector< std::string >	GetAliases (const std::string &propertyName, const std::string &className) override
	Get aliases for a specific property. More...

std::string	GetPropertyName (const std::string &alias, const std::string &className) override
	Get property name that is associated to specific alias. More...

bool	HasAliases (const std::string &propertyName, const std::string &className) override
	Check if a specific property has aliases. More...

void	RemoveAlias (const std::string &propertyName, const std::string &alias, const std::string &className) override
	Remove specific alias of a certain property. More...

void	RemoveAliases (const std::string &propertyName, const std::string &className) override
	Remove all aliases of a specific property. More...

void	RemoveAllAliases (const std::string &className) override
	Remove all aliases of all properties. More...

Public Member Functions inherited from mitk::IPropertyAliases
virtual	~IPropertyAliases ()

Detailed Description

Definition at line 21 of file mitkPropertyAliases.h.

Constructor & Destructor Documentation

◆ PropertyAliases()

mitk::PropertyAliases::PropertyAliases ( )

Definition at line 35 of file mitkPropertyAliases.cpp.

◆ ~PropertyAliases()

mitk::PropertyAliases::~PropertyAliases ( )

override

Definition at line 39 of file mitkPropertyAliases.cpp.

Member Function Documentation

◆ AddAlias()

bool mitk::PropertyAliases::AddAlias	(	const std::string &	propertyName,
		const std::string &	alias,
		const std::string &	className
	)

overridevirtual

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.

Implements mitk::IPropertyAliases.

Definition at line 43 of file mitkPropertyAliases.cpp.

◆ GetAliases()

std::vector< std::string > mitk::PropertyAliases::GetAliases	(	const std::string &	propertyName,
		const std::string &	className
	)

overridevirtual

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.

Implements mitk::IPropertyAliases.

Definition at line 66 of file mitkPropertyAliases.cpp.

◆ GetPropertyName()

std::string mitk::PropertyAliases::GetPropertyName	(	const std::string &	alias,
		const std::string &	className
	)

overridevirtual

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.

Implements mitk::IPropertyAliases.

Definition at line 81 of file mitkPropertyAliases.cpp.

◆ HasAliases()

bool mitk::PropertyAliases::HasAliases	(	const std::string &	propertyName,
		const std::string &	className
	)

overridevirtual

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.

Implements mitk::IPropertyAliases.

Definition at line 95 of file mitkPropertyAliases.cpp.

◆ RemoveAlias()

void mitk::PropertyAliases::RemoveAlias	(	const std::string &	propertyName,
		const std::string &	alias,
		const std::string &	className
	)

overridevirtual

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.

Implements mitk::IPropertyAliases.

Definition at line 102 of file mitkPropertyAliases.cpp.

◆ RemoveAliases()

void mitk::PropertyAliases::RemoveAliases	(	const std::string &	propertyName,
		const std::string &	className
	)

overridevirtual

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.

Implements mitk::IPropertyAliases.

Definition at line 126 of file mitkPropertyAliases.cpp.

◆ RemoveAllAliases()

void mitk::PropertyAliases::RemoveAllAliases ( const std::string & className )

overridevirtual

Remove all aliases of all properties.

Parameters

[in] className Optional data node class name to which the removal is restricted.

Implements mitk::IPropertyAliases.

Definition at line 135 of file mitkPropertyAliases.cpp.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PropertyAliases()

◆ ~PropertyAliases()

Member Function Documentation

◆ AddAlias()

◆ GetAliases()

◆ GetPropertyName()

◆ HasAliases()

◆ RemoveAlias()

◆ RemoveAliases()

◆ RemoveAllAliases()