Ignition Gui

API Reference

5.0.0

Handle transport topics subscribing for one object (Chart) More...

#include <PlottingInterface.hh>

Public Slots

void onPlot (int _chart, QString _fieldID, double _x, double _y)
 Slot for receiving topics signal at each topic callback to plot. More...
 
void UnsubscribeOutdatedTopics ()
 Unsubscribe from non-exist topics in the transport. More...
 

Signals

void plot (int _chart, QString _fieldID, double _x, double _y)
 notify the Plotting Interface to plot More...
 

Public Member Functions

 Transport ()
 Constructor. More...
 
 ~Transport ()
 Destructor. More...
 
void Subscribe (const std::string &_topic, const std::string &_fieldPath, int _chart, const std::shared_ptr< double > &_time)
 Subscribe/attatch a field from a certain chart. More...
 
const std::map< std::string, Topic * > & Topics ()
 Get the registered topics. More...
 
void Unsubscribe (const std::string &_topic, const std::string &_fieldPath, int _chart)
 Unsubscribe/deattatch a field from a certain chart. More...
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (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 QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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 QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () 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)
 
QThreadthread () 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
 
QObjectsender () 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

Handle transport topics subscribing for one object (Chart)

Constructor & Destructor Documentation

◆ Transport()

Transport ( )

Constructor.

◆ ~Transport()

~Transport ( )

Destructor.

Member Function Documentation

◆ onPlot

void onPlot ( int  _chart,
QString  _fieldID,
double  _x,
double  _y 
)
slot

Slot for receiving topics signal at each topic callback to plot.

Parameters
[in]_chartchart ID
[in]_fieldIDfield path ID
[in]_xx coordinates of the plot point
[in]_yy coordinates of the plot point

◆ plot

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

notify the Plotting Interface to plot

Parameters
[in]_chartchart ID
[in]_fieldIDfield path ID
[in]_xx coordinates of the plot point
[in]_yy coordinates of the plot point

◆ Subscribe()

void Subscribe ( const std::string _topic,
const std::string _fieldPath,
int  _chart,
const std::shared_ptr< double > &  _time 
)

Subscribe/attatch a field from a certain chart.

Parameters
[in]_topictopic name
[in]_fieldPathfield path ID
[in]_chartchart ID
[in]_timeref to current plotting time

◆ Topics()

const std::map<std::string, Topic*>& Topics ( )

Get the registered topics.

Returns
Topics list

◆ Unsubscribe()

void Unsubscribe ( const std::string _topic,
const std::string _fieldPath,
int  _chart 
)

Unsubscribe/deattatch a field from a certain chart.

Parameters
[in]_topictopic name
[in]_fieldPathfield path ID
[in]_chartchart ID

◆ UnsubscribeOutdatedTopics

void UnsubscribeOutdatedTopics ( )
slot

Unsubscribe from non-exist topics in the transport.


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