Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
List of all members
mitk::NavigationDataSequentialPlayer Class Reference
This class is a slightly changed reimplementation of the NavigationDataPlayer which does not care about timestamps and just outputs the navigationdatas in their sequential order. More...
#include <mitkNavigationDataSequentialPlayer.h>
Inheritance diagram for mitk::NavigationDataSequentialPlayer:
Collaboration diagram for mitk::NavigationDataSequentialPlayer:
Public Member Functions | |
| mitkClassMacro (NavigationDataSequentialPlayer, NavigationDataPlayerBase) | |
| void | GoToSnapshot (unsigned int i) |
| Advance the output to the i-th snapshot of mitk::NavigationData. E.g. if you want to have the NavData of snapshot 18 then you can call GoToSnapshot(17). Index begins at 0. You can only go back if m_Repeat is set true. This method internally calls GenerateData, so outputs are refreshed automatically. More... | |
| bool | GoToNextSnapshot () |
| Advance the output to the next snapshot of mitk::NavigationData. Filter output is updated inside the function. More... | |
| void | UpdateOutputInformation () override |
| Used for pipeline update just to tell the pipeline that we always have to update. More... | |
 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 () |
| 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 () |
Static Public Member Functions | |
| static Pointer | New () |
Protected Member Functions | |
| NavigationDataSequentialPlayer () | |
| ~NavigationDataSequentialPlayer () override | |
| void | GenerateData () override |
| Does nothing. mitk::NavigationDataSequentialPlayer::GoToNextSnapshot() should be called for generating next data. More... | |
| 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. 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 | |
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 |
| 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 |
| NavigationToolStorage::Pointer | m_ToolMetaDataCollection |
Detailed Description
This class is a slightly changed reimplementation of the NavigationDataPlayer which does not care about timestamps and just outputs the navigationdatas in their sequential order.
Documentation
Definition at line 27 of file mitkNavigationDataSequentialPlayer.h.
Constructor & Destructor Documentation
◆ NavigationDataSequentialPlayer()
|
protected |
◆ ~NavigationDataSequentialPlayer()
|
overrideprotected |
Member Function Documentation
◆ GenerateData()
|
overrideprotectedvirtual |
Does nothing. mitk::NavigationDataSequentialPlayer::GoToNextSnapshot() should be called for generating next data.
Implements mitk::NavigationDataPlayerBase.
◆ GoToNextSnapshot()
| bool mitk::NavigationDataSequentialPlayer::GoToNextSnapshot | ( | ) |
Advance the output to the next snapshot of mitk::NavigationData. Filter output is updated inside the function.
- Returns
- false if no next snapshot is available (happens only if m_Repeat is set to false).
- Exceptions
-
mitk::IGTException Throws an exception if an output is null.
◆ GoToSnapshot()
| void mitk::NavigationDataSequentialPlayer::GoToSnapshot | ( | unsigned int | i | ) |
Advance the output to the i-th snapshot of mitk::NavigationData. E.g. if you want to have the NavData of snapshot 18 then you can call GoToSnapshot(17). Index begins at 0. You can only go back if m_Repeat is set true. This method internally calls GenerateData, so outputs are refreshed automatically.
Filter output is updated inside the function.
- Exceptions
-
mitk::IGTException Throws an exception if cannot go back to particular snapshot.
◆ mitkClassMacro()
| mitk::NavigationDataSequentialPlayer::mitkClassMacro | ( | NavigationDataSequentialPlayer | , |
| NavigationDataPlayerBase | |||
| ) |
◆ New()
|
static |
◆ UpdateOutputInformation()
|
override |
Used for pipeline update just to tell the pipeline that we always have to update.
The documentation for this class was generated from the following file:
