gazebo::TimerGUIPlugin Class Reference

A GUI plugin that displays a timer. More...

#include <TimerGUIPlugin.hh>

Inheritance diagram for gazebo::TimerGUIPlugin:

Signals
void	SetStartStopButton (QString _state)
	A signal used to set the style of the start/stop button. More...
void	SetTime (QString _string)
	A signal used to set the sim time line edit. More...

Public Member Functions
	TimerGUIPlugin ()
	Constructor. More...
virtual	~TimerGUIPlugin ()
	Destructor. More...
common::Time	GetCurrentTime () const
	Get the current time listed in the timer. More...
void	Load (sdf::ElementPtr _elem)
	Load function. More...
Public Member Functions inherited from gazebo::GUIPlugin
	GUIPlugin ()
Public Member Functions inherited from gazebo::PluginT< GUIPlugin >
	PluginT ()
	Constructor. More...
virtual	~PluginT ()
	Destructor. More...
std::string	GetFilename () const
	Get the name of the handler. More...
std::string	GetHandle () const
	Get the short name of the handler. More...
PluginType	GetType () const
	Returns the type of the plugin. More...

Additional Inherited Members
Public Types inherited from gazebo::PluginT< GUIPlugin >
typedef boost::shared_ptr < GUIPlugin >	TPtr
	plugin pointer type definition More...
Static Public Member Functions inherited from gazebo::PluginT< GUIPlugin >
static TPtr	Create (const std::string &_filename, const std::string &_name)
	a class method that creates a plugin from a file name. More...
Protected Attributes inherited from gazebo::PluginT< GUIPlugin >
std::string	filename
	Path to the shared library file. More...
std::string	handleName
	Short name. More...
PluginType	type
	Type of plugin. More...

Detailed Description

A GUI plugin that displays a timer.

Control of this timer is managed via a topic that is ~/timer_control by default. The topic may be specified in the plugin's SDF. The topic receives string messages where:

"start" == start the timer
"stop" == stop the timer
"reset" == reset the timer

<plugin name="timer_plugin" filename="libTimerGUIPlugin.so"> <topic>~/my_timer_control</topic> <pos>pixel_x_pos pixel_y_pos</pos> <size>pixel_width pixel_height</size> <start_stop_button>visible</start_stop_button> <reset_button>visible</reset_button> </plugin>

Note that the size has to be large enough to fit all widgets.

Constructor & Destructor Documentation

gazebo::TimerGUIPlugin::TimerGUIPlugin

(

)

Constructor.

virtual gazebo::TimerGUIPlugin::~TimerGUIPlugin ( )

virtual

Destructor.

Member Function Documentation

common::Time gazebo::TimerGUIPlugin::GetCurrentTime

(

)

const

Get the current time listed in the timer.

Returns

Gazebo time object representing the time.

void gazebo::TimerGUIPlugin::Load ( sdf::ElementPtr  )

virtual

Load function.

Called when a plugin is first created. This function should not be blocking. This function is only called when a GUI plugin is loaded from an SDF file. This function is not called when a GUI plugin is loaded via a gui.ini file.

Parameters

[in]

_sdf

Pointer the the SDF element of the plugin. This is the plugin SDF, <plugin ...>, and its children.

Reimplemented from gazebo::GUIPlugin.

void gazebo::TimerGUIPlugin::SetStartStopButton ( QString  _state )

signal

A signal used to set the style of the start/stop button.

Parameters

[in]

_string

State ("Start"/"Stop").

void gazebo::TimerGUIPlugin::SetTime ( QString  _string )

signal

A signal used to set the sim time line edit.

Parameters

[in]

_string

String representation of sim time.

---

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

• TimerGUIPlugin.hh