mitk::PropertyFilters Class Reference

#include <mitkPropertyFilters.h>

Inheritance diagram for mitk::PropertyFilters:

Collaboration diagram for mitk::PropertyFilters:

Public Member Functions
	PropertyFilters ()
	~PropertyFilters () override
bool	AddFilter (const PropertyFilter &filter, const std::string &className, bool overwrite) override
	Add a property filter. More...
std::map< std::string, BaseProperty::Pointer >	ApplyFilter (const std::map< std::string, BaseProperty::Pointer > &propertyMap, const std::string &className) const override
	Apply property filter to property list. More...
PropertyFilter	GetFilter (const std::string &className) const override
	Get the current property filter. More...
bool	HasFilter (const std::string &className) const override
	Check if a specific data node class name has a property filter. More...
void	RemoveAllFilters () override
	Remove all property filters. More...
void	RemoveFilter (const std::string &className) override
	Remove property filter for a specific data node class name. More...
Public Member Functions inherited from mitk::IPropertyFilters
virtual	~IPropertyFilters ()

Detailed Description

Definition at line 21 of file mitkPropertyFilters.h.

Constructor & Destructor Documentation

PropertyFilters()

mitk::PropertyFilters::PropertyFilters

(

)

Definition at line 17 of file mitkPropertyFilters.cpp.

~PropertyFilters()

mitk::PropertyFilters::~PropertyFilters ( )

override

Definition at line 21 of file mitkPropertyFilters.cpp.

Member Function Documentation

AddFilter()

bool mitk::PropertyFilters::AddFilter ( const PropertyFilter &  filter, const std::string &  className, bool  overwrite  )

overridevirtual

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.

Implements mitk::IPropertyFilters.

Definition at line 25 of file mitkPropertyFilters.cpp.

References mitk::PropertyFilter::IsEmpty().

ApplyFilter()

std::map< std::string, mitk::BaseProperty::Pointer > mitk::PropertyFilters::ApplyFilter ( const std::map< std::string, BaseProperty::Pointer > &  propertyMap, const std::string &  className  ) const

overridevirtual

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.

Implements mitk::IPropertyFilters.

Definition at line 44 of file mitkPropertyFilters.cpp.

References mitk::PropertyFilter::Apply(), GetFilter(), and mitk::PropertyFilter::IsEmpty().

GetFilter()

mitk::PropertyFilter mitk::PropertyFilters::GetFilter ( const std::string &  className ) const

overridevirtual

Get the current property filter.

Parameters

[in]

className

Optional data node class name for which the filter is returned.

Returns

The current property filter.

Implements mitk::IPropertyFilters.

Definition at line 64 of file mitkPropertyFilters.cpp.

Referenced by ApplyFilter().

HasFilter()

bool mitk::PropertyFilters::HasFilter ( const std::string &  className ) const

overridevirtual

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.

Implements mitk::IPropertyFilters.

Definition at line 74 of file mitkPropertyFilters.cpp.

RemoveAllFilters()

void mitk::PropertyFilters::RemoveAllFilters ( )

overridevirtual

Remove all property filters.

Implements mitk::IPropertyFilters.

Definition at line 79 of file mitkPropertyFilters.cpp.

RemoveFilter()

void mitk::PropertyFilters::RemoveFilter ( const std::string &  className )

overridevirtual

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.

Implements mitk::IPropertyFilters.

Definition at line 84 of file mitkPropertyFilters.cpp.

---

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

• mitkPropertyFilters.h
• mitkPropertyFilters.cpp