Medical Imaging Interaction Toolkit  2023.12.00
Medical Imaging Interaction Toolkit
QmitkIGTLStreamingConnector Class Reference

This class is used to stream messages from a IGTL message source into the sending queue of a message provider. More...

#include <QmitkIGTLStreamingConnector.h>

Inheritance diagram for QmitkIGTLStreamingConnector:
Collaboration diagram for QmitkIGTLStreamingConnector:

Public Member Functions

 QmitkIGTLStreamingConnector (QObject *parent=nullptr)
 
 ~QmitkIGTLStreamingConnector () override
 
void Initialize (mitk::IGTLMessageSource::Pointer msgSource, mitk::IGTLMessageProvider::Pointer msgProvider)
 Sets the message source that is the end of the pipeline and the message provider which will send the message. More...
 

Static Public Attributes

static const std::string VIEW_ID
 

Protected Slots

void OnCheckFPS ()
 checks the fps of the message source, if it is unequal 0 the streaming is started. More...
 
void OnUpdateSource ()
 updates the message source and sends the latest output to the provider More...
 

Protected Attributes

mitk::IGTLMessageSource::Pointer m_IGTLMessageSource
 holds the message source that has to stream its data More...
 
mitk::IGTLMessageProvider::Pointer m_IGTLMessageProvider
 holds the message provider that will send the stream data from the source More...
 
QTimer m_StreamingTimer
 the timer that is configured depending on the fps, if it is fired the pipeline is updated and the IGTLMessage added to the sending queue More...
 
QTimer m_CheckFPSTimer
 Everytime this timer is fired the fps of the message source are checked and the streaming is started or stopped. More...
 

Static Protected Attributes

static const unsigned int MILISECONDS_BETWEEN_FPS_CHECK
 

Detailed Description

This class is used to stream messages from a IGTL message source into the sending queue of a message provider.

Documentation: The data from the queue will be send to the requesting device.

This class is just needed because of the qtimer functionality. Check also the MessageProvider for more information.

Definition at line 35 of file QmitkIGTLStreamingConnector.h.

Constructor & Destructor Documentation

◆ QmitkIGTLStreamingConnector()

QmitkIGTLStreamingConnector::QmitkIGTLStreamingConnector ( QObject *  parent = nullptr)

◆ ~QmitkIGTLStreamingConnector()

QmitkIGTLStreamingConnector::~QmitkIGTLStreamingConnector ( )
override

Member Function Documentation

◆ Initialize()

void QmitkIGTLStreamingConnector::Initialize ( mitk::IGTLMessageSource::Pointer  msgSource,
mitk::IGTLMessageProvider::Pointer  msgProvider 
)

Sets the message source that is the end of the pipeline and the message provider which will send the message.

◆ OnCheckFPS

void QmitkIGTLStreamingConnector::OnCheckFPS ( )
protectedslot

checks the fps of the message source, if it is unequal 0 the streaming is started.

◆ OnUpdateSource

void QmitkIGTLStreamingConnector::OnUpdateSource ( )
protectedslot

updates the message source and sends the latest output to the provider

Member Data Documentation

◆ m_CheckFPSTimer

QTimer QmitkIGTLStreamingConnector::m_CheckFPSTimer
protected

Everytime this timer is fired the fps of the message source are checked and the streaming is started or stopped.

Definition at line 79 of file QmitkIGTLStreamingConnector.h.

◆ m_IGTLMessageProvider

mitk::IGTLMessageProvider::Pointer QmitkIGTLStreamingConnector::m_IGTLMessageProvider
protected

holds the message provider that will send the stream data from the source

Definition at line 68 of file QmitkIGTLStreamingConnector.h.

◆ m_IGTLMessageSource

mitk::IGTLMessageSource::Pointer QmitkIGTLStreamingConnector::m_IGTLMessageSource
protected

holds the message source that has to stream its data

Definition at line 63 of file QmitkIGTLStreamingConnector.h.

◆ m_StreamingTimer

QTimer QmitkIGTLStreamingConnector::m_StreamingTimer
protected

the timer that is configured depending on the fps, if it is fired the pipeline is updated and the IGTLMessage added to the sending queue

Definition at line 74 of file QmitkIGTLStreamingConnector.h.

◆ MILISECONDS_BETWEEN_FPS_CHECK

const unsigned int QmitkIGTLStreamingConnector::MILISECONDS_BETWEEN_FPS_CHECK
staticprotected

Definition at line 81 of file QmitkIGTLStreamingConnector.h.

◆ VIEW_ID

const std::string QmitkIGTLStreamingConnector::VIEW_ID
static

Definition at line 40 of file QmitkIGTLStreamingConnector.h.


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