niftk::DataNodeStringPropertyFilter Class Reference

A filter that takes a named property, for example "name", and a list of strings to check against, and compares the node to see if its property (eg "name") matches any of the supplied strings, and if it does match, will return Pass=false, otherwise Pass=true. More...

Inheritance diagram for niftk::DataNodeStringPropertyFilter:

Collaboration diagram for niftk::DataNodeStringPropertyFilter:

Public Member Functions
	mitkClassMacro (DataNodeStringPropertyFilter, DataNodeFilter) static Pointer New()
virtual void	SetPropertyName (std::string _arg)
	Sets the property name used for filtering. More...
virtual std::string	GetPropertyName ()
	Gets the property name used for filtering. More...
virtual bool	Pass (const mitk::DataNode *node) override
	Method to decide if the node should be passed. More...
virtual void	ClearList ()
	Clears the list of strings to match against. More...
virtual void	AddToList (const std::string &propertyValue)
	Add the supplied string to the list of strings to check against. More...
virtual void	AddToList (const std::vector< std::string > &listOfStrings)
	Adds a list of strings to the list of strings to check againts. More...

Protected Member Functions
	DataNodeStringPropertyFilter ()
virtual	~DataNodeStringPropertyFilter ()
	DataNodeStringPropertyFilter (const DataNodeStringPropertyFilter &)
DataNodeStringPropertyFilter &	operator= (const DataNodeStringPropertyFilter &)
Protected Member Functions inherited from niftk::DataNodeFilter
	DataNodeFilter ()
	Method to decide if the node should be passed. More...
virtual	~DataNodeFilter ()
	DataNodeFilter (const DataNodeFilter &)
DataNodeFilter &	operator= (const DataNodeFilter &)

Detailed Description

A filter that takes a named property, for example "name", and a list of strings to check against, and compares the node to see if its property (eg "name") matches any of the supplied strings, and if it does match, will return Pass=false, otherwise Pass=true.

Constructor & Destructor Documentation

niftk::DataNodeStringPropertyFilter::DataNodeStringPropertyFilter ( )

protected

niftk::DataNodeStringPropertyFilter::~DataNodeStringPropertyFilter ( )

protectedvirtual

niftk::DataNodeStringPropertyFilter::DataNodeStringPropertyFilter ( const DataNodeStringPropertyFilter &  )

protected

Member Function Documentation

void niftk::DataNodeStringPropertyFilter::AddToList ( const std::string &  propertyValue )

virtual

Add the supplied string to the list of strings to check against.

Parameters

proprtyValue

a string

void niftk::DataNodeStringPropertyFilter::AddToList ( const std::vector< std::string > &  listOfStrings )

virtual

Adds a list of strings to the list of strings to check againts.

Parameters

listOfStrings

a list of strings

void niftk::DataNodeStringPropertyFilter::ClearList ( )

virtual

Clears the list of strings to match against.

virtual std::string niftk::DataNodeStringPropertyFilter::GetPropertyName ( )

virtual

Gets the property name used for filtering.

niftk::DataNodeStringPropertyFilter::mitkClassMacro	(	DataNodeStringPropertyFilter	,
		DataNodeFilter
	)

DataNodeStringPropertyFilter& niftk::DataNodeStringPropertyFilter::operator= ( const DataNodeStringPropertyFilter &  )

protected

bool niftk::DataNodeStringPropertyFilter::Pass ( const mitk::DataNode *  node )

overridevirtual

Method to decide if the node should be passed.

Parameters

node	a candidate node

Returns

bool true if the node should pass and false otherwise.

virtual void niftk::DataNodeStringPropertyFilter::SetPropertyName ( std::string  _arg )

virtual

Sets the property name used for filtering.

---

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

• niftkDataNodeStringPropertyFilter.h
• niftkDataNodeStringPropertyFilter.cxx