WorldStats Class Reference

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.

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

Public Member Functions
	WorldStats ()
	Constructor.
	~WorldStats () override
	Destructor.
Q_INVOKABLE QString	Iterations () const
	Get the message type as a string, for example.
void	LoadConfig (const tinyxml2::XMLElement *_pluginElem) override
Q_INVOKABLE QString	RealTime () const
	Get the message type as a string, for example.
Q_INVOKABLE QString	RealTimeFactor () const
	Get the message type as a string, for example.
Q_INVOKABLE void	SetIterations (const QString &_iterations)
	Set the message type from a string, for example.
Q_INVOKABLE void	SetRealTime (const QString &_realTime)
	Set the message type from a string, for example.
Q_INVOKABLE void	SetRealTimeFactor (const QString &_realTimeFactor)
	Set the message type from a string, for example.
Q_INVOKABLE void	SetSimTime (const QString &_simTime)
	Set the message type from a string, for example.
Q_INVOKABLE QString	SimTime () const
	Get the message type as a string, for example.

Properties
QString	iterations
	Iterations.
QString	realTime
	Real time.
QString	realTimeFactor
	Real time factor.
QString	simTime
	Sim time.

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

WorldStats

(

)

Constructor.

~WorldStats()

~WorldStats ( )

override

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 )

override

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]

_iterations

Message type

SetRealTime()

Q_INVOKABLE void SetRealTime

(

const QString &

_realTime

)

Set the message type from a string, for example.

Parameters

[in]

_realTime

Message type

SetRealTimeFactor()

Q_INVOKABLE void SetRealTimeFactor

(

const QString &

_realTimeFactor

)

Set the message type from a string, for example.

Parameters

[in]

_realTimeFactor

Message type

SetSimTime()

Q_INVOKABLE void SetSimTime

(

const QString &

_simTime

)

Set the message type from a string, for example.

Parameters

[in]

_simTime

Message 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:

• WorldStats.hh