mitk::IPropertyFilters Class Reference

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::Pointer >	ApplyFilter (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()

virtual mitk::IPropertyFilters::~IPropertyFilters ( )

virtual

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]	filter	The property filter.
[in]	className	Optional data node class name to which the filter is restricted.
[in]	overwrite	Overwrite 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]	propertyMap	Property list to which the filter is applied.
[in]	className	Optional data node class name for which the filter is chosen.

Returns

Filtered property list.

Implemented in mitk::PropertyFilters.

GetFilter()

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

pure virtual

Get the current property filter.

Parameters

[in]

className

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

className

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

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]

className

The 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 file:

• mitkIPropertyFilters.h