Ignition Gui

API Reference

5.0.0

Widget which publishes a custom Ignition transport message. More...

#include <Publisher.hh>

Public Slots

void OnPublish (const bool _checked)
 Callback when publish button is checked or unchecked. More...
 

Signals

void FrequencyChanged ()
 Notify that frequency has changed. More...
 
void MsgDataChanged ()
 Notify that message data has changed. More...
 
void MsgTypeChanged ()
 Notify that message type has changed. More...
 
void TopicChanged ()
 Notify that topic has changed. More...
 

Public Member Functions

 Publisher ()
 Constructor. More...
 
virtual ~Publisher ()
 Destructor. More...
 
Q_INVOKABLE double Frequency () const
 Get the frequency, in Hz. More...
 
virtual void LoadConfig (const tinyxml2::XMLElement *_pluginElem)
 Load the plugin with a configuration file. Override this on custom plugins to handle custom configurations. More...
 
Q_INVOKABLE QString MsgData () const
 Get the message data as a string, for example 'data: "Hello"'. More...
 
Q_INVOKABLE QString MsgType () const
 Get the message type as a string, for example 'ignition.msgs.StringMsg'. More...
 
Q_INVOKABLE void SetFrequency (const double _frequency)
 Set the frequency, in Hz. More...
 
Q_INVOKABLE void SetMsgData (const QString &_msgData)
 Set the message data from a string, for example 'data: "Hello"'. More...
 
Q_INVOKABLE void SetMsgType (const QString &_msgType)
 Set the message type from a string, for example 'ignition.msgs.StringMsg'. More...
 
Q_INVOKABLE void SetTopic (const QString &_topic)
 Set the topic from a string, for example '/echo'. More...
 
Q_INVOKABLE QString Topic () const
 Get the topic as a string, for example '/echo'. More...
 
- Public Member Functions inherited from Plugin
 Plugin ()
 Constructor. More...
 
virtual ~Plugin ()
 Destructor. More...
 
QQuickItem * CardItem () const
 Get the card item which contains this plugin. The item is generated the first time this function is run. More...
 
virtual std::string ConfigStr ()
 Get the configuration XML as a string. More...
 
QQmlContext * Context () const
 Get the QML context where the plugin was created. More...
 
bool DeleteLaterRequested () const
 Get the value of the the delete_later element from the configuration file, which defaults to false. More...
 
void Load (const tinyxml2::XMLElement *_pluginElem)
 Load the plugin with a configuration file. This loads the default parameters and then calls LoadConfig(), which should be overridden to load custom parameters. More...
 
QQuickItem * PluginItem () const
 Get the plugin item. More...
 
void PostParentChanges ()
 Apply changes which should come after the plugin already has a parent. More...
 
virtual std::string Title () const
 Get title. 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
 

Properties

double frequency
 Frequency. More...
 
QString msgData
 Message data. More...
 
QString msgType
 Message type. More...
 
QString topic
 Topic. More...
 
- Properties inherited from QObject
 objectName
 

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 Plugin
void DeleteLater ()
 Wait until the plugin has a parent, then close and delete the parent. More...
 
- 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)
 
- Protected Attributes inherited from Plugin
std::string configStr
 XML configuration. More...
 
std::string title = ""
 Title to be displayed on top of plugin. More...
 

Detailed Description

Widget which publishes a custom Ignition transport message.

Configuration

This plugin doesn't accept any custom configuration.

Constructor & Destructor Documentation

◆ Publisher()

Publisher ( )

Constructor.

◆ ~Publisher()

virtual ~Publisher ( )
virtual

Destructor.

Member Function Documentation

◆ Frequency()

Q_INVOKABLE double Frequency ( ) const

Get the frequency, in Hz.

Returns
Frequency

◆ FrequencyChanged

void FrequencyChanged ( )
signal

Notify that frequency has changed.

◆ LoadConfig()

virtual void LoadConfig ( const tinyxml2::XMLElement *  )
virtual

Load the plugin with a configuration file. Override this on custom plugins to handle custom configurations.

Called when a plugin is first created. This function should not be blocking.

See also
Load
Parameters
[in]_pluginElemElement containing configuration

Reimplemented from Plugin.

◆ MsgData()

Q_INVOKABLE QString MsgData ( ) const

Get the message data as a string, for example 'data: "Hello"'.

Returns
Message data

◆ MsgDataChanged

void MsgDataChanged ( )
signal

Notify that message data has changed.

◆ MsgType()

Q_INVOKABLE QString MsgType ( ) const

Get the message type as a string, for example 'ignition.msgs.StringMsg'.

Returns
Message type

◆ MsgTypeChanged

void MsgTypeChanged ( )
signal

Notify that message type has changed.

◆ OnPublish

void OnPublish ( const bool  _checked)
slot

Callback when publish button is checked or unchecked.

Parameters
[in]_checkedTrue if button is checked.

◆ SetFrequency()

Q_INVOKABLE void SetFrequency ( const double  _frequency)

Set the frequency, in Hz.

Parameters
[in]_frequencyFrequency

◆ SetMsgData()

Q_INVOKABLE void SetMsgData ( const QString _msgData)

Set the message data from a string, for example 'data: "Hello"'.

Parameters
[in]_msgDataMessage data

◆ SetMsgType()

Q_INVOKABLE void SetMsgType ( const QString _msgType)

Set the message type from a string, for example 'ignition.msgs.StringMsg'.

Parameters
[in]_msgTypeMessage type

◆ SetTopic()

Q_INVOKABLE void SetTopic ( const QString _topic)

Set the topic from a string, for example '/echo'.

Parameters
[in]_topicTopic

◆ Topic()

Q_INVOKABLE QString Topic ( ) const

Get the topic as a string, for example '/echo'.

Returns
Topic

◆ TopicChanged

void TopicChanged ( )
signal

Notify that topic has changed.

Property Documentation

◆ frequency

double frequency
readwrite

Frequency.

◆ msgData

QString msgData
readwrite

Message data.

◆ msgType

QString msgType
readwrite

Message type.

◆ topic

QString topic
readwrite

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