Gazebo Gui

API Reference

3.12.0

This plugin provides a time panel which may display: More...

#include <WorldStats.hh>

Public Slots

void ProcessMsg ()
 Callback in main thread when diagnostics come in. More...
 

Signals

void IterationsChanged ()
 Notify that message type has changed. More...
 
void RealTimeChanged ()
 Notify that message type has changed. More...
 
void RealTimeFactorChanged ()
 Notify that message type has changed. More...
 
void SimTimeChanged ()
 Notify that message type has changed. More...
 

Public Member Functions

 WorldStats ()
 Constructor. More...
 
virtual ~WorldStats ()
 Destructor. More...
 
Q_INVOKABLE QString Iterations () const
 Get the message type as a string, for example. More...
 
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 RealTime () const
 Get the message type as a string, for example. More...
 
Q_INVOKABLE QString RealTimeFactor () const
 Get the message type as a string, for example. More...
 
Q_INVOKABLE void SetIterations (const QString &_iterations)
 Set the message type from a string, for example. More...
 
Q_INVOKABLE void SetRealTime (const QString &_realTime)
 Set the message type from a string, for example. More...
 
Q_INVOKABLE void SetRealTimeFactor (const QString &_realTimeFactor)
 Set the message type from a string, for example. More...
 
Q_INVOKABLE void SetSimTime (const QString &_simTime)
 Set the message type from a string, for example. More...
 
Q_INVOKABLE QString SimTime () const
 Get the message type as a string, for example. 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 char *signal, const QObject *receiver, const char *method)
 
bool disconnect (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

QString iterations
 Iterations. More...
 
QString realTime
 Real time. More...
 
QString realTimeFactor
 Real time factor. More...
 
QString simTime
 Sim time. 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

This plugin provides a time panel which may display:

  • Simulation time
  • Real time
  • Real time factor
  • Iterations

Configuration

  • <sim_time> : Set to true to display a sim time widget, false by default.
  • <real_time> : True to display a real time widget, false by default.
  • <real_time_factor> : True to display a real time factor widget, false by default.
  • <iterations> : True to display an iterations widget, false by default.
  • <topic> : Topic to receive world statistics, optional. If not present, the plugin will attempt to create a topic with the main window's worldName property.

If no elements are filled for the plugin, all properties will be displayed.

Constructor & Destructor Documentation

◆ WorldStats()

Constructor.

◆ ~WorldStats()

virtual ~WorldStats ( )
virtual

Destructor.

Member Function Documentation

◆ Iterations()

Q_INVOKABLE QString Iterations ( ) const

Get the message type as a string, for example.

Returns
Message type

◆ IterationsChanged

void IterationsChanged ( )
signal

Notify that message type has changed.

◆ LoadConfig()

void LoadConfig ( const tinyxml2::XMLElement *  _pluginElem)
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.

◆ ProcessMsg

void ProcessMsg ( )
slot

Callback in main thread when diagnostics come in.

◆ RealTime()

Q_INVOKABLE QString RealTime ( ) const

Get the message type as a string, for example.

Returns
Message type

◆ RealTimeChanged

void RealTimeChanged ( )
signal

Notify that message type has changed.

◆ RealTimeFactor()

Q_INVOKABLE QString RealTimeFactor ( ) const

Get the message type as a string, for example.

Returns
Message type

◆ RealTimeFactorChanged

void RealTimeFactorChanged ( )
signal

Notify that message type has changed.

◆ SetIterations()

Q_INVOKABLE void SetIterations ( const QString _iterations)

Set the message type from a string, for example.

Parameters
[in]_iterationsMessage type

◆ SetRealTime()

Q_INVOKABLE void SetRealTime ( const QString _realTime)

Set the message type from a string, for example.

Parameters
[in]_realTimeMessage type

◆ SetRealTimeFactor()

Q_INVOKABLE void SetRealTimeFactor ( const QString _realTimeFactor)

Set the message type from a string, for example.

Parameters
[in]_realTimeFactorMessage type

◆ SetSimTime()

Q_INVOKABLE void SetSimTime ( const QString _simTime)

Set the message type from a string, for example.

Parameters
[in]_simTimeMessage type

◆ SimTime()

Q_INVOKABLE QString SimTime ( ) const

Get the message type as a string, for example.

Returns
Message type

◆ SimTimeChanged

void SimTimeChanged ( )
signal

Notify that message type has changed.

Property Documentation

◆ iterations

QString iterations
readwrite

Iterations.

◆ realTime

QString realTime
readwrite

Real time.

◆ realTimeFactor

QString realTimeFactor
readwrite

Real time factor.

◆ simTime

QString simTime
readwrite

Sim time.


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