Medical Imaging Interaction Toolkit  2016.11.0
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=0)
 
 ~QmitkIGTLStreamingConnector ()
 
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 39 of file QmitkIGTLStreamingConnector.h.

Constructor & Destructor Documentation

QmitkIGTLStreamingConnector::QmitkIGTLStreamingConnector ( QObject *  parent = 0)

Definition at line 46 of file QmitkIGTLStreamingConnector.cpp.

QmitkIGTLStreamingConnector::~QmitkIGTLStreamingConnector ( )

Definition at line 53 of file QmitkIGTLStreamingConnector.cpp.

Member Function Documentation

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.

Definition at line 57 of file QmitkIGTLStreamingConnector.cpp.

References m_CheckFPSTimer, m_IGTLMessageProvider, m_IGTLMessageSource, m_StreamingTimer, MILISECONDS_BETWEEN_FPS_CHECK, OnCheckFPS(), and OnUpdateSource().

void QmitkIGTLStreamingConnector::OnCheckFPS ( )
protectedslot

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

Definition at line 72 of file QmitkIGTLStreamingConnector.cpp.

References m_IGTLMessageSource, and m_StreamingTimer.

Referenced by Initialize().

void QmitkIGTLStreamingConnector::OnUpdateSource ( )
protectedslot

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

Definition at line 94 of file QmitkIGTLStreamingConnector.cpp.

References mitk::IGTLMessage::IsDataValid(), m_IGTLMessageProvider, and m_IGTLMessageSource.

Referenced by Initialize().

Member Data Documentation

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 83 of file QmitkIGTLStreamingConnector.h.

Referenced by Initialize().

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

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

Definition at line 72 of file QmitkIGTLStreamingConnector.h.

Referenced by Initialize(), and OnUpdateSource().

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

holds the message source that has to stream its data

Definition at line 67 of file QmitkIGTLStreamingConnector.h.

Referenced by Initialize(), OnCheckFPS(), and OnUpdateSource().

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 78 of file QmitkIGTLStreamingConnector.h.

Referenced by Initialize(), and OnCheckFPS().

const unsigned int QmitkIGTLStreamingConnector::MILISECONDS_BETWEEN_FPS_CHECK
staticprotected

Definition at line 85 of file QmitkIGTLStreamingConnector.h.

Referenced by Initialize().

const std::string QmitkIGTLStreamingConnector::VIEW_ID
static

Definition at line 44 of file QmitkIGTLStreamingConnector.h.


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