mitk::PropertyFilter Class Reference

Consists of blacklist and whitelist entries. More...

#include <mitkPropertyFilter.h>

Public Types
enum	List { Blacklist, Whitelist }
	Specifies the type of a filter entry. More...

Public Member Functions
	PropertyFilter ()
	~PropertyFilter ()
	PropertyFilter (const PropertyFilter &other)
PropertyFilter &	operator= (PropertyFilter other)
void	AddEntry (const std::string &propertyName, List list)
	Add a filter entry for a specific property. More...
std::map< std::string, BaseProperty::Pointer >	Apply (const std::map< std::string, BaseProperty::Pointer > &propertyMap) const
	Apply the filter to a property list. More...
bool	HasEntry (const std::string &propertyName, List list) const
	Check if filter has specific entry. More...
bool	IsEmpty () const
	Check if filter is empty. More...
void	RemoveAllEntries (List list)
	Remove all entries from property filter. More...
void	RemoveEntry (const std::string &propertyName, List list)
	Remove specific entry from property filter. More...

Detailed Description

Consists of blacklist and whitelist entries.

Blacklist filtering is less restrictive than whitelist filtering since you can filter out individual property names. If whitelist entries were added, all other property names are filtered out. In addition, whitelist entries are reduced by blacklist entries.

Definition at line 30 of file mitkPropertyFilter.h.

Member Enumeration Documentation

List

enum mitk::PropertyFilter::List

Specifies the type of a filter entry.

Enumerator
Blacklist	Blacklisted filter entries are filtered out.
Whitelist	Whitelisted filter entries are the only entries that remain after filtering.

Definition at line 35 of file mitkPropertyFilter.h.

Constructor & Destructor Documentation

PropertyFilter() [1/2]

mitk::PropertyFilter::PropertyFilter

(

)

~PropertyFilter()

mitk::PropertyFilter::~PropertyFilter

(

)

PropertyFilter() [2/2]

mitk::PropertyFilter::PropertyFilter

(

const PropertyFilter &

other

)

Member Function Documentation

AddEntry()

void mitk::PropertyFilter::AddEntry	(	const std::string &	propertyName,
		List	list
	)

Add a filter entry for a specific property.

Parameters

[in]	propertyName	Name of the property.
[in]	list	Type of the filter entry.

Apply()

std::map<std::string, BaseProperty::Pointer> mitk::PropertyFilter::Apply

(

const std::map< std::string, BaseProperty::Pointer > &

propertyMap

)

const

Apply the filter to a property list.

Parameters

[in]

propertyMap

Property list to which the filter is applied.

Returns

Filtered property list.

HasEntry()

bool mitk::PropertyFilter::HasEntry	(	const std::string &	propertyName,
		List	list
	)		const

Check if filter has specific entry.

Parameters

[in]	propertyName	Name of the property.
[in]	list	Type of the filter entry.

Returns

True if property filter has specified entry, false otherwise.

IsEmpty()

bool mitk::PropertyFilter::IsEmpty

(

)

const

Check if filter is empty.

Returns

True if filter is empty, false otherwise.

operator=()

PropertyFilter& mitk::PropertyFilter::operator=

(

PropertyFilter

other

)

RemoveAllEntries()

void mitk::PropertyFilter::RemoveAllEntries

(

List

list

)

Remove all entries from property filter.

Parameters

[in]

list

Filter list from which all entries are removed.

RemoveEntry()

void mitk::PropertyFilter::RemoveEntry	(	const std::string &	propertyName,
		List	list
	)

Remove specific entry from property filter.

Parameters

[in]	propertyName	Name of property.
[in]	list	Filter list from which the entry is removed.

---

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

• mitkPropertyFilter.h