TopicEcho Class Reference

Echo messages coming through a Gazebo Transport topic. More...

#include <TopicEcho.hh>

Public Slots
void	OnBuffer (const unsigned int _steps)
void	OnEcho (const bool _checked)
	Callback when echo button is pressed.

Signals
void	AddMsg (QString _msg)
	Signal to add a message to the GUI list.
void	PausedChanged ()
	Notify that paused has changed.
void	TopicChanged ()
	Notify that topic has changed.

Public Member Functions
	TopicEcho ()
	Constructor.
	~TopicEcho () override
	Destructor.
void	LoadConfig (const tinyxml2::XMLElement *_pluginElem) override
Q_INVOKABLE bool	Paused () const
	Get whether it is paused.
Q_INVOKABLE void	SetPaused (const bool &_paused)
	Set whether to be paused.
Q_INVOKABLE void	SetTopic (const QString &_topic)
	Set the topic from a string, for example '/echo'.
Q_INVOKABLE QString	Topic () const
	Get the topic as a string, for example '/echo'.

Properties
bool	paused
	Paused.
QString	topic
	Topic.

Detailed Description

Echo messages coming through a Gazebo Transport topic.

Configuration

This plugin doesn't accept any custom configuration.

Constructor & Destructor Documentation

TopicEcho()

TopicEcho

(

)

Constructor.

~TopicEcho()

~TopicEcho ( )

override

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.

LoadConfig()

void LoadConfig ( const tinyxml2::XMLElement *  _pluginElem )

override

OnBuffer

void OnBuffer ( const unsigned int  _steps )

slot

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.

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

paused

bool paused

readwrite

Paused.

topic

QString topic

readwrite

Topic.

---

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

• TopicEcho.hh