This class is used to play recorded (see mitkNavigationDataRecorder class) NavigationDataSets. More...

#include <mitkNavigationDataPlayer.h>

Inheritance diagram for mitk::NavigationDataPlayer:

Public Types
enum	PlayerState { PlayerStopped , PlayerRunning , PlayerPaused }

typedef mitk::NavigationData::TimeStampType	TimeStampType

Public Member Functions
	mitkClassMacro (NavigationDataPlayer, NavigationDataPlayerBase)

	itkFactorylessNewMacro (Self)

	itkCloneMacro (Self)

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

void	StartPlaying ()
	This method starts the player.

void	StopPlaying ()
	Stops the player and closes the stream. After a call of StopPlaying(), StartPlaying() must be called to get new output data.

void	Pause ()
	This method pauses the player. If you want to play again call Resume()

void	Resume ()
	This method resumes the player when it was paused.

PlayerState	GetCurrentPlayerState ()

TimeStampType	GetTimeStampSinceStart ()

Public Member Functions inherited from mitk::NavigationDataPlayerBase
	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
	NavigationDataPlayer ()

	~NavigationDataPlayer () override

void	GenerateData () override
	Set outputs to the navigation data object corresponding to current time.

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

	~NavigationDataPlayerBase () override

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

TimeStampType	m_StartPlayingTimeStamp
	The start time of the playing. Set in the method mitk::NavigationDataPlayer::StartPlaying().

TimeStampType	m_PauseTimeStamp
	Stores the time when a pause began.

TimeStampType	m_TimeStampSinceStart

Protected Attributes inherited from mitk::NavigationDataPlayerBase
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

This class is used to play recorded (see mitkNavigationDataRecorder class) NavigationDataSets.

Documentation

TODO

Definition at line 27 of file mitkNavigationDataPlayer.h.

Member Typedef Documentation

◆ TimeStampType

mitk::NavigationData::TimeStampType mitk::NavigationDataPlayer::TimeStampType

Definition at line 35 of file mitkNavigationDataPlayer.h.

Member Enumeration Documentation

◆ PlayerState

enum mitk::NavigationDataPlayer::PlayerState

Enumerator
PlayerStopped
PlayerRunning
PlayerPaused

Definition at line 34 of file mitkNavigationDataPlayer.h.

Constructor & Destructor Documentation

◆ NavigationDataPlayer()

mitk::NavigationDataPlayer::NavigationDataPlayer ( )

protected

Definition at line 21 of file mitkNavigationDataPlayer.cpp.

◆ ~NavigationDataPlayer()

mitk::NavigationDataPlayer::~NavigationDataPlayer ( )

overrideprotected

Definition at line 29 of file mitkNavigationDataPlayer.cpp.

Member Function Documentation

◆ GenerateData()

void mitk::NavigationDataPlayer::GenerateData ( )

overrideprotectedvirtual

Set outputs to the navigation data object corresponding to current time.

Implements mitk::NavigationDataPlayerBase.

Definition at line 34 of file mitkNavigationDataPlayer.cpp.

◆ GetCurrentPlayerState()

mitk::NavigationDataPlayer::PlayerState mitk::NavigationDataPlayer::GetCurrentPlayerState ( )

Definition at line 148 of file mitkNavigationDataPlayer.cpp.

◆ GetTimeStampSinceStart()

mitk::NavigationDataPlayer::TimeStampType mitk::NavigationDataPlayer::GetTimeStampSinceStart ( )

Definition at line 153 of file mitkNavigationDataPlayer.cpp.

◆ itkCloneMacro()

mitk::NavigationDataPlayer::itkCloneMacro ( Self )

◆ itkFactorylessNewMacro()

mitk::NavigationDataPlayer::itkFactorylessNewMacro ( Self )

◆ mitkClassMacro()

mitk::NavigationDataPlayer::mitkClassMacro	(	NavigationDataPlayer	,
		NavigationDataPlayerBase	)

◆ Pause()

void mitk::NavigationDataPlayer::Pause ( )

This method pauses the player. If you want to play again call Resume()

Definition at line 117 of file mitkNavigationDataPlayer.cpp.

◆ Resume()

void mitk::NavigationDataPlayer::Resume ( )

This method resumes the player when it was paused.

Definition at line 131 of file mitkNavigationDataPlayer.cpp.

◆ StartPlaying()

void mitk::NavigationDataPlayer::StartPlaying ( )

This method starts the player.

The method mitk::NavigationDataPlayer::SetNavigationDataSet() has to be called before.

Exceptions

mitk::IGTException If m_NavigationDataSet is null.

Definition at line 95 of file mitkNavigationDataPlayer.cpp.

◆ StopPlaying()

void mitk::NavigationDataPlayer::StopPlaying ( )

Stops the player and closes the stream. After a call of StopPlaying(), StartPlaying() must be called to get new output data.

Definition at line 112 of file mitkNavigationDataPlayer.cpp.

◆ UpdateOutputInformation()

void mitk::NavigationDataPlayer::UpdateOutputInformation ( )

override

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

Definition at line 89 of file mitkNavigationDataPlayer.cpp.

Member Data Documentation

◆ m_CurPlayerState

PlayerState mitk::NavigationDataPlayer::m_CurPlayerState

protected

Definition at line 81 of file mitkNavigationDataPlayer.h.

◆ m_PauseTimeStamp

TimeStampType mitk::NavigationDataPlayer::m_PauseTimeStamp

protected

Stores the time when a pause began.

Definition at line 91 of file mitkNavigationDataPlayer.h.

◆ m_StartPlayingTimeStamp

TimeStampType mitk::NavigationDataPlayer::m_StartPlayingTimeStamp

protected

The start time of the playing. Set in the method mitk::NavigationDataPlayer::StartPlaying().

Definition at line 86 of file mitkNavigationDataPlayer.h.

◆ m_TimeStampSinceStart

TimeStampType mitk::NavigationDataPlayer::m_TimeStampSinceStart

protected

Definition at line 93 of file mitkNavigationDataPlayer.h.

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

Modules/IGT/IO/mitkNavigationDataPlayer.h
Modules/IGT/IO/mitkNavigationDataPlayer.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TimeStampType

Member Enumeration Documentation

◆ PlayerState

Constructor & Destructor Documentation

◆ NavigationDataPlayer()

◆ ~NavigationDataPlayer()

Member Function Documentation

◆ GenerateData()

◆ GetCurrentPlayerState()

◆ GetTimeStampSinceStart()

◆ itkCloneMacro()

◆ itkFactorylessNewMacro()

◆ mitkClassMacro()

◆ Pause()

◆ Resume()

◆ StartPlaying()

◆ StopPlaying()

◆ UpdateOutputInformation()

Member Data Documentation

◆ m_CurPlayerState

◆ m_PauseTimeStamp

◆ m_StartPlayingTimeStamp

◆ m_TimeStampSinceStart