Medical Imaging Interaction Toolkit
2016.11.0
Medical Imaging Interaction Toolkit
|
This class is used to play recorded (see mitkNavigationDataRecorder class) NavigationDataSets. More...
#include <mitkNavigationDataPlayer.h>
Public Types | |
enum | PlayerState { PlayerStopped, PlayerRunning, PlayerPaused } |
typedef mitk::NavigationData::TimeStampType | TimeStampType |
Public Member Functions | |
mitkClassMacro (NavigationDataPlayer, NavigationDataPlayerBase) | |
Pointer | Clone () const |
virtual void | UpdateOutputInformation () override |
Used for pipeline update just to tell the pipeline that we always have to update. More... | |
void | StartPlaying () |
This method starts the player. More... | |
void | StopPlaying () |
Stops the player and closes the stream. After a call of StopPlaying(), StartPlaying() must be called to get new output data. More... | |
void | Pause () |
This method pauses the player. If you want to play again call Resume() More... | |
void | Resume () |
This method resumes the player when it was paused. More... | |
PlayerState | GetCurrentPlayerState () |
TimeStampType | GetTimeStampSinceStart () |
Public Member Functions inherited from mitk::NavigationDataPlayerBase | |
mitkClassMacro (NavigationDataPlayerBase, NavigationDataSource) virtual void SetRepeat(bool _arg) | |
Set to true if the data player should repeat the outputs. More... | |
virtual bool | GetRepeat () |
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... | |
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 Member Functions | |
static Pointer | New () |
Protected Member Functions | |
NavigationDataPlayer () | |
virtual | ~NavigationDataPlayer () |
virtual void | GenerateData () override |
Set outputs to the navigation data object corresponding to current time. More... | |
Protected Member Functions inherited from mitk::NavigationDataPlayerBase | |
NavigationDataPlayerBase () | |
virtual | ~NavigationDataPlayerBase () |
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 () | |
virtual | ~NavigationDataSource () |
Protected Attributes | |
PlayerState | m_CurPlayerState |
TimeStampType | m_StartPlayingTimeStamp |
The start time of the playing. Set in the method mitk::NavigationDataPlayer::StartPlaying(). More... | |
TimeStampType | m_PauseTimeStamp |
Stores the time when a pause began. More... | |
TimeStampType | m_TimeStampSinceStart |
Protected Attributes inherited from mitk::NavigationDataPlayerBase | |
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 |
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 |
This class is used to play recorded (see mitkNavigationDataRecorder class) NavigationDataSets.
Documentation TODO
Definition at line 33 of file mitkNavigationDataPlayer.h.
Definition at line 41 of file mitkNavigationDataPlayer.h.
Enumerator | |
---|---|
PlayerStopped | |
PlayerRunning | |
PlayerPaused |
Definition at line 40 of file mitkNavigationDataPlayer.h.
|
protected |
Definition at line 25 of file mitkNavigationDataPlayer.cpp.
References mitk::IGTTimeStamp::GetInstance(), and mitk::IGTTimeStamp::Start().
|
protectedvirtual |
Definition at line 33 of file mitkNavigationDataPlayer.cpp.
Pointer mitk::NavigationDataPlayer::Clone | ( | ) | const |
|
overrideprotectedvirtual |
Set outputs to the navigation data object corresponding to current time.
Implements mitk::NavigationDataPlayerBase.
Definition at line 38 of file mitkNavigationDataPlayer.cpp.
References mitk::IGTTimeStamp::GetElapsed(), mitk::IGTTimeStamp::GetInstance(), mitk::NavigationData::Graft(), MITK_WARN, and mitkThrowException.
mitk::NavigationDataPlayer::PlayerState mitk::NavigationDataPlayer::GetCurrentPlayerState | ( | ) |
Definition at line 152 of file mitkNavigationDataPlayer.cpp.
mitk::NavigationDataPlayer::TimeStampType mitk::NavigationDataPlayer::GetTimeStampSinceStart | ( | ) |
Definition at line 157 of file mitkNavigationDataPlayer.cpp.
mitk::NavigationDataPlayer::mitkClassMacro | ( | NavigationDataPlayer | , |
NavigationDataPlayerBase | |||
) |
|
static |
Referenced by QmitkIGTPlayerWidget::OnPlayButtonClicked().
void mitk::NavigationDataPlayer::Pause | ( | ) |
This method pauses the player. If you want to play again call Resume()
Definition at line 121 of file mitkNavigationDataPlayer.cpp.
References mitk::IGTTimeStamp::GetElapsed(), mitk::IGTTimeStamp::GetInstance(), and MITK_ERROR.
void mitk::NavigationDataPlayer::Resume | ( | ) |
This method resumes the player when it was paused.
Definition at line 135 of file mitkNavigationDataPlayer.cpp.
References mitk::IGTTimeStamp::GetElapsed(), mitk::IGTTimeStamp::GetInstance(), and MITK_ERROR.
void mitk::NavigationDataPlayer::StartPlaying | ( | ) |
This method starts the player.
The method mitk::NavigationDataPlayer::SetNavigationDataSet() has to be called before.
mitk::IGTException | If m_NavigationDataSet is null. |
Definition at line 99 of file mitkNavigationDataPlayer.cpp.
References mitk::IGTTimeStamp::GetElapsed(), and mitk::IGTTimeStamp::GetInstance().
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 116 of file mitkNavigationDataPlayer.cpp.
|
overridevirtual |
Used for pipeline update just to tell the pipeline that we always have to update.
Reimplemented from mitk::NavigationDataPlayerBase.
Definition at line 93 of file mitkNavigationDataPlayer.cpp.
|
protected |
Definition at line 87 of file mitkNavigationDataPlayer.h.
|
protected |
Stores the time when a pause began.
Definition at line 97 of file mitkNavigationDataPlayer.h.
|
protected |
The start time of the playing. Set in the method mitk::NavigationDataPlayer::StartPlaying().
Definition at line 92 of file mitkNavigationDataPlayer.h.
|
protected |
Definition at line 99 of file mitkNavigationDataPlayer.h.