Echo messages coming through an Ignition transport topic. More...

#include <TopicEcho.hh>

Public Slots
void	OnEcho (const bool _checked)
	Callback when echo button is pressed. More...

Signals
void	AddMsg (QString _msg)
	Signal to add a message to the GUI list. More...

void	BufferChanged ()
	Notify that buffer has changed. More...

void	PausedChanged ()
	Notify that paused has changed. More...

void	TopicChanged ()
	Notify that topic has changed. More...

Public Member Functions
	TopicEcho ()
	Constructor. More...

virtual	~TopicEcho ()
	Destructor. More...

Q_INVOKABLE int	Buffer () const
	Get the number of messages to be buffered. 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 bool	Paused () const
	Get whether it is paused. More...

Q_INVOKABLE void	SetBuffer (const int &_buffer)
	Set the number of messages to be buffered. More...

Q_INVOKABLE void	SetPaused (const bool &_paused)
	Set whether to be paused. 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...

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)

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 QObject receiver, const char method)

bool	disconnect (const char signal, 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

Properties
int	buffer
	Buffer size. More...

bool	paused
	Paused. 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

QObject *	sender () 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

Echo messages coming through an Ignition transport topic.

Configuration

This plugin doesn't accept any custom configuration.

Constructor & Destructor Documentation

◆ TopicEcho()

TopicEcho ( )

Constructor.

◆ ~TopicEcho()

virtual ~TopicEcho ( )

virtual

Destructor.

Member Function Documentation

◆ AddMsg

void AddMsg ( QString _msg )

signal

Signal to add a message to the GUI list.

Parameters

[in] _msg Text message to add.

◆ Buffer()

Q_INVOKABLE int Buffer ( ) const

Get the number of messages to be buffered.

Returns: Buffer size

◆ BufferChanged

void BufferChanged ( )

signal

Notify that buffer 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] _pluginElem Element containing configuration

Reimplemented from Plugin.

◆ OnEcho

void OnEcho ( const bool _checked )

slot

Callback when echo button is pressed.

◆ Paused()

Q_INVOKABLE bool Paused ( ) const

Get whether it is paused.

Returns: True if paused

◆ PausedChanged

void PausedChanged ( )

signal

Notify that paused has changed.

◆ SetBuffer()

Q_INVOKABLE void SetBuffer ( const int & _buffer )

Set the number of messages to be buffered.

Parameters

[in] _buffer Buffer size

◆ SetPaused()

Q_INVOKABLE void SetPaused ( const bool & _paused )

Set whether to be paused.

Parameters

[in] _paused True if paused

◆ SetTopic()

Q_INVOKABLE void SetTopic ( const QString & _topic )

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

Parameters

[in] _topic Topic

◆ 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

◆ buffer

int buffer

readwrite

Buffer size.

◆ paused

bool paused

readwrite

Paused.

◆ topic

QString topic

readwrite

Topic.

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

TopicEcho.hh

Ignition Gui

API Reference

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Configuration

Constructor & Destructor Documentation

◆ TopicEcho()

◆ ~TopicEcho()

Member Function Documentation

◆ AddMsg

◆ Buffer()

◆ BufferChanged

◆ LoadConfig()

◆ OnEcho

◆ Paused()

◆ PausedChanged

◆ SetBuffer()

◆ SetPaused()

◆ SetTopic()

◆ Topic()

◆ TopicChanged

Property Documentation

◆ buffer

◆ paused

◆ topic