Medical Imaging Interaction Toolkit  2018.4.99-ef453c4b
Medical Imaging Interaction Toolkit
mitk::IPropertyFilters Class Referenceabstract

Interface of property filters service. More...

#include <mitkIPropertyFilters.h>

Inheritance diagram for mitk::IPropertyFilters:

Public Member Functions

virtual ~IPropertyFilters ()
 
virtual bool AddFilter (const PropertyFilter &filter, const std::string &className="", bool overwrite=false)=0
 Add a property filter. More...
 
virtual std::map< std::string, BaseProperty::PointerApplyFilter (const std::map< std::string, BaseProperty::Pointer > &propertyMap, const std::string &className="") const =0
 Apply property filter to property list. More...
 
virtual PropertyFilter GetFilter (const std::string &className="") const =0
 Get the current property filter. More...
 
virtual bool HasFilter (const std::string &className="") const =0
 Check if a specific data node class name has a property filter. More...
 
virtual void RemoveAllFilters ()=0
 Remove all property filters. More...
 
virtual void RemoveFilter (const std::string &className="")=0
 Remove property filter for a specific data node class name. More...
 

Detailed Description

Interface of property filters service.

This service allows you manage property name filters. A mitk::PropertyFilter consist of blacklist and whitelist entries and can be restricted to certain data node types. The property view only displays filtered properties if filters were found.

Definition at line 34 of file mitkIPropertyFilters.h.

Constructor & Destructor Documentation

◆ ~IPropertyFilters()

mitk::IPropertyFilters::~IPropertyFilters ( )
virtual

Definition at line 15 of file mitkIPropertyFilters.cpp.

Member Function Documentation

◆ AddFilter()

virtual bool mitk::IPropertyFilters::AddFilter ( const PropertyFilter filter,
const std::string &  className = "",
bool  overwrite = false 
)
pure virtual

Add a property filter.

Parameters
[in]filterThe property filter.
[in]classNameOptional data node class name to which the filter is restricted.
[in]overwriteOverwrite already existing filter.
Returns
True if filter was added auccessfully.

Implemented in mitk::PropertyFilters.

◆ ApplyFilter()

virtual std::map<std::string, BaseProperty::Pointer> mitk::IPropertyFilters::ApplyFilter ( const std::map< std::string, BaseProperty::Pointer > &  propertyMap,
const std::string &  className = "" 
) const
pure virtual

Apply property filter to property list.

Parameters
[in]propertyMapProperty list to which the filter is applied.
[in]classNameOptional data node class name for which the filter is chosen.
Returns
Filtered property list.

Implemented in mitk::PropertyFilters.

Referenced by QmitkPropertyItemModel::setData().

◆ GetFilter()

virtual PropertyFilter mitk::IPropertyFilters::GetFilter ( const std::string &  className = "") const
pure virtual

Get the current property filter.

Parameters
[in]classNameOptional data node class name for which the filter is returned.
Returns
The current property filter.

Implemented in mitk::PropertyFilters.

◆ HasFilter()

virtual bool mitk::IPropertyFilters::HasFilter ( const std::string &  className = "") const
pure virtual

Check if a specific data node class name has a property filter.

Parameters
[in]classNameThe data node class name or empty string for global property filter.
Returns
True if data node class name has a filter, false otherwise.

Implemented in mitk::PropertyFilters.

Referenced by QmitkPropertyItemModel::setData().

◆ RemoveAllFilters()

virtual void mitk::IPropertyFilters::RemoveAllFilters ( )
pure virtual

Remove all property filters.

Implemented in mitk::PropertyFilters.

◆ RemoveFilter()

virtual void mitk::IPropertyFilters::RemoveFilter ( const std::string &  className = "")
pure virtual

Remove property filter for a specific data node class name.

Parameters
[in]classNameThe data node class name or empty string for global property filter.

Implemented in mitk::PropertyFilters.


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