Medical Imaging Interaction Toolkit  2018.4.99-87d68d9f
Medical Imaging Interaction Toolkit
mitk::IGTLDeviceSource Class Reference

Connects a mitk::IGTLDevice to a MITK-OpenIGTLink-Message-Filter-Pipeline. More...

#include <mitkIGTLDeviceSource.h>

Inheritance diagram for mitk::IGTLDeviceSource:
Collaboration diagram for mitk::IGTLDeviceSource:

Public Member Functions

 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::IGTLDeviceGetIGTLDevice ()
 returns the OpenIGTLink device that is used by this filter More...
 
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...
 
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)
 
IGTLMessageGetOutput (void)
 return the output (output with id 0) of the filter More...
 
IGTLMessageGetOutput (DataObjectPointerArraySizeType idx)
 return the output with id idx of the filter More...
 
IGTLMessageGetOutput (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...
 
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...
 
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 Attributes

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 Member Functions

 IGTLDeviceSource ()
 
 ~IGTLDeviceSource () override
 
void GenerateData () override
 filter execute method More...
 
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 IGTLMessageGetInput (void) const
 Get the input of this filter. More...
 
const IGTLMessageGetInput (unsigned int idx) const
 Get the input with id idx of this filter. More...
 
const IGTLMessageGetInput (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 ()
 
 ~IGTLMessageSource () override
 

Protected Attributes

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
 

Detailed Description

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 30 of file mitkIGTLDeviceSource.h.

Constructor & Destructor Documentation

◆ IGTLDeviceSource()

mitk::IGTLDeviceSource::IGTLDeviceSource ( )
protected

Definition at line 33 of file mitkIGTLDeviceSource.cpp.

References mitk::IGTLMessageSource::SetName().

◆ ~IGTLDeviceSource()

mitk::IGTLDeviceSource::~IGTLDeviceSource ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::IGTLDeviceSource::Clone ( ) const

◆ Connect()

void mitk::IGTLDeviceSource::Connect ( )

Establishes a connection to the OpenIGTLink device. If there is already a connection the method does nothing.

Warning
. Will throw a std::invalid_argument exception if no OpenIGTLink device was set with SetIGTLDevice(). Will throw a std::runtime_error if the OpenIGTLink device returns an error.

Definition at line 149 of file mitkIGTLDeviceSource.cpp.

References IsConnected(), and m_IGTLDevice.

◆ CreateOutputs()

void mitk::IGTLDeviceSource::CreateOutputs ( )
protected

Create the necessary outputs for the m_IGTLDevice.

This Method is called internally whenever outputs need to be reset. Old Outputs are deleted when called.

Definition at line 126 of file mitkIGTLDeviceSource.cpp.

References mitk::IGTLMessageSource::GetOutput(), m_IGTLDevice, and mitk::IGTLMessageSource::MakeOutput().

Referenced by SetIGTLDevice().

◆ Disconnect()

void mitk::IGTLDeviceSource::Disconnect ( )

Closes the connection to the OpenIGTLink device.

Warning
. Will throw a std::invalid_argument exception if no OpenIGTLink device was set with SetIGTLDevice(). Will throw a std::runtime_error if the OpenIGTLink device returns an error.

Definition at line 183 of file mitkIGTLDeviceSource.cpp.

References m_IGTLDevice.

Referenced by ~IGTLDeviceSource().

◆ GenerateData()

void mitk::IGTLDeviceSource::GenerateData ( )
overrideprotected

filter execute method

queries the OpenIGTLink device for new messages and updates its output igtl::MessageBase objects with it.

Warning
Will raise a std::out_of_range exception, if tools were added to the OpenIGTLink device after it was set as input for this filter

Definition at line 56 of file mitkIGTLDeviceSource.cpp.

References mitk::IGTLMessageSource::GetOutput(), m_IGTLDevice, mitk::IGTLMessage::SetMessage(), and mitk::IGTLMessage::SetName().

◆ GetIGTLDevice()

virtual mitk::IGTLDevice* mitk::IGTLDeviceSource::GetIGTLDevice ( )
virtual

returns the OpenIGTLink device that is used by this filter

Referenced by mitk::IGTLMessageProvider::OnIncomingCommand().

◆ GetInput() [1/3]

const mitk::IGTLMessage * mitk::IGTLDeviceSource::GetInput ( void  ) const
protected

◆ GetInput() [2/3]

const mitk::IGTLMessage * mitk::IGTLDeviceSource::GetInput ( unsigned int  idx) const
protected

Get the input with id idx of this filter.

Definition at line 279 of file mitkIGTLDeviceSource.cpp.

◆ GetInput() [3/3]

const mitk::IGTLMessage * mitk::IGTLDeviceSource::GetInput ( std::string  msgName) const
protected

Get the input with name messageName of this filter.

Definition at line 288 of file mitkIGTLDeviceSource.cpp.

◆ GetInputIndex()

itk::ProcessObject::DataObjectPointerArraySizeType mitk::IGTLDeviceSource::GetInputIndex ( std::string  msgName)
protected

return the index of the input with name msgName, throw std::invalid_argument exception if that name was not found

Warning
if a subclass has inputs that have different data type than mitk::IGTLMessage, they have to overwrite this method

Definition at line 300 of file mitkIGTLDeviceSource.cpp.

◆ GetOutputIndex()

DataObjectPointerArraySizeType mitk::IGTLDeviceSource::GetOutputIndex ( std::string  msgName)
protected

return the index of the output with name msgName, -1 if no output with that name was found

Warning
if a subclass has outputs that have different data type than mitk::IGTLMessage, they have to overwrite this method

◆ IsCommunicating()

bool mitk::IGTLDeviceSource::IsCommunicating ( )
virtual

returns true if communication is in progress

Definition at line 232 of file mitkIGTLDeviceSource.cpp.

References m_IGTLDevice, and mitk::IGTLDevice::Running.

◆ IsConnected()

bool mitk::IGTLDeviceSource::IsConnected ( )
virtual

returns true if a connection to the OpenIGTLink device is established

Definition at line 223 of file mitkIGTLDeviceSource.cpp.

References m_IGTLDevice, mitk::IGTLDevice::Ready, and mitk::IGTLDevice::Running.

Referenced by Connect().

◆ mitkClassMacro()

mitk::IGTLDeviceSource::mitkClassMacro ( IGTLDeviceSource  ,
IGTLMessageSource   
)

◆ New()

static Pointer mitk::IGTLDeviceSource::New ( )
static

◆ OnIncomingCommand()

void mitk::IGTLDeviceSource::OnIncomingCommand ( )
protectedvirtual

This method is called when the IGTL device hold by this class receives a new command.

Reimplemented in mitk::IGTLMessageProvider.

Definition at line 262 of file mitkIGTLDeviceSource.cpp.

Referenced by SetIGTLDevice().

◆ OnIncomingMessage()

void mitk::IGTLDeviceSource::OnIncomingMessage ( )
protectedvirtual

This method is called when the IGTL device hold by this class receives a new message.

Reimplemented in mitk::IGTLMessageProvider.

Definition at line 258 of file mitkIGTLDeviceSource.cpp.

Referenced by SetIGTLDevice().

◆ OnLostConnection()

void mitk::IGTLDeviceSource::OnLostConnection ( )
protectedvirtual

This method is called when the IGTL device lost the connection to the other side.

Reimplemented in mitk::IGTLMessageProvider.

Definition at line 266 of file mitkIGTLDeviceSource.cpp.

Referenced by SetIGTLDevice().

◆ RegisterAsMicroservice()

void mitk::IGTLDeviceSource::RegisterAsMicroservice ( )
overridevirtual

◆ RemoveObservers()

void mitk::IGTLDeviceSource::RemoveObservers ( )
protectedvirtual

Removes all observers that listen to the igtl device.

Definition at line 78 of file mitkIGTLDeviceSource.cpp.

References m_IGTLDevice, m_IncomingCommandObserverTag, m_IncomingMessageObserverTag, and m_LostConnectionObserverTag.

Referenced by SetIGTLDevice(), and ~IGTLDeviceSource().

◆ SetIGTLDevice()

void mitk::IGTLDeviceSource::SetIGTLDevice ( mitk::IGTLDevice td)
virtual

◆ SetInput()

void mitk::IGTLDeviceSource::SetInput ( unsigned int  idx,
const IGTLMessage msg 
)
protectedvirtual

Set input with id idx of this filter.

Definition at line 209 of file mitkIGTLDeviceSource.cpp.

Referenced by mitk::IGTLMessageProvider::ConnectTo().

◆ StartCommunication()

void mitk::IGTLDeviceSource::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.

Warning
. Will throw a std::invalid_argument exception if no OpenIGTLink device was set with SetIGTLDevice(). Will throw a std::runtime_error if the OpenIGTLink device returns an error.

Definition at line 171 of file mitkIGTLDeviceSource.cpp.

References m_IGTLDevice, and mitk::IGTLDevice::Running.

◆ StopCommunication()

void mitk::IGTLDeviceSource::StopCommunication ( )

stops the communication of the device.

Warning
. Will throw a std::invalid_argument exception if no OpenIGTLink device was set with SetIGTLDevice(). Will throw a std::runtime_error if the OpenIGTLink device returns an error.

Definition at line 193 of file mitkIGTLDeviceSource.cpp.

References m_IGTLDevice.

Referenced by ~IGTLDeviceSource().

◆ UpdateOutputInformation()

void mitk::IGTLDeviceSource::UpdateOutputInformation ( )
override

Used for pipeline update.

Definition at line 203 of file mitkIGTLDeviceSource.cpp.

Member Data Documentation

◆ m_IGTLDevice

◆ m_IncomingCommandObserverTag

unsigned int mitk::IGTLDeviceSource::m_IncomingCommandObserverTag
protected

Definition at line 201 of file mitkIGTLDeviceSource.h.

Referenced by RemoveObservers(), and SetIGTLDevice().

◆ m_IncomingMessageObserverTag

unsigned int mitk::IGTLDeviceSource::m_IncomingMessageObserverTag
protected

Definition at line 202 of file mitkIGTLDeviceSource.h.

Referenced by RemoveObservers(), and SetIGTLDevice().

◆ m_LostConnectionObserverTag

unsigned int mitk::IGTLDeviceSource::m_LostConnectionObserverTag
protected

observer tags

Definition at line 200 of file mitkIGTLDeviceSource.h.

Referenced by RemoveObservers(), and SetIGTLDevice().

◆ US_PROPKEY_IGTLDEVICENAME

const std::string mitk::IGTLDeviceSource::US_PROPKEY_IGTLDEVICENAME
static

These Constants are used in conjunction with Microservices.

Definition at line 35 of file mitkIGTLDeviceSource.h.

Referenced by QmitkIGTLDeviceSourceSelectionWidget::CreateConnections(), and RegisterAsMicroservice().


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