Gazebo Gui

API Reference

8.3.0

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. More...
 

Signals

void AddMsg (QString _msg)
 Signal to add a message to the GUI list. 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...
 
virtual void LoadConfig (const tinyxml2::XMLElement *_pluginElem)
 
Q_INVOKABLE bool Paused () const
 Get whether it is paused. 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...
 

Properties

bool paused
 Paused. More...
 
QString topic
 Topic. More...
 

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()

virtual ~TopicEcho ( )
virtual

Destructor.

Member Function Documentation

◆ AddMsg

void AddMsg ( QString  _msg)
signal

Signal to add a message to the GUI list.

Parameters
[in]_msgText message to add.

◆ LoadConfig()

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

◆ 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]_pausedTrue if paused

◆ 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

◆ paused

bool paused
readwrite

Paused.

◆ topic

QString topic
readwrite

Topic.


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