Medical Imaging Interaction Toolkit
2016.11.0
Medical Imaging Interaction Toolkit
|
Connects a mitk::IGTLDevice to a MITK-OpenIGTLink-Message-Filter-Pipeline. More...
#include <mitkIGTL2DImageDeviceSource.h>
Public Member Functions | |
mitkClassMacro (IGTL2DImageDeviceSource, IGTLDeviceSource) | |
Pointer | Clone () const |
Public Member Functions inherited from mitk::IGTLDeviceSource | |
mitkClassMacro (IGTLDeviceSource, IGTLMessageSource) | |
Pointer | Clone () const |
virtual void | SetIGTLDevice (mitk::IGTLDevice *td) |
sets the OpenIGTLink device that will be used as a data source More... | |
virtual mitk::IGTLDevice * | GetIGTLDevice () |
returns the OpenIGTLink device that is used by this filter More... | |
virtual void | RegisterAsMicroservice () override |
Registers this object as a Microservice, making it available to every module and/or plugin. To unregister, call UnregisterMicroservice(). More... | |
void | Connect () |
Establishes a connection to the OpenIGTLink device. If there is already a connection the method does nothing. More... | |
void | Disconnect () |
Closes the connection to the OpenIGTLink device. More... | |
void | StartCommunication () |
starts the communication of the device. This needs to be called before Update() or GetOutput()->Update(). If the device is already communicating the method does nothing. More... | |
void | StopCommunication () |
stops the communication of the device. More... | |
virtual bool | IsConnected () |
returns true if a connection to the OpenIGTLink device is established More... | |
virtual bool | IsCommunicating () |
returns true if communication is in progress More... | |
virtual void | UpdateOutputInformation () override |
Used for pipeline update. More... | |
Public Member Functions inherited from mitk::IGTLMessageSource | |
mitkClassMacroItkParent (IGTLMessageSource, 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... | |
virtual std::string | GetType () |
virtual void | SetType (std::string _arg) |
IGTLMessage * | GetOutput (void) |
return the output (output with id 0) of the filter More... | |
IGTLMessage * | GetOutput (DataObjectPointerArraySizeType idx) |
return the output with id idx of the filter More... | |
IGTLMessage * | GetOutput (const std::string &messageName) |
return the output with name messageName of the filter More... | |
DataObjectPointerArraySizeType | GetOutputIndex (std::string messageName) |
return the index of the output with name messageName, -1 if no output with that name was found 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 IGTLMessageSource 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... | |
void | SetFPS (unsigned int fps) |
Sets the fps used for streaming this source. More... | |
unsigned int | GetFPS () |
Gets the fps used for streaming this source. More... | |
Static Public Member Functions | |
static Pointer | New () |
Static Public Member Functions inherited from mitk::IGTLDeviceSource | |
static Pointer | New () |
Protected Member Functions | |
IGTL2DImageDeviceSource () | |
virtual | ~IGTL2DImageDeviceSource () |
virtual void | GenerateData () override |
filter execute method More... | |
Protected Member Functions inherited from mitk::IGTLDeviceSource | |
IGTLDeviceSource () | |
virtual | ~IGTLDeviceSource () |
void | CreateOutputs () |
Create the necessary outputs for the m_IGTLDevice. More... | |
virtual void | OnIncomingMessage () |
This method is called when the IGTL device hold by this class receives a new message. More... | |
virtual void | OnIncomingCommand () |
This method is called when the IGTL device hold by this class receives a new command. More... | |
virtual void | OnLostConnection () |
This method is called when the IGTL device lost the connection to the other side. More... | |
virtual void | RemoveObservers () |
Removes all observers that listen to the igtl device. More... | |
virtual void | SetInput (unsigned int idx, const IGTLMessage *msg) |
Set input with id idx of this filter. More... | |
const IGTLMessage * | GetInput (void) const |
Get the input of this filter. More... | |
const IGTLMessage * | GetInput (unsigned int idx) const |
Get the input with id idx of this filter. More... | |
const IGTLMessage * | GetInput (std::string msgName) const |
Get the input with name messageName of this filter. More... | |
DataObjectPointerArraySizeType | GetInputIndex (std::string msgName) |
return the index of the input with name msgName, throw std::invalid_argument exception if that name was not found More... | |
DataObjectPointerArraySizeType | GetOutputIndex (std::string msgName) |
return the index of the output with name msgName, -1 if no output with that name was found More... | |
Protected Member Functions inherited from mitk::IGTLMessageSource | |
IGTLMessageSource () | |
virtual | ~IGTLMessageSource () |
Additional Inherited Members | |
Static Public Attributes inherited from mitk::IGTLDeviceSource | |
static const std::string | US_PROPKEY_IGTLDEVICENAME |
These Constants are used in conjunction with Microservices. More... | |
Static Public Attributes inherited from mitk::IGTLMessageSource | |
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_DEVICETYPE |
static const std::string | US_PROPKEY_ID |
static const std::string | US_PROPKEY_ISACTIVE |
Protected Attributes inherited from mitk::IGTLDeviceSource | |
mitk::IGTLDevice::Pointer | m_IGTLDevice |
unsigned int | m_LostConnectionObserverTag |
unsigned int | m_IncomingCommandObserverTag |
unsigned int | m_IncomingMessageObserverTag |
Protected Attributes inherited from mitk::IGTLMessageSource | |
std::string | m_Name |
std::string | m_Type |
itk::FastMutexLock::Pointer | m_StreamingFPSMutex |
unsigned int | m_StreamingFPS |
us::ServiceRegistration< Self > | m_ServiceRegistration |
Connects a mitk::IGTLDevice to a MITK-OpenIGTLink-Message-Filter-Pipeline.
This class is the source of most OpenIGTLink pipelines. It encapsulates a mitk::IGTLDevice and provides the information/messages of the connected OpenIGTLink devices as igtl::MessageBase objects. Note, that there is just one single output.
Definition at line 33 of file mitkIGTL2DImageDeviceSource.h.
|
protected |
Definition at line 30 of file mitkIGTL2DImageDeviceSource.cpp.
References mitk::IGTLMessageSource::SetName().
|
protectedvirtual |
Definition at line 36 of file mitkIGTL2DImageDeviceSource.cpp.
Pointer mitk::IGTL2DImageDeviceSource::Clone | ( | ) | const |
|
overrideprotectedvirtual |
filter execute method
queries the OpenIGTLink device for new messages and updates its output igtl::MessageBase objects with it.
Reimplemented from mitk::IGTLDeviceSource.
Definition at line 40 of file mitkIGTL2DImageDeviceSource.cpp.
References MITK_INFO, mitk::IGTLMessage::SetMessage(), and mitk::IGTLMessage::SetName().
mitk::IGTL2DImageDeviceSource::mitkClassMacro | ( | IGTL2DImageDeviceSource | , |
IGTLDeviceSource | |||
) |
|
static |
Referenced by mitk::USIGTLDevice::USIGTLDevice().