Medical Imaging Interaction Toolkit
2016.11.0
Medical Imaging Interaction Toolkit
|
Base class for using mitk::NavigationData as a filter source. Subclasses can play objects of mitk::NavigationDataSet. More...
#include <mitkNavigationDataPlayerBase.h>
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 () |
virtual 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... | |
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 () |
Protected Member Functions | |
NavigationDataPlayerBase () | |
virtual | ~NavigationDataPlayerBase () |
virtual void | GenerateData ()=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 () | |
virtual | ~NavigationDataSource () |
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 |
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 |
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 33 of file mitkNavigationDataPlayerBase.h.
|
protected |
Definition at line 22 of file mitkNavigationDataPlayerBase.cpp.
References mitk::NavigationDataSource::SetName().
|
protectedvirtual |
Definition at line 28 of file mitkNavigationDataPlayerBase.cpp.
|
protectedpure virtual |
Every subclass hast to implement this method. See ITK filter documentation for details.
Implemented in mitk::NavigationDataPlayer, and mitk::NavigationDataSequentialPlayer.
unsigned int mitk::NavigationDataPlayerBase::GetCurrentSnapshotNumber | ( | ) |
Definition at line 56 of file mitkNavigationDataPlayerBase.cpp.
|
virtual |
unsigned int mitk::NavigationDataPlayerBase::GetNumberOfSnapshots | ( | ) |
Getter for the size of the mitk::NavigationDataSet used in this object.
Definition at line 51 of file mitkNavigationDataPlayerBase.cpp.
|
virtual |
|
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 92 of file mitkNavigationDataPlayerBase.cpp.
References mitk::NavigationData::Graft(), and mitk::NavigationData::New().
|
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 61 of file mitkNavigationDataPlayerBase.cpp.
References mitkThrowException.
bool mitk::NavigationDataPlayerBase::IsAtEnd | ( | ) |
This method checks if player arrived at end of file.
Definition at line 38 of file mitkNavigationDataPlayerBase.cpp.
mitk::NavigationDataPlayerBase::mitkClassMacro | ( | NavigationDataPlayerBase | , |
NavigationDataSource | |||
) |
Set to true if the data player should repeat the outputs.
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.
navigationDataSet | mitk::NavigationDataSet which will be played by this player. |
Definition at line 43 of file mitkNavigationDataPlayerBase.cpp.
|
overridevirtual |
Used for pipeline update just to tell the pipeline that we always have to update.
Reimplemented in mitk::NavigationDataSequentialPlayer, and mitk::NavigationDataPlayer.
Definition at line 32 of file mitkNavigationDataPlayerBase.cpp.
|
protected |
Definition at line 109 of file mitkNavigationDataPlayerBase.h.
|
protected |
Iterator always points to the NavigationData object which is in the outputs at the moment.
Definition at line 114 of file mitkNavigationDataPlayerBase.h.
|
protected |
If the player should repeat outputs. Default is false.
Definition at line 107 of file mitkNavigationDataPlayerBase.h.