Base class for objects that Listen to data storage, and want to update a node. More...

Inheritance diagram for niftk::DataStorageListener:

Collaboration diagram for niftk::DataStorageListener:

Public Member Functions
	mitkClassMacroItkParent (DataStorageListener, itk::LightObject) mitkNewMacro1Param(DataStorageListener

const mitk::DataStorage::Pointer mitk::DataStorage::Pointer	GetDataStorage () const
	Gets the data storage. More...

void	AddFilter (DataNodeFilter::Pointer filter)
	Adds a filter. More...

void	ClearFilters ()
	Clears all filters. More...

bool	IsBlocked () const
	Tells if the listener is blocked, i.e. the processing of signals is suppressed. More...

bool	SetBlocked (bool blocked)
	Blocks the processing of signals. This can be used to avoid eventual infinite recursion. Returns true if the listener was already blocked, otherwise false. More...

Public Attributes
mitk::Message1< mitk::DataNode * >	NodeAdded
	GUI independent message callback. More...

mitk::Message1< mitk::DataNode * >	NodeChanged

mitk::Message1< mitk::DataNode * >	NodeRemoved

mitk::Message1< mitk::DataNode * >	NodeDeleted

Protected Member Functions
	DataStorageListener (const mitk::DataStorage::Pointer)

virtual	~DataStorageListener ()

	DataStorageListener (const DataStorageListener &)

DataStorageListener &	operator= (const DataStorageListener &)

virtual void	OnNodeAdded (mitk::DataNode *node)
	Called when the given node is added to the data storage. Empty implementation, subclasses can redefine it. More...

virtual void	OnNodeChanged (mitk::DataNode *node)
	Called when the given node has been changed. Empty implementation, subclasses can redefine it. More...

virtual void	OnNodeRemoved (mitk::DataNode *node)
	Called when the given node is removed from the data storage. Empty implementation, subclasses can redefine it. More...

virtual void	OnNodeDeleted (mitk::DataNode *node)
	Called when the given node is deleted. Empty implementation, subclasses can redefine it. More...

bool	Pass (const mitk::DataNode *node) const
	Checks the node against the list of filters. More...

Detailed Description

Base class for objects that Listen to data storage, and want to update a node.

Derived classes must override NodeAdded, NodeUpdated, NodeRemoved, NodeDeleted. This class also provides a filter mechanism, where a chain of filters can be added, and if any one of the filters blocks, then the methods NodeAdded, NodeUpdated, NodeRemoved and NodeDeleted are not called.

Constructor & Destructor Documentation

niftk::DataStorageListener::DataStorageListener ( const mitk::DataStorage::Pointer dataStorage )

protected

niftk::DataStorageListener::~DataStorageListener ( )

protectedvirtual

niftk::DataStorageListener::DataStorageListener ( const DataStorageListener & )

protected

Member Function Documentation

void niftk::DataStorageListener::AddFilter ( DataNodeFilter::Pointer filter )

Adds a filter.

Parameters

filter A subclass of mitk::DataNodeFilter.

void niftk::DataStorageListener::ClearFilters ( )

Clears all filters.

mitk::DataStorage::Pointer niftk::DataStorageListener::GetDataStorage ( ) const

Gets the data storage.

bool niftk::DataStorageListener::IsBlocked ( ) const

Tells if the listener is blocked, i.e. the processing of signals is suppressed.

niftk::DataStorageListener::mitkClassMacroItkParent	(	DataStorageListener	,
		itk::LightObject
	)

void niftk::DataStorageListener::OnNodeAdded ( mitk::DataNode * node )

protectedvirtual

Called when the given node is added to the data storage. Empty implementation, subclasses can redefine it.

Reimplemented in niftk::MultiViewerVisibilityManager, niftk::DataNodePropertyListener, and niftk::DataNodeVisibilityTracker.

void niftk::DataStorageListener::OnNodeChanged ( mitk::DataNode * node )

protectedvirtual

Called when the given node has been changed. Empty implementation, subclasses can redefine it.

void niftk::DataStorageListener::OnNodeDeleted ( mitk::DataNode * node )

protectedvirtual

Called when the given node is deleted. Empty implementation, subclasses can redefine it.

Reimplemented in niftk::DataNodePropertyListener.

void niftk::DataStorageListener::OnNodeRemoved ( mitk::DataNode * node )

protectedvirtual

Called when the given node is removed from the data storage. Empty implementation, subclasses can redefine it.

Reimplemented in niftk::MultiViewerVisibilityManager, and niftk::DataNodePropertyListener.

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

protected

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

protected

Checks the node against the list of filters.

Parameters

node	A data node to check

Returns: true if the data node passess all filters and false otherwise.

bool niftk::DataStorageListener::SetBlocked ( bool blocked )

Blocks the processing of signals. This can be used to avoid eventual infinite recursion. Returns true if the listener was already blocked, otherwise false.

Member Data Documentation

mitk::Message1<mitk::DataNode*> niftk::DataStorageListener::NodeAdded

GUI independent message callback.

mitk::Message1<mitk::DataNode*> niftk::DataStorageListener::NodeChanged

mitk::Message1<mitk::DataNode*> niftk::DataStorageListener::NodeDeleted

mitk::Message1<mitk::DataNode*> niftk::DataStorageListener::NodeRemoved

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

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation