iAFilterRegistry Class Reference

Registry for image filters. More...

#include <iAFilterRegistry.h>

Static Public Member Functions
static bool	add (iAFilterCreateFuncPtr filterCreateFunc)
	Adds a given filter factory to the registry, which will be run with the default GUI runner.
static std::shared_ptr< iAFilter >	filter (QString const &name)
	Retrieve the filter with the given name.
static std::vector< iAFilterCreateFuncPtr > const &	filterFactories ()
	Retrieve a list of all currently registered filter (factories)
static int	filterID (QString const &name)
	Retrieve the ID of the filter with the given name If there is no such filter, -1 is returned.

Detailed Description

Registry for image filters.

Deriving a filter from iAAutoRegistration automatically registers the filter with this registry. All filters registered with these macros will be added to the Filter menu (in a submenu according to their Category(), the menu entry will have the filter name; the menu entry will be disabled until a dataset is loaded. When a dataset is loaded, clicking the menu entry will result in execution of the filter with the currently active window as input. The class is meant to be used statically (Follows the singleton pattern), the creation of objects of this class is thus prohibited.

Member Function Documentation

add()

bool iAFilterRegistry::add ( iAFilterCreateFuncPtr  filterCreateFunc )

static

Adds a given filter factory to the registry, which will be run with the default GUI runner.

Filters that derive from iAAutoRegistration for automatic registration do not need to explicitly call this function

filter()

std::shared_ptr< iAFilter > iAFilterRegistry::filter ( QString const &  name )

static

Retrieve the filter with the given name.

If there is no such filter, a "null" shared pointer is returned

filterFactories()

std::vector< iAFilterCreateFuncPtr > const & iAFilterRegistry::filterFactories ( )

static

Retrieve a list of all currently registered filter (factories)

filterID()

int iAFilterRegistry::filterID ( QString const &  name )

static

Retrieve the ID of the filter with the given name If there is no such filter, -1 is returned.

---

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

• libs/base/iAFilterRegistry.h
• libs/base/iAFilterRegistry.cpp