DataStreamer Class Reference

The DataStreamer base class to create your own plugin. More...

#include <datastreamer_base.h>

Inheritance diagram for DataStreamer:

Signals
void	clearBuffers ()
void	connectionClosed ()
void	dataUpdated ()

Public Member Functions
virtual std::vector< QString >	appendData (PlotDataMapRef &destination)
PlotDataMapRef &	dataMap ()
const PlotDataMapRef &	dataMap () const
	DataStreamer ()
virtual bool	isRunning () const =0
std::mutex &	mutex ()
void	setMaximumRange (double range)
virtual void	shutdown ()=0
virtual bool	start (QStringList *)=0
virtual	~DataStreamer ()
Public Member Functions inherited from PlotJugglerPlugin
virtual void	addActionsToParentMenu (QMenu *menu)
virtual bool	isDebugPlugin ()
virtual const char *	name () const =0
virtual QWidget *	optionsWidget ()
	PlotJugglerPlugin ()
virtual bool	xmlLoadState (const QDomElement &parent_element)
virtual bool	xmlSaveState (QDomDocument &doc, QDomElement &parent_element) const
QDomElement	xmlSaveState (QDomDocument &doc) const

Private Attributes
PlotDataMapRef	_data_map
std::mutex	_mutex
QAction *	_start_streamer

Detailed Description

The DataStreamer base class to create your own plugin.

Important. To avoid problems with thread safety, it is important that ANY update to dataMap(), which share its elements with the main application, is protected by the mutex()

This includes in particular the periodic updates.

Definition at line 17 of file datastreamer_base.h.

Constructor & Destructor Documentation

DataStreamer::DataStreamer ( )

inline

Definition at line 22 of file datastreamer_base.h.

virtual DataStreamer::~DataStreamer ( )

inlinevirtual

Definition at line 34 of file datastreamer_base.h.

Member Function Documentation

std::vector< QString > DataStreamer::appendData ( PlotDataMapRef &  destination )

inlinevirtual

Reimplemented in DataStreamROS.

Definition at line 93 of file datastreamer_base.h.

void DataStreamer::clearBuffers ( )

signal

void DataStreamer::connectionClosed ( )

signal

PlotDataMapRef& DataStreamer::dataMap ( )

inline

Definition at line 45 of file datastreamer_base.h.

const PlotDataMapRef& DataStreamer::dataMap ( ) const

inline

Definition at line 50 of file datastreamer_base.h.

void DataStreamer::dataUpdated ( )

signal

virtual bool DataStreamer::isRunning ( ) const

pure virtual

Implemented in DataStreamServer, DataStreamROS, and DataStreamSample.

std::mutex& DataStreamer::mutex ( )

inline

Definition at line 36 of file datastreamer_base.h.

QT_END_NAMESPACE void DataStreamer::setMaximumRange ( double  range )

inline

Definition at line 81 of file datastreamer_base.h.

virtual void DataStreamer::shutdown ( )

pure virtual

Implemented in DataStreamServer, DataStreamROS, and DataStreamSample.

virtual bool DataStreamer::start ( QStringList *  )

pure virtual

Implemented in DataStreamServer, DataStreamROS, and DataStreamSample.

Member Data Documentation

PlotDataMapRef DataStreamer::_data_map

private

Definition at line 65 of file datastreamer_base.h.

std::mutex DataStreamer::_mutex

private

Definition at line 64 of file datastreamer_base.h.

QAction* DataStreamer::_start_streamer

private

Definition at line 66 of file datastreamer_base.h.

---

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

• datastreamer_base.h