Medical Imaging Interaction Toolkit  2021.10.99-1c4db16f
Medical Imaging Interaction Toolkit
mitk::PropertyAliases Class Reference

#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 ( )

◆ ~PropertyAliases()

mitk::PropertyAliases::~PropertyAliases ( )
override

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]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.

Implements mitk::IPropertyAliases.

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

Implements mitk::IPropertyAliases.

◆ 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]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.

Implements mitk::IPropertyAliases.

◆ HasAliases()

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

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.

Implements mitk::IPropertyAliases.

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

Implements mitk::IPropertyAliases.

◆ RemoveAliases()

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

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.

Implements mitk::IPropertyAliases.

◆ RemoveAllAliases()

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

Remove all aliases of all properties.

Parameters
[in]classNameOptional data node class name to which the removal is restricted.

Implements mitk::IPropertyAliases.


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