Base class for using mitk::NavigationData as a filter source. Subclasses can play objects of mitk::NavigationDataSet. More...

#include <mitkNavigationDataPlayerBase.h>

Inheritance diagram for mitk::NavigationDataPlayerBase:

Public Member Functions
	mitkClassMacro (NavigationDataPlayerBase, NavigationDataSource)

	itkSetMacro (Repeat, bool)
	Set to true if the data player should repeat the outputs.

	itkGetMacro (Repeat, bool)

void	UpdateOutputInformation () override
	Used for pipeline update just to tell the pipeline that we always have to update.

	itkGetMacro (NavigationDataSet, NavigationDataSet::Pointer)

void	SetNavigationDataSet (NavigationDataSet::Pointer navigationDataSet)
	Set mitk::NavigationDataSet for playing. Player is initialized by call to mitk::NavigationDataPlayerBase::InitPlayer() inside this method. Method must be called before this object can be used as a filter source.

unsigned int	GetNumberOfSnapshots ()
	Getter for the size of the mitk::NavigationDataSet used in this object.

unsigned int	GetCurrentSnapshotNumber ()

bool	IsAtEnd ()
	This method checks if player arrived at end of file.

Public Member Functions inherited from mitk::NavigationDataSource
	mitkClassMacroItkParent (NavigationDataSource, itk::ProcessObject)

	itkGetMacro (Name, std::string)

	itkSetMacro (Name, std::string)
	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.

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

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

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

NavigationTool::Pointer	GetToolMetaData (DataObjectPointerArraySizeType idx)

NavigationTool::Pointer	GetToolMetaData (const std::string &navDataName)

	itkGetMacro (ToolMetaDataCollection, mitk::NavigationToolStorage::Pointer)

	itkSetMacro (ToolMetaDataCollection, mitk::NavigationToolStorage::Pointer)

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

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

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

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().

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

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

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

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

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

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

virtual void	Freeze ()

virtual void	UnFreeze ()

	itkGetMacro (IsFrozen, bool)

Protected Member Functions
	NavigationDataPlayerBase ()

	~NavigationDataPlayerBase () override

void	GenerateData () override=0
	Every subclass hast to implement this method. See ITK filter documentation for details.

void	InitPlayer ()
	Initializes the outputs of this NavigationDataSource. Aftwer calling this method, the first Navigationdata from the loaded Navigationdataset is loaded into the outputs.

void	GraftEmptyOutput ()
	Convenience method for subclasses. When there are no further mitk::NavigationData objects available, this method can be called in the implementation of mitk::NavigationDataPlayerBase::GenerateData().

Protected Member Functions inherited from mitk::NavigationDataSource
	NavigationDataSource ()

	~NavigationDataSource () override

Protected Attributes
bool	m_Repeat
	If the player should repeat outputs. Default is false.

NavigationDataSet::Pointer	m_NavigationDataSet

mitk::NavigationDataSet::NavigationDataSetConstIterator	m_NavigationDataSetIterator
	Iterator always points to the NavigationData object which is in the outputs at the moment.

Protected Attributes inherited from mitk::NavigationDataSource
std::string	m_Name

bool	m_IsFrozen

NavigationToolStorage::Pointer	m_ToolMetaDataCollection

Additional Inherited Members
Static Public Attributes inherited from mitk::NavigationDataSource
static const std::string	US_INTERFACE_NAME = "org.mitk.services.NavigationDataSource"
	These Constants are used in conjunction with Microservices.

static const std::string	US_PROPKEY_DEVICENAME = US_INTERFACE_NAME + ".devicename"

static const std::string	US_PROPKEY_ID = US_INTERFACE_NAME + ".id"

static const std::string	US_PROPKEY_ISACTIVE = US_INTERFACE_NAME + ".isActive"

Detailed Description

Base class for using mitk::NavigationData as a filter source. Subclasses can play objects of mitk::NavigationDataSet.

Each subclass has to check the state of m_Repeat and do or do not repeat the playing accordingly.

Definition at line 29 of file mitkNavigationDataPlayerBase.h.

Constructor & Destructor Documentation

◆ NavigationDataPlayerBase()

mitk::NavigationDataPlayerBase::NavigationDataPlayerBase ( )

protected

Definition at line 18 of file mitkNavigationDataPlayerBase.cpp.

◆ ~NavigationDataPlayerBase()

mitk::NavigationDataPlayerBase::~NavigationDataPlayerBase ( )

overrideprotected

Definition at line 24 of file mitkNavigationDataPlayerBase.cpp.

Member Function Documentation

◆ GenerateData()

void mitk::NavigationDataPlayerBase::GenerateData ( )

overrideprotectedpure virtual

Every subclass hast to implement this method. See ITK filter documentation for details.

Implemented in mitk::NavigationDataCSVSequentialPlayer, mitk::NavigationDataPlayer, and mitk::NavigationDataSequentialPlayer.

◆ GetCurrentSnapshotNumber()

unsigned int mitk::NavigationDataPlayerBase::GetCurrentSnapshotNumber ( )

Definition at line 52 of file mitkNavigationDataPlayerBase.cpp.

◆ GetNumberOfSnapshots()

unsigned int mitk::NavigationDataPlayerBase::GetNumberOfSnapshots ( )

Getter for the size of the mitk::NavigationDataSet used in this object.

Returns: Returns the number of navigation data snapshots available in the player.

Definition at line 47 of file mitkNavigationDataPlayerBase.cpp.

◆ GraftEmptyOutput()

void mitk::NavigationDataPlayerBase::GraftEmptyOutput ( )

protected

Convenience method for subclasses. When there are no further mitk::NavigationData objects available, this method can be called in the implementation of mitk::NavigationDataPlayerBase::GenerateData().

Definition at line 88 of file mitkNavigationDataPlayerBase.cpp.

◆ InitPlayer()

void mitk::NavigationDataPlayerBase::InitPlayer ( )

protected

Initializes the outputs of this NavigationDataSource. Aftwer calling this method, the first Navigationdata from the loaded Navigationdataset is loaded into the outputs.

Definition at line 57 of file mitkNavigationDataPlayerBase.cpp.

◆ IsAtEnd()

bool mitk::NavigationDataPlayerBase::IsAtEnd ( )

This method checks if player arrived at end of file.

Returns: true if last mitk::NavigationData object is in the outputs, false otherwise

Definition at line 34 of file mitkNavigationDataPlayerBase.cpp.

◆ itkGetMacro() [1/2]

mitk::NavigationDataPlayerBase::itkGetMacro	(	NavigationDataSet	,
		NavigationDataSet::Pointer	)

◆ itkGetMacro() [2/2]

mitk::NavigationDataPlayerBase::itkGetMacro	(	Repeat	,
		bool	)

Returns: Returns if the data player should repeat the outputs.

◆ itkSetMacro()

mitk::NavigationDataPlayerBase::itkSetMacro	(	Repeat	,
		bool	)

Set to true if the data player should repeat the outputs.

◆ mitkClassMacro()

mitk::NavigationDataPlayerBase::mitkClassMacro	(	NavigationDataPlayerBase	,
		NavigationDataSource	)

◆ SetNavigationDataSet()

void mitk::NavigationDataPlayerBase::SetNavigationDataSet ( NavigationDataSet::Pointer navigationDataSet )

Set mitk::NavigationDataSet for playing. Player is initialized by call to mitk::NavigationDataPlayerBase::InitPlayer() inside this method. Method must be called before this object can be used as a filter source.

Parameters

navigationDataSet mitk::NavigationDataSet which will be played by this player.

Definition at line 39 of file mitkNavigationDataPlayerBase.cpp.

◆ UpdateOutputInformation()

void mitk::NavigationDataPlayerBase::UpdateOutputInformation ( )

override

Used for pipeline update just to tell the pipeline that we always have to update.

Definition at line 28 of file mitkNavigationDataPlayerBase.cpp.

Member Data Documentation

◆ m_NavigationDataSet

NavigationDataSet::Pointer mitk::NavigationDataPlayerBase::m_NavigationDataSet

protected

Definition at line 105 of file mitkNavigationDataPlayerBase.h.

◆ m_NavigationDataSetIterator

mitk::NavigationDataSet::NavigationDataSetConstIterator mitk::NavigationDataPlayerBase::m_NavigationDataSetIterator

protected

Iterator always points to the NavigationData object which is in the outputs at the moment.

Definition at line 110 of file mitkNavigationDataPlayerBase.h.

◆ m_Repeat

bool mitk::NavigationDataPlayerBase::m_Repeat

protected

If the player should repeat outputs. Default is false.

Definition at line 103 of file mitkNavigationDataPlayerBase.h.

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

Modules/IGT/IO/mitkNavigationDataPlayerBase.h
Modules/IGT/IO/mitkNavigationDataPlayerBase.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NavigationDataPlayerBase()

◆ ~NavigationDataPlayerBase()

Member Function Documentation

◆ GenerateData()

◆ GetCurrentSnapshotNumber()

◆ GetNumberOfSnapshots()

◆ GraftEmptyOutput()

◆ InitPlayer()

◆ IsAtEnd()

◆ itkGetMacro() [1/2]

◆ itkGetMacro() [2/2]

◆ itkSetMacro()

◆ mitkClassMacro()

◆ SetNavigationDataSet()

◆ UpdateOutputInformation()

Member Data Documentation

◆ m_NavigationDataSet

◆ m_NavigationDataSetIterator

◆ m_Repeat