mitk::PropertyDescriptions Class Reference

#include <mitkPropertyDescriptions.h>

Inheritance diagram for mitk::PropertyDescriptions:

Collaboration diagram for mitk::PropertyDescriptions:

Public Member Functions
	PropertyDescriptions ()
	~PropertyDescriptions () override
bool	AddDescription (const std::string &propertyName, const std::string &description, const std::string &className, bool overwrite) override
	Add a description for a specific property. More...
bool	AddDescriptionRegEx (const std::string &propertyRegEx, const std::string &description, const std::string &className, bool overwrite) override
	Add a description for all properties matching the property regular expression. More...
std::string	GetDescription (const std::string &propertyName, const std::string &className, bool overwrite) const override
	Get the description for a specific property. More...
bool	HasDescription (const std::string &propertyName, const std::string &className, bool overwrite) const override
	Check if a specific property has a description. More...
void	RemoveAllDescriptions (const std::string &className) override
	Remove all descriptions. More...
void	RemoveDescription (const std::string &propertyName, const std::string &className) override
	Remove description of specific property. More...
Public Member Functions inherited from mitk::IPropertyDescriptions
virtual	~IPropertyDescriptions ()

Detailed Description

Definition at line 21 of file mitkPropertyDescriptions.h.

Constructor & Destructor Documentation

PropertyDescriptions()

mitk::PropertyDescriptions::PropertyDescriptions

(

)

~PropertyDescriptions()

mitk::PropertyDescriptions::~PropertyDescriptions ( )

override

Member Function Documentation

AddDescription()

bool mitk::PropertyDescriptions::AddDescription ( const std::string &  propertyName, const std::string &  description, const std::string &  className, bool  overwrite  )

overridevirtual

Add a description for a specific property.

Parameters

[in]	propertyName	Name of the property.
[in]	description	Description of the property.
[in]	className	Optional data node class name to which this description is restricted.
[in]	overwrite	Overwrite already existing description.

Returns

True if description was added successfully.

Implements mitk::IPropertyDescriptions.

AddDescriptionRegEx()

bool mitk::PropertyDescriptions::AddDescriptionRegEx ( const std::string &  propertyRegEx, const std::string &  description, const std::string &  className, bool  overwrite  )

overridevirtual

Add a description for all properties matching the property regular expression.

Parameters

[in]	propertyRegEx	String of the regular expression specifying all relevant property names.
[in]	description	Description of the property.
[in]	className	Optional data node class name to which this description is restricted.
[in]	overwrite	Overwrite already existing description.

Returns

True if description was added successfully.

Implements mitk::IPropertyDescriptions.

GetDescription()

std::string mitk::PropertyDescriptions::GetDescription ( const std::string &  propertyName, const std::string &  className, bool  allowNameRegEx  ) const

overridevirtual

Get the description for a specific property.

Parameters

[in]	propertyName	Name of the property.
[in]	className	Optional data node class name to which the returned description is restricted.
[in]	allowNameRegEx	Indicates of also regular expressions should be regarded.

Returns

Property description or empty string if no description is available.

Implements mitk::IPropertyDescriptions.

HasDescription()

bool mitk::PropertyDescriptions::HasDescription ( const std::string &  propertyName, const std::string &  className, bool  allowNameRegEx  ) const

overridevirtual

Check if a specific property has a description.

Parameters

[in]	propertyName	Name of the property.
[in]	className	Optional data node class name to which this description is restricted.
[in]	allowNameRegEx	Indicates of also regular expressions should be regarded.

Returns

True if the property has a description, false otherwise.

Implements mitk::IPropertyDescriptions.

RemoveAllDescriptions()

void mitk::PropertyDescriptions::RemoveAllDescriptions ( const std::string &  className )

overridevirtual

Remove all descriptions.

Parameters

[in]

className

Optional data node class name to which this description is restricted.

Implements mitk::IPropertyDescriptions.

RemoveDescription()

void mitk::PropertyDescriptions::RemoveDescription ( const std::string &  propertyName, const std::string &  className  )

overridevirtual

Remove description of specific property.

Parameters

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

Implements mitk::IPropertyDescriptions.

---

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

• mitkPropertyDescriptions.h