Medical Imaging Interaction Toolkit  2018.4.99-bd7b41ba
Medical Imaging Interaction Toolkit
mitk::IPropertyAliases Class Referenceabstract

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 31 of file mitkIPropertyAliases.h.

Constructor & Destructor Documentation

◆ ~IPropertyAliases()

mitk::IPropertyAliases::~IPropertyAliases ( )
virtual

Definition at line 15 of file mitkIPropertyAliases.cpp.

Member Function Documentation

◆ AddAlias()

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]propertyNameName of the property.
[in]aliasAlias for the property.
[in]classNameOptional data node class name to which this alias is restricted.
Returns
False if alias is an empty string.

Implemented in mitk::PropertyAliases.

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

◆ GetAliases()

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]propertyNameName of the property.
[in]classNameOptional data node class name to which the returned aliases are restricted.
Returns
Aliases that match the input criteria.

Implemented in mitk::PropertyAliases.

Referenced by QmitkPropertyItemModel::setData().

◆ GetPropertyName()

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]aliasAlias of the property.
[in]classNameOptional 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.

◆ HasAliases()

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

Check if a specific property has aliases.

Parameters
[in]propertyNameName of the property.
[in]classNameOptional data node class name to which the aliases are restricted.
Returns
True if the property has aliases, false otherwise.

Implemented in mitk::PropertyAliases.

◆ RemoveAlias()

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]propertyNameName of the property.
[in]aliasAlias of the property.
[in]classNameOptional data node class name to which the alias is restricted.

Implemented in mitk::PropertyAliases.

◆ RemoveAliases()

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

Remove all aliases of a specific property.

Parameters
[in]propertyNameName of the property.
[in]classNameOptional data node class name to which the aliases are restricted.

Implemented in mitk::PropertyAliases.

◆ RemoveAllAliases()

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

Remove all aliases of all properties.

Parameters
[in]classNameOptional 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: