Navigation Data source. More...

#include <mitkNavigationDataSource.h>

Inheritance diagram for mitk::NavigationDataSource:

Collaboration diagram for mitk::NavigationDataSource:

Public Member Functions
	mitkClassMacroItkParent (NavigationDataSource, itk::ProcessObject)

virtual std::string	GetName ()

virtual void	SetName (std::string _arg)
	Sets the human readable name of this source. There is also a default name, but you can use this method if you need to define it on your own. More...

NavigationData *	GetOutput (void)
	return the output (output with id 0) of the filter More...

NavigationData *	GetOutput (DataObjectPointerArraySizeType idx)
	return the output with id idx of the filter More...

NavigationData *	GetOutput (const std::string &navDataName)
	return the output with name navDataName of the filter More...

DataObjectPointerArraySizeType	GetOutputIndex (std::string navDataName)
	return the index of the output with name navDataName, -1 if no output with that name was found More...

virtual void	RegisterAsMicroservice ()
	Registers this object as a Microservice, making it available to every module and/or plugin. To unregister, call UnregisterMicroservice(). More...

virtual void	UnRegisterMicroservice ()
	Registers this object as a Microservice, making it available to every module and/or plugin. More...

std::string	GetMicroserviceID ()
	Returns the id that this device is registered with. The id will only be valid, if the NavigationDataSource has been registered using RegisterAsMicroservice(). More...

virtual void	GraftNthOutput (unsigned int idx, itk::DataObject *graft)
	Graft the specified DataObject onto this ProcessObject's output. More...

virtual void	GraftOutput (itk::DataObject *graft)
	Graft the specified DataObject onto this ProcessObject's output. More...

virtual itk::DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType idx) override

virtual itk::DataObject::Pointer	MakeOutput (const DataObjectIdentifierType &name) override

virtual void	SetParameters (const mitk::PropertyList *)
	Set all filter parameters as the PropertyList p. More...

virtual mitk::PropertyList::ConstPointer	GetParameters () const
	Get all filter parameters as a PropertyList. More...

virtual void	Freeze ()

virtual void	UnFreeze ()

virtual bool	GetIsFrozen ()

Static Public Attributes
static const std::string	US_INTERFACE_NAME
	These Constants are used in conjunction with Microservices. More...

static const std::string	US_PROPKEY_DEVICENAME

static const std::string	US_PROPKEY_ID

static const std::string	US_PROPKEY_ISACTIVE

Protected Member Functions
	NavigationDataSource ()

virtual	~NavigationDataSource ()

Protected Attributes
std::string	m_Name

bool	m_IsFrozen

Detailed Description

Navigation Data source.

Documentation Base class for all navigation filters that produce NavigationData objects as output. This class defines the output-interface for NavigationDataFilters.

Warning: : if Update() is called on any output object, all NavigationData filters will generate new output data for all outputs, not just the one on which Update() was called.

Definition at line 42 of file mitkNavigationDataSource.h.

Constructor & Destructor Documentation

mitk::NavigationDataSource::NavigationDataSource ( )

protected

Definition at line 32 of file mitkNavigationDataSource.cpp.

mitk::NavigationDataSource::~NavigationDataSource ( )

protectedvirtual

Definition at line 37 of file mitkNavigationDataSource.cpp.

Member Function Documentation

void mitk::NavigationDataSource::Freeze ( )

virtual

Freezes the navigation data source which means the current state is frozen and the output navigation data stays at it is. Calling Update() does not have any effect until UnFreeze() is called. This also means that the data source is not updated any more.

Definition at line 148 of file mitkNavigationDataSource.cpp.

virtual bool mitk::NavigationDataSource::GetIsFrozen ( )

virtual

Returns: Returns whether the data source is currently frozen.

std::string mitk::NavigationDataSource::GetMicroserviceID ( )

Returns the id that this device is registered with. The id will only be valid, if the NavigationDataSource has been registered using RegisterAsMicroservice().

Definition at line 94 of file mitkNavigationDataSource.cpp.

virtual std::string mitk::NavigationDataSource::GetName ( )

virtual

Returns: Returns a human readable name of this source. There will be a default name, or you can set the name with the method SetName() if you want to change it.

mitk::NavigationData * mitk::NavigationDataSource::GetOutput ( void )

return the output (output with id 0) of the filter

Definition at line 41 of file mitkNavigationDataSource.cpp.

Referenced by mitk::NavigationDataToNavigationDataFilter::ConnectTo(), and mitk::NavigationDataToIGTLMessageFilter::ConnectTo().

mitk::NavigationData * mitk::NavigationDataSource::GetOutput ( DataObjectPointerArraySizeType idx )

return the output with id idx of the filter

Definition at line 49 of file mitkNavigationDataSource.cpp.

mitk::NavigationData * mitk::NavigationDataSource::GetOutput ( const std::string & navDataName )

return the output with name navDataName of the filter

Definition at line 59 of file mitkNavigationDataSource.cpp.

itk::ProcessObject::DataObjectPointerArraySizeType mitk::NavigationDataSource::GetOutputIndex ( std::string navDataName )

return the index of the output with name navDataName, -1 if no output with that name was found

Warning: if a subclass has outputs that have different data type than mitk::NavigationData, they have to overwrite this method

Definition at line 68 of file mitkNavigationDataSource.cpp.

mitk::PropertyList::ConstPointer mitk::NavigationDataSource::GetParameters ( ) const

virtual

Get all filter parameters as a PropertyList.

This method allows to get all parameters of a filter with one method call. The returned PropertyList must be assigned to a SmartPointer immediately, or else it will get destroyed. Every filter must overwrite this method to create a filter-specific PropertyList. Note that property names must be unique over all MITK-IGT filters. Therefore each filter should use its name as a prefix for each property name. Secondly, each filter should list the property names and data types in the method documentation.

Reimplemented in mitk::CameraVisualization, and mitk::NavigationDataDisplacementFilter.

Definition at line 140 of file mitkNavigationDataSource.cpp.

References mitk::PropertyList::New().

void mitk::NavigationDataSource::GraftNthOutput	(	unsigned int	idx,
		itk::DataObject *	graft
	)

virtual

Graft the specified DataObject onto this ProcessObject's output.

See itk::ImageSource::GraftNthOutput for details

Definition at line 103 of file mitkNavigationDataSource.cpp.

void mitk::NavigationDataSource::GraftOutput ( itk::DataObject * graft )

virtual

Graft the specified DataObject onto this ProcessObject's output.

See itk::ImageSource::Graft Output for details

Definition at line 98 of file mitkNavigationDataSource.cpp.

itk::DataObject::Pointer mitk::NavigationDataSource::MakeOutput ( DataObjectPointerArraySizeType idx )

overridevirtual

Allocates a new output object and returns it. Currently the index idx is not evaluated.

Parameters

idx	the index of the output for which an object should be created

Returns: the new object

Definition at line 125 of file mitkNavigationDataSource.cpp.

References mitk::NavigationData::New().

itk::DataObject::Pointer mitk::NavigationDataSource::MakeOutput ( const DataObjectIdentifierType & name )

overridevirtual

This is a default implementation to make sure we have something. Once all the subclasses of ProcessObject provide an appopriate MakeOutput(), then ProcessObject::MakeOutput() can be made pure virtual.

Definition at line 130 of file mitkNavigationDataSource.cpp.

References mitk::NavigationData::New().

mitk::NavigationDataSource::mitkClassMacroItkParent	(	NavigationDataSource	,
		itk::ProcessObject
	)

void mitk::NavigationDataSource::RegisterAsMicroservice ( )

virtual

Registers this object as a Microservice, making it available to every module and/or plugin. To unregister, call UnregisterMicroservice().

Definition at line 77 of file mitkNavigationDataSource.cpp.

References us::GetModuleContext(), and mitk::UIDGenerator::GetUID().

virtual void mitk::NavigationDataSource::SetName ( std::string _arg )

virtual

Sets the human readable name of this source. There is also a default name, but you can use this method if you need to define it on your own.

Referenced by mitk::NavigationDataPlayerBase::NavigationDataPlayerBase().

virtual void mitk::NavigationDataSource::SetParameters ( const mitk::PropertyList * )

inlinevirtual

Set all filter parameters as the PropertyList p.

This method allows to set all parameters of a filter with one method call. For the names of the parameters, take a look at the GetParameters method of the filter This method has to be overwritten by each MITK-IGT filter.

Reimplemented in mitk::CameraVisualization, and mitk::NavigationDataDisplacementFilter.

Definition at line 142 of file mitkNavigationDataSource.h.

void mitk::NavigationDataSource::UnFreeze ( )

virtual

Unfreezes the data source.

Definition at line 153 of file mitkNavigationDataSource.cpp.

void mitk::NavigationDataSource::UnRegisterMicroservice ( )

virtual

Registers this object as a Microservice, making it available to every module and/or plugin.

Definition at line 89 of file mitkNavigationDataSource.cpp.