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

#include <TimerGUIPlugin.hh>

Public Types
typedef boost::shared_ptr< GUIPlugin >	TPtr
	plugin pointer type definition More...

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

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

void	Load (sdf::ElementPtr _elem)
	Load function. More...

virtual void	paintEvent (QPaintEvent *)

Static Public Member Functions
static TPtr	Create (const std::string &_filename, const std::string &_name)
	a class method that creates a plugin from a file name. More...

Protected Member Functions
void	LoadParam (const sdf::ElementPtr &_sdf, const std::string &_name, V &_target, V _defaultValue=V()) const
	Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found. More...

void	LoadParam (sdf::ElementPtr &_sdf, const std::string &_name, std::string &_target, const char *_defaultValue) const
	Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found. More...

Protected Attributes
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.

Member Typedef Documentation

◆ TPtr

typedef boost::shared_ptr<GUIPlugin > TPtr

inherited

plugin pointer type definition

Constructor & Destructor Documentation

◆ TimerGUIPlugin()

TimerGUIPlugin ( )

Constructor.

◆ ~TimerGUIPlugin()

virtual ~TimerGUIPlugin ( )

virtual

Destructor.

Member Function Documentation

◆ Create()

static TPtr Create	(	const std::string &	_filename,
		const std::string &	_name
	)

inlinestaticinherited

a class method that creates a plugin from a file name.

It locates the shared library and loads it dynamically.

Parameters

[in]	_filename	the path to the shared library.
[in]	_name	short name of the plugin

Returns: Shared Pointer to this class type

◆ GetCurrentTime()

common::Time GetCurrentTime ( ) const

Get the current time listed in the timer.

Returns: Gazebo time object representing the time.

◆ GetFilename()

std::string GetFilename ( ) const

inlineinherited

Get the name of the handler.

◆ GetHandle()

std::string GetHandle ( ) const

inlineinherited

Get the short name of the handler.

◆ GetType()

PluginType GetType ( ) const

inlineinherited

Returns the type of the plugin.

Returns: type of the plugin

◆ Load()

void Load ( sdf::ElementPtr )

virtual

Load function.

Called when a plugin is first created. This function should not be blocking. This function will be called with an empty sdf element when a GUI plugin is loaded via a gui.ini file or via a command line argument.

Parameters

[in] _sdf Pointer the the SDF element of the plugin. This is the plugin SDF, <plugin ...>, and its children. It will be an empty element when loaded from INI file or command line argument.

Reimplemented from GUIPlugin.

◆ LoadParam() [1/2]

void LoadParam	(	const sdf::ElementPtr &	_sdf,
		const std::string &	_name,
		V &	_target,
		V	_defaultValue = `V()`
	)		const

inlineprotectedinherited

Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found.

A message is written using gzmsg reporting whether the default value was used or not.

Parameters

[in]	_sdf	The SDF element of the plugin.
[in]	_name	Name of a tag inside the SDF.
[out]	_target	The reference to store the param value to.
[in]	_defaultValue	The default value.

◆ LoadParam() [2/2]

void LoadParam	(	sdf::ElementPtr &	_sdf,
		const std::string &	_name,
		std::string &	_target,
		const char *	_defaultValue
	)		const

inlineprotectedinherited

Load parameter value from _sdf and store it to the given reference, using the supplied default value if the element in _sdf is not found.

A message is written using gzmsg reporting whether the default value was used or not. String specialization to allow accepting const char* values for std::string parameters.

Parameters

[in]	_sdf	The SDF element of the plugin.
[in]	_name	Name of a tag inside the SDF.
[out]	_target	The reference to store the param value to.
[in]	_defaultValue	The default value.

◆ paintEvent()

virtual void paintEvent ( QPaintEvent * )

inlinevirtualinherited

◆ SetStartStopButton

void SetStartStopButton ( QString _state )

signal

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

Parameters

[in] _string State ("Start"/"Stop").

◆ SetTime

void SetTime ( QString _string )

signal

A signal used to set the sim time line edit.

Parameters

[in] _string String representation of sim time.

Member Data Documentation

◆ filename

std::string filename

protectedinherited

Path to the shared library file.

◆ handleName

std::string handleName

protectedinherited

Short name.

◆ type

PluginType type

protectedinherited

Type of plugin.

Referenced by GUIPlugin::GUIPlugin().

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

TimerGUIPlugin.hh

Public Types

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ TPtr

Constructor & Destructor Documentation

◆ TimerGUIPlugin()

◆ ~TimerGUIPlugin()

Member Function Documentation

◆ Create()

◆ GetCurrentTime()

◆ GetFilename()

◆ GetHandle()

◆ GetType()

◆ Load()

◆ LoadParam() [1/2]

◆ LoadParam() [2/2]

◆ paintEvent()

◆ SetStartStopButton

◆ SetTime

Member Data Documentation

◆ filename

◆ handleName

◆ type