Medical Imaging Interaction Toolkit  2018.4.99-7e02155b
Medical Imaging Interaction Toolkit
mitk::IPropertyProvider Class Referenceabstract

#include <mitkIPropertyProvider.h>

Inheritance diagram for mitk::IPropertyProvider:

Public Member Functions

virtual ~IPropertyProvider ()
 
virtual BaseProperty::ConstPointer GetConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) const =0
 Get property by its key. More...
 
virtual std::vector< std::string > GetPropertyKeys (const std::string &contextName="", bool includeDefaultContext=false) const =0
 Query keys of existing properties. More...
 
virtual std::vector< std::string > GetPropertyContextNames () const =0
 Query names of existing contexts. More...
 

Detailed Description

Interface implemented by classes that provide access to property information.

Remarks
: This classes may not be the owner of the property, thus only grants const access to it. See IPropertyOwner for ownership.

Definition at line 24 of file mitkIPropertyProvider.h.

Constructor & Destructor Documentation

◆ ~IPropertyProvider()

virtual mitk::IPropertyProvider::~IPropertyProvider ( )
virtual

Member Function Documentation

◆ GetConstProperty()

virtual BaseProperty::ConstPointer mitk::IPropertyProvider::GetConstProperty ( const std::string &  propertyKey,
const std::string &  contextName = "",
bool  fallBackOnDefaultContext = true 
) const
pure virtual

Get property by its key.

Parameters
[in]propertyKeyKey of property.
[in]contextNameOptional, default is empty string (default context). Search in specified context.
[in]fallBackOnDefaultContextOptional, default is true. Also search in default context if property was not found in given context.
Returns
Found property, nullptr otherwise.

Implemented in mitk::DICOMImageBlockDescriptor, mitk::PropertyList, mitk::DataNode, and mitk::BaseData.

◆ GetPropertyContextNames()

virtual std::vector<std::string> mitk::IPropertyProvider::GetPropertyContextNames ( ) const
pure virtual

Query names of existing contexts.

Returns
List of context names.

Implemented in mitk::DICOMImageBlockDescriptor, mitk::PropertyList, mitk::DataNode, and mitk::BaseData.

◆ GetPropertyKeys()

virtual std::vector<std::string> mitk::IPropertyProvider::GetPropertyKeys ( const std::string &  contextName = "",
bool  includeDefaultContext = false 
) const
pure virtual

Query keys of existing properties.

Parameters
[in]contextNameOptional, default is empty string (default context). Search in specified context.
[in]includeDefaultContextOptional, default is false. Include default context.
Returns
List of property keys.

Implemented in mitk::DICOMImageBlockDescriptor, mitk::PropertyList, mitk::DataNode, and mitk::BaseData.


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