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:

[legend]

Collaboration diagram for mitk::NavigationDataPlayerBase:

[legend]

Public Member Functions
	mitkClassMacro (NavigationDataPlayerBase, NavigationDataSource)

virtual void	SetRepeat (bool _arg)
	Set to true if the data player should repeat the outputs. More...

virtual bool	GetRepeat ()

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

virtual NavigationDataSet::Pointer	GetNavigationDataSet ()

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. More...

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

unsigned int	GetCurrentSnapshotNumber ()

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

Public Member Functions inherited from mitk::NavigationDataSource
	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...

NavigationTool::Pointer	GetToolMetaData (DataObjectPointerArraySizeType idx)

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

virtual mitk::NavigationToolStorage::Pointer	GetToolMetaDataCollection ()

virtual void	SetToolMetaDataCollection (mitk::NavigationToolStorage::Pointer _arg)

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

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. More...

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

virtual void	Freeze ()

virtual void	UnFreeze ()

virtual bool	GetIsFrozen ()

Protected Member Functions
	NavigationDataPlayerBase ()

	~NavigationDataPlayerBase () override

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

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

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

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

	~NavigationDataSource () override

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

NavigationDataSet::Pointer	m_NavigationDataSet

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

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
	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

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.

References mitk::NavigationDataSource::SetName().

◆ ~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::NavigationDataPlayer, and mitk::NavigationDataSequentialPlayer.

Referenced by InitPlayer().

◆ GetCurrentSnapshotNumber()

unsigned int mitk::NavigationDataPlayerBase::GetCurrentSnapshotNumber ( )

Definition at line 52 of file mitkNavigationDataPlayerBase.cpp.

References m_NavigationDataSet, and m_NavigationDataSetIterator.

◆ GetNavigationDataSet()

virtual NavigationDataSet::Pointer mitk::NavigationDataPlayerBase::GetNavigationDataSet ( )

virtual

◆ 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.

References m_NavigationDataSet.

Referenced by mitk::NavigationDataSequentialPlayer::GoToSnapshot().

◆ GetRepeat()

virtual bool mitk::NavigationDataPlayerBase::GetRepeat ( )

virtual

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

◆ 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.

References mitk::NavigationDataSource::GetOutput(), mitk::NavigationData::Graft(), m_NavigationDataSet, and mitk::NavigationData::New().

Referenced by mitk::NavigationDataSequentialPlayer::GenerateData(), and mitk::NavigationDataPlayer::GenerateData().

◆ 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.

References GenerateData(), m_NavigationDataSet, mitk::NavigationDataSource::MakeOutput(), and mitkThrowException.

Referenced by SetNavigationDataSet(), and mitk::NavigationDataPlayer::StartPlaying().

◆ 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.

References m_NavigationDataSet, and m_NavigationDataSetIterator.

◆ 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.

References InitPlayer(), m_NavigationDataSet, and m_NavigationDataSetIterator.