Medical Imaging Interaction Toolkit  2023.12.00
Medical Imaging Interaction Toolkit
mitk::PropertyExtensions Class Reference

#include <mitkPropertyExtensions.h>

Inheritance diagram for mitk::PropertyExtensions:
Collaboration diagram for mitk::PropertyExtensions:

Public Member Functions

 PropertyExtensions ()
 
 ~PropertyExtensions () override
 
bool AddExtension (const std::string &propertyName, PropertyExtension::Pointer extension, const std::string &className, bool overwrite) override
 Add an extension to a specific property. More...
 
PropertyExtension::Pointer GetExtension (const std::string &propertyName, const std::string &className) override
 Get the extension of a specific property. More...
 
bool HasExtension (const std::string &propertyName, const std::string &className) override
 Check if a specific property has an extension. More...
 
void RemoveAllExtensions (const std::string &className) override
 Remove all property extensions. More...
 
void RemoveExtension (const std::string &propertyName, const std::string &className) override
 Remove extension of a specific property. More...
 
- Public Member Functions inherited from mitk::IPropertyExtensions
virtual ~IPropertyExtensions ()
 

Detailed Description

Definition at line 21 of file mitkPropertyExtensions.h.

Constructor & Destructor Documentation

◆ PropertyExtensions()

mitk::PropertyExtensions::PropertyExtensions ( )

◆ ~PropertyExtensions()

mitk::PropertyExtensions::~PropertyExtensions ( )
override

Member Function Documentation

◆ AddExtension()

bool mitk::PropertyExtensions::AddExtension ( const std::string &  propertyName,
PropertyExtension::Pointer  extension,
const std::string &  className,
bool  overwrite 
)
overridevirtual

Add an extension to a specific property.

Parameters
[in]propertyNameName of the property.
[in]extensionProperty extension.
[in]classNameOptional data node class name to which the property extension is restricted.
[in]overwriteOverwrite already existing property extension.
Returns
True if extension was added successfully.

Implements mitk::IPropertyExtensions.

◆ GetExtension()

PropertyExtension::Pointer mitk::PropertyExtensions::GetExtension ( const std::string &  propertyName,
const std::string &  className 
)
overridevirtual

Get the extension of a specific property.

Parameters
[in]propertyNameName of the property.
[in]classNameOptional data node class name to which the returned property extension is restricted.
Returns
Property extension or null pointer if no extension was found.

Implements mitk::IPropertyExtensions.

◆ HasExtension()

bool mitk::PropertyExtensions::HasExtension ( const std::string &  propertyName,
const std::string &  className 
)
overridevirtual

Check if a specific property has an extension.

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

Implements mitk::IPropertyExtensions.

◆ RemoveAllExtensions()

void mitk::PropertyExtensions::RemoveAllExtensions ( const std::string &  className)
overridevirtual

Remove all property extensions.

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

Implements mitk::IPropertyExtensions.

◆ RemoveExtension()

void mitk::PropertyExtensions::RemoveExtension ( const std::string &  propertyName,
const std::string &  className 
)
overridevirtual

Remove extension of a specific property.

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

Implements mitk::IPropertyExtensions.


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