Topic Class Reference

Plotting Topic to handle published topics & their registered fields. More...

#include <PlottingInterface.hh>

Signals
void	plot (int _chart, QString _fieldID, double _x, double _y)
	update the GUI and plot the topic's fields values

Public Member Functions
	Topic (const std::string &_name)
	Constructor.
	~Topic ()
	Destructor.
void	Callback (const google::protobuf::Message &_msg)
	Callback to receive messages.
int	FieldCount () const
	size of registered fields
std::map< std::string, PlotData * > &	Fields ()
	Get the registered fields.
bool	HasHeader (const google::protobuf::Message &_msg, double &_headerTime)
	Check if msg has header field and get its time.
std::string &	Name () const
	Get topic name.
void	Register (const std::string &_fieldPath, int _chart)
	Register a chart to a field.
void	SetPlottingTimeRef (const std::shared_ptr< double > &_time)
	update the current time with the default time of the plotting timer
void	UnRegister (const std::string &_fieldPath, int _chart)
	Remove field from the plot.
void	UpdateGui (const std::string &_field)
	update the plot
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

Plotting Topic to handle published topics & their registered fields.

Constructor & Destructor Documentation

Topic()

Topic ( const std::string &  _name )

explicit

Constructor.

~Topic()

~Topic

(

)

Destructor.

Member Function Documentation

Callback()

void Callback

(

const google::protobuf::Message &

_msg

)

Callback to receive messages.

Parameters

[in]

_msg

the published msg from the topic

FieldCount()

int FieldCount

(

)

const

size of registered fields

Returns

fields size

Fields()

std::map< std::string, PlotData * > & Fields

(

)

Get the registered fields.

Returns

Map of fields to their plots

HasHeader()

bool HasHeader	(	const google::protobuf::Message &	_msg,
		double &	_headerTime
	)

Check if msg has header field and get its time.

Parameters

[in]	_msg	msg to check its header
[out]	_headerTime	header sim time

Name()

std::string & Name

(

)

const

Get topic name.

Returns

Topic name

plot

void plot ( int  _chart, QString  _fieldID, double  _x, double  _y  )

signal

update the GUI and plot the topic's fields values

Parameters

[in]	_chart	chart ID
[in]	_fieldID	field path ID
[in]	_x	x coordinates of the plot point
[in]	_y	y coordinates of the plot point

Register()

void Register	(	const std::string &	_fieldPath,
		int	_chart
	)

Register a chart to a field.

Parameters

[in]	_fieldPath	model path to the field as an ID
[in]	_chart	Chart ID

SetPlottingTimeRef()

void SetPlottingTimeRef

(

const std::shared_ptr< double > &

_time

)

update the current time with the default time of the plotting timer

Parameters

[in]

_time

current time of the plotting timer

UnRegister()

void UnRegister	(	const std::string &	_fieldPath,
		int	_chart
	)

Remove field from the plot.

Parameters

[in]	_fieldPath	model path to the field as an ID
[in]	_chart	Chart ID

UpdateGui()

void UpdateGui

(

const std::string &

_field

)

update the plot

Parameters

[in]

_field

field path or ID

---

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

• PlottingInterface.hh