PJ::StatePublisher Class Reference

#include <statepublisher_base.h>

Inheritance diagram for PJ::StatePublisher:

Public Slots
virtual void	setEnabled (bool enabled)=0
	Method called when the checkbox "enabled" is checked in the main app. More...

Signals
void	closed ()
	signal to be emitted when the plugin disable itself. More...

Public Member Functions
virtual bool	enabled () const =0
	True if started. More...
virtual void	play (double interval)=0
void	setDataMap (const PlotDataMapRef *datamap)
virtual void	updateState (double current_time)=0
	Method called when the timetracker is moved manually to a certain position. More...
virtual	~StatePublisher ()=default
Public Member Functions inherited from PJ::PlotJugglerPlugin
virtual const std::vector< QAction * > &	availableActions ()
virtual bool	isDebugPlugin ()
virtual const char *	name () const =0
	Name of the plugin type, NOT the particular instance. More...
virtual QWidget *	optionsWidget ()
	optionsWidget pointer to a persistent widget used to set the plugin options . More...
	PlotJugglerPlugin ()=default
virtual bool	xmlLoadState (const QDomElement &parent_element)
	Override this method to load the status of the plugin from XML. More...
QDomElement	xmlSaveState (QDomDocument &doc) const
virtual bool	xmlSaveState (QDomDocument &doc, QDomElement &parent_element) const
	Override this method to save the status of the plugin to XML. More...

Protected Attributes
const PlotDataMapRef *	_datamap

Detailed Description

Definition at line 20 of file statepublisher_base.h.

Constructor & Destructor Documentation

~StatePublisher()

virtual PJ::StatePublisher::~StatePublisher ( )

virtualdefault

Member Function Documentation

closed

void PJ::StatePublisher::closed ( )

signal

signal to be emitted when the plugin disable itself.

enabled()

virtual bool PJ::StatePublisher::enabled ( ) const

pure virtual

True if started.

Implemented in StatePublisherCSV, and PublisherVideo.

play()

virtual void PJ::StatePublisher::play ( double  interval )

pure virtual

Method called when the "play" button is checked.

Parameters

interval

is seconds passed since the last time play was called.

Implemented in StatePublisherCSV, and PublisherVideo.

setDataMap()

void PJ::StatePublisher::setDataMap ( const PlotDataMapRef *  datamap )

inline

Definition at line 37 of file statepublisher_base.h.

setEnabled

virtual void PJ::StatePublisher::setEnabled ( bool  enabled )

pure virtualslot

Method called when the checkbox "enabled" is checked in the main app.

updateState()

virtual void PJ::StatePublisher::updateState ( double  current_time )

pure virtual

Method called when the timetracker is moved manually to a certain position.

Implemented in StatePublisherCSV, and PublisherVideo.

Member Data Documentation

_datamap

const PlotDataMapRef* PJ::StatePublisher::_datamap

protected

Definition at line 52 of file statepublisher_base.h.

---

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

• statepublisher_base.h