Provides information/objects from a MITK-Pipeline to other OpenIGTLink devices. More...

#include <mitkIGTLMessageProvider.h>

Inheritance diagram for mitk::IGTLMessageProvider:

Public Types
typedef itk::SimpleMemberCommand< mitk::IGTLMessageProvider >	ProviderCommand

Public Member Functions
	mitkClassMacro (IGTLMessageProvider, IGTLDeviceSource)

	itkFactorylessNewMacro (Self)

	itkCloneMacro (Self)

void	Send (mitk::IGTLMessage::Pointer msg)
	sends the msg to the requesting client

void	StartStreamingOfSource (mitk::IGTLMessageSource *src, unsigned int fps)
	Starts the streaming of the given message source with the given fps.

void	StopStreamingOfSource (mitk::IGTLMessageSource *src)
	Stops the streaming of the given message source.

void	StopStreamingOfAllSources ()
	Stops the streaming of all message source.

bool	IsStreaming ()
	Returns the streaming state.

	itkGetMacro (StreamingTime, unsigned int)
	Get method for the streaming time.

void	Update () override

Public Member Functions inherited from mitk::IGTLDeviceSource
	mitkClassMacro (IGTLDeviceSource, IGTLMessageSource)

	itkFactorylessNewMacro (Self)

	itkCloneMacro (Self)

virtual void	SetIGTLDevice (mitk::IGTLDevice *td)
	sets the OpenIGTLink device that will be used as a data source

	itkGetObjectMacro (IGTLDevice, mitk::IGTLDevice)
	returns the OpenIGTLink device that is used by this filter

void	RegisterAsMicroservice () override
	Registers this object as a Microservice, making it available to every module and/or plugin. To unregister, call UnregisterMicroservice().

void	Connect ()
	Establishes a connection to the OpenIGTLink device. If there is already a connection the method does nothing.

void	Disconnect ()
	Closes the connection to the OpenIGTLink device.

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.

void	StopCommunication ()
	stops the communication of the device.

virtual bool	IsConnected ()
	returns true if a connection to the OpenIGTLink device is established

virtual bool	IsCommunicating ()
	returns true if communication is in progress

void	UpdateOutputInformation () override
	Used for pipeline update.

Public Member Functions inherited from mitk::IGTLMessageSource
	mitkClassMacroItkParent (IGTLMessageSource, itk::ProcessObject)

	itkGetMacro (Name, std::string)

	itkSetMacro (Name, std::string)
	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.

	itkGetMacro (Type, std::string)

	itkSetMacro (Type, std::string)
	Sets the human readable type of this source. There will be a default type, or you can set the name with the method SetType(). You have to set this parameter otherwise it will not be found by the message provider.

IGTLMessage *	GetOutput (void)
	return the output (output with id 0) of the filter

IGTLMessage *	GetOutput (DataObjectPointerArraySizeType idx)
	return the output with id idx of the filter

IGTLMessage *	GetOutput (const std::string &messageName)
	return the output with name messageName of the filter

DataObjectPointerArraySizeType	GetOutputIndex (std::string messageName)
	return the index of the output with name messageName, -1 if no output with that name was found

virtual void	UnRegisterMicroservice ()
	Registers this object as a Microservice, making it available to every module and/or plugin.

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().

virtual void	GraftNthOutput (unsigned int idx, itk::DataObject *graft)
	Graft the specified DataObject onto this ProcessObject's output.

virtual void	GraftOutput (itk::DataObject *graft)
	Graft the specified DataObject onto this ProcessObject's output.

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.

virtual mitk::PropertyList::ConstPointer	GetParameters () const
	Get all filter parameters as a PropertyList.

void	SetFPS (unsigned int fps)
	Sets the fps used for streaming this source.

unsigned int	GetFPS ()
	Gets the fps used for streaming this source.

Protected Member Functions
	IGTLMessageProvider ()

	~IGTLMessageProvider () override

void	GenerateData () override
	filter execute method

void	CreateOutputs ()
	Create the necessary outputs for the m_IGTLDevice.

void	OnIncomingMessage () override
	This method is called when the IGTL device hold by this class receives a new message.

void	OnIncomingCommand () override
	This method is called when the IGTL device hold by this class receives a new command.

void	OnLostConnection () override
	This method is called when the IGTL device lost the connection to the other side.

void	ConnectTo (mitk::IGTLMessageSource *UpstreamFilter)
	Connects the input of this filter to the outputs of the given IGTLMessageSource.

void	DisconnectFrom (mitk::IGTLMessageSource *UpstreamFilter)
	Disconnects this filter from the outputs of the given IGTLMessageSource.

mitk::IGTLMessageSource::Pointer	GetFittingSource (const char *requestedType)
	Looks for microservices that provide messages with the requested type.

void	InvokeStartStreamingEvent ()

void	InvokeStopStreamingEvent ()

Protected Member Functions inherited from mitk::IGTLDeviceSource
	IGTLDeviceSource ()

	~IGTLDeviceSource () override

void	GenerateData () override
	filter execute method

void	CreateOutputs ()
	Create the necessary outputs for the m_IGTLDevice.

virtual void	RemoveObservers ()
	Removes all observers that listen to the igtl device.

virtual void	SetInput (unsigned int idx, const IGTLMessage *msg)
	Set input with id idx of this filter.

const IGTLMessage *	GetInput (void) const
	Get the input of this filter.

const IGTLMessage *	GetInput (unsigned int idx) const
	Get the input with id idx of this filter.

const IGTLMessage *	GetInput (std::string msgName) const
	Get the input with name messageName of this filter.

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

DataObjectPointerArraySizeType	GetOutputIndex (std::string msgName)
	return the index of the output with name msgName, -1 if no output with that name was found

Protected Member Functions inherited from mitk::IGTLMessageSource
	IGTLMessageSource ()

	~IGTLMessageSource () override

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.

Static Public Attributes inherited from mitk::IGTLMessageSource
static const std::string	US_INTERFACE_NAME
	These Constants are used in conjunction with Microservices.

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

std::mutex	m_StreamingFPSMutex

unsigned int	m_StreamingFPS

us::ServiceRegistration< Self >	m_ServiceRegistration

Detailed Description

Provides information/objects from a MITK-Pipeline to other OpenIGTLink devices.

This class is intended as the drain of the pipeline. Other OpenIGTLink devices connect with the IGTLDevice hold by this provider. The other device asks for a certain data type. The provider checks if there are other IGTLMessageSources available that provide this data type. If yes the provider connects with this source and sends the message to the requesting device.

If a STT message was received the provider looks for fitting messageSources. Once found it connects with it, starts a timing thread (which updates the pipeline) and sends the result to the requesting device.

If a GET message was received the provider just calls an update of the found source and sends the result without connecting to the source.

If a STP message was received it stops the thread and disconnects from the previous source.

So far the provider can just connect with one source.

Definition at line 47 of file mitkIGTLMessageProvider.h.

Member Typedef Documentation

◆ ProviderCommand

itk::SimpleMemberCommand<mitk::IGTLMessageProvider> mitk::IGTLMessageProvider::ProviderCommand

Definition at line 54 of file mitkIGTLMessageProvider.h.

Constructor & Destructor Documentation

◆ IGTLMessageProvider()

mitk::IGTLMessageProvider::IGTLMessageProvider ( )

protected

Definition at line 43 of file mitkIGTLMessageProvider.cpp.

◆ ~IGTLMessageProvider()

mitk::IGTLMessageProvider::~IGTLMessageProvider ( )

overrideprotected

Definition at line 59 of file mitkIGTLMessageProvider.cpp.

Member Function Documentation

◆ ConnectTo()

void mitk::IGTLMessageProvider::ConnectTo ( mitk::IGTLMessageSource * UpstreamFilter )

protected

Connects the input of this filter to the outputs of the given IGTLMessageSource.

This method does not support smartpointer. use FilterX.GetPointer() to retrieve a dumbpointer.

Definition at line 350 of file mitkIGTLMessageProvider.cpp.

◆ CreateOutputs()

void mitk::IGTLMessageProvider::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 106 of file mitkIGTLMessageProvider.cpp.

◆ DisconnectFrom()

void mitk::IGTLMessageProvider::DisconnectFrom ( mitk::IGTLMessageSource * UpstreamFilter )

protected

Disconnects this filter from the outputs of the given IGTLMessageSource.

This method does not support smartpointer. use FilterX.GetPointer() to retrieve a dumbpointer.

Definition at line 360 of file mitkIGTLMessageProvider.cpp.

◆ GenerateData()

void mitk::IGTLMessageProvider::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 84 of file mitkIGTLMessageProvider.cpp.

◆ GetFittingSource()

mitk::IGTLMessageSource::Pointer mitk::IGTLMessageProvider::GetFittingSource ( const char * requestedType )

protected

Looks for microservices that provide messages with the requested type.

Definition at line 313 of file mitkIGTLMessageProvider.cpp.

◆ InvokeStartStreamingEvent()

void mitk::IGTLMessageProvider::InvokeStartStreamingEvent ( )

protected

Invokes the start streaming event. This separate method is required, because it has to be started from the main thread. (It is used as callback function)

Definition at line 279 of file mitkIGTLMessageProvider.cpp.

◆ InvokeStopStreamingEvent()

void mitk::IGTLMessageProvider::InvokeStopStreamingEvent ( )

protected

Invokes the stop streaming event. This separate method is required, because it has to be started from the main thread. (It is used as callback function)

Definition at line 284 of file mitkIGTLMessageProvider.cpp.