DataStreamSample Class Reference

#include <datastream_sample.h>

Inheritance diagram for DataStreamSample:

Classes
struct	Parameters

Public Member Functions
	DataStreamSample ()
virtual bool	isDebugPlugin () override
virtual bool	isRunning () const override
	isRunning More...
virtual const char *	name () const override
	Name of the plugin type, NOT the particular instance. More...
std::pair< QAction *, int >	notificationAction () override
	Gets the action to execute when clicking the 'notifications' button and the current number of outstanding notifications. More...
virtual void	shutdown () override
	shutdown Stop streaming More...
virtual bool	start (QStringList *) override
	start streaming. More...
virtual bool	xmlLoadState (const QDomElement &parent_element) override
	Override this method to load the status of the plugin from XML. More...
virtual bool	xmlSaveState (QDomDocument &doc, QDomElement &parent_element) const override
	Override this method to save the status of the plugin to XML. More...
virtual	~DataStreamSample () override
Public Member Functions inherited from PJ::DataStreamer
PlotDataMapRef &	dataMap ()
const PlotDataMapRef &	dataMap () const
	DataStreamer ()=default
std::mutex &	mutex ()
const ParserFactories *	parserFactories () const
void	setMaximumRangeX (double range)
void	setParserFactories (ParserFactories *parsers)
virtual	~DataStreamer ()=default
Public Member Functions inherited from PJ::PlotJugglerPlugin
virtual const std::vector< QAction * > &	availableActions ()
virtual QWidget *	optionsWidget ()
	optionsWidget pointer to a persistent widget used to set the plugin options . More...
	PlotJugglerPlugin ()=default
QDomElement	xmlSaveState (QDomDocument &doc) const

Private Member Functions
void	loop ()
void	pushSingleCycle ()

Private Attributes
QAction *	_dummy_notification
int	_notifications_count
std::map< std::string, Parameters >	_parameters
bool	_running
std::thread	_thread

Additional Inherited Members
Signals inherited from PJ::DataStreamer
void	clearBuffers ()
	Request the main application to clear previous data points. More...
void	closed ()
void	dataReceived ()
void	notificationsChanged (int active_notification_count)
void	removeGroup (std::string group_name)
	All the series which share this group, will be deleted. More...

Detailed Description

Definition at line 7 of file datastream_sample.h.

Constructor & Destructor Documentation

DataStreamSample()

DataStreamSample::DataStreamSample

(

)

Definition at line 14 of file datastream_sample.cpp.

~DataStreamSample()

DataStreamSample::~DataStreamSample ( )

overridevirtual

Definition at line 77 of file datastream_sample.cpp.

Member Function Documentation

isDebugPlugin()

virtual bool DataStreamSample::isDebugPlugin ( )

inlineoverridevirtual

Override this to return true, if you want this plugin to be loaded only when the command line option [-t] is used.

Reimplemented from PJ::PlotJugglerPlugin.

Definition at line 29 of file datastream_sample.h.

isRunning()

bool DataStreamSample::isRunning ( ) const

overridevirtual

isRunning

Returns

true if start() called, false after shutwodn()

Implements PJ::DataStreamer.

Definition at line 72 of file datastream_sample.cpp.

loop()

void DataStreamSample::loop ( )

private

Definition at line 129 of file datastream_sample.cpp.

name()

virtual const char* DataStreamSample::name ( ) const

inlineoverridevirtual

Name of the plugin type, NOT the particular instance.

Implements PJ::PlotJugglerPlugin.

Definition at line 24 of file datastream_sample.h.

notificationAction()

std::pair<QAction*, int> DataStreamSample::notificationAction ( )

inlineoverridevirtual

Gets the action to execute when clicking the 'notifications' button and the current number of outstanding notifications.

Reimplemented from PJ::DataStreamer.

Definition at line 39 of file datastream_sample.h.

pushSingleCycle()

void DataStreamSample::pushSingleCycle ( )

private

Definition at line 92 of file datastream_sample.cpp.

shutdown()

void DataStreamSample::shutdown ( )

overridevirtual

shutdown Stop streaming

Implements PJ::DataStreamer.

Definition at line 63 of file datastream_sample.cpp.

start()

bool DataStreamSample::start ( QStringList *  pre_selected_sources )

overridevirtual

start streaming.

Parameters

optional

list of pre selected sources.

Returns

true if started correctly.

Implements PJ::DataStreamer.

Definition at line 55 of file datastream_sample.cpp.

xmlLoadState()

bool DataStreamSample::xmlLoadState ( const QDomElement &  parent_element )

overridevirtual

Override this method to load the status of the plugin from XML.

Reimplemented from PJ::PlotJugglerPlugin.

Definition at line 87 of file datastream_sample.cpp.

xmlSaveState()

bool DataStreamSample::xmlSaveState ( QDomDocument &  doc, QDomElement &  parent_element  ) const

overridevirtual

Override this method to save the status of the plugin to XML.

Reimplemented from PJ::PlotJugglerPlugin.

Definition at line 82 of file datastream_sample.cpp.

Member Data Documentation

_dummy_notification

QAction* DataStreamSample::_dummy_notification

private

Definition at line 60 of file datastream_sample.h.

_notifications_count

int DataStreamSample::_notifications_count

private

Definition at line 62 of file datastream_sample.h.

_parameters

std::map<std::string, Parameters> DataStreamSample::_parameters

private

Definition at line 56 of file datastream_sample.h.

_running

bool DataStreamSample::_running

private

Definition at line 54 of file datastream_sample.h.

_thread

std::thread DataStreamSample::_thread

private

Definition at line 52 of file datastream_sample.h.

---

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

• datastream_sample.h
• datastream_sample.cpp