All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Static Public Member Functions | Static Public Attributes | List of all members
gazebo::event::Events Class Reference

An Event class to get notifications for simulator events. More...

#include <common/common.hh>

Static Public Member Functions

template<typename T >
static ConnectionPtr ConnectAddEntity (T _subscriber)
 Connect a boost::slot the the add entity signal. More...
 
template<typename T >
static ConnectionPtr ConnectCreateEntity (T _subscriber)
 Connect a boost::slot the the add entity signal. More...
 
template<typename T >
static ConnectionPtr ConnectDeleteEntity (T _subscriber)
 Connect a boost::slot the delete entity. More...
 
template<typename T >
static ConnectionPtr ConnectDiagTimerStart (T _subscriber)
 Connect a boost::slot the diagnostic timer start signal. More...
 
template<typename T >
static ConnectionPtr ConnectDiagTimerStop (T _subscriber)
 Connect a boost::slot the diagnostic timer stop signal. More...
 
template<typename T >
static ConnectionPtr ConnectPause (T _subscriber)
 Connect a boost::slot the the pause signal. More...
 
template<typename T >
static ConnectionPtr ConnectPostRender (T _subscriber)
 Connect a boost::slot the post render update signal. More...
 
template<typename T >
static ConnectionPtr ConnectPreRender (T _subscriber)
 Render start signal. More...
 
template<typename T >
static ConnectionPtr ConnectRender (T _subscriber)
 Connect a boost::slot the render update signal. More...
 
template<typename T >
static ConnectionPtr ConnectSetSelectedEntity (T _subscriber)
 Connect a boost::slot the set selected entity. More...
 
template<typename T >
static ConnectionPtr ConnectSigInt (T _subscriber)
 Connect a boost::slot to the sigint event. More...
 
template<typename T >
static ConnectionPtr ConnectStep (T _subscriber)
 Connect a boost::slot the the step signal. More...
 
template<typename T >
static ConnectionPtr ConnectStop (T _subscriber)
 Connect a boost::slot the the stop signal. More...
 
template<typename T >
static ConnectionPtr ConnectWorldCreated (T _subscriber)
 Connect a boost::slot the the world created signal. More...
 
template<typename T >
static ConnectionPtr ConnectWorldUpdateBegin (T _subscriber)
 Connect a boost::slot the the world update start signal. More...
 
template<typename T >
static ConnectionPtr ConnectWorldUpdateEnd (T _subscriber)
 Connect a boost::slot the the world update end signal. More...
 
static void DisconnectAddEntity (ConnectionPtr _subscriber)
 Disconnect a boost::slot the the add entity signal. More...
 
static void DisconnectCreateEntity (ConnectionPtr _subscriber)
 Disconnect a boost::slot the the add entity signal. More...
 
static void DisconnectDeleteEntity (ConnectionPtr _subscriber)
 Disconnect a boost::slot the delete entity. More...
 
static void DisconnectDiagTimerStart (ConnectionPtr _subscriber)
 Disconnect a boost::slot the diagnostic timer start signal. More...
 
static void DisconnectDiagTimerStop (ConnectionPtr _subscriber)
 Disconnect a boost::slot the diagnostic timer stop signal. More...
 
static void DisconnectPause (ConnectionPtr _subscriber)
 Disconnect a boost::slot the the pause signal. More...
 
static void DisconnectPostRender (ConnectionPtr _subscriber)
 Disconnect a boost::slot the post render update signal. More...
 
static void DisconnectPreRender (ConnectionPtr _subscriber)
 Disconnect a render start signal. More...
 
static void DisconnectRender (ConnectionPtr _subscriber)
 Disconnect a boost::slot the render update signal. More...
 
static void DisconnectSetSelectedEntity (ConnectionPtr _subscriber)
 Disconnect a boost::slot the set selected entity. More...
 
static void DisconnectSigInt (ConnectionPtr _subscriber)
 Disconnect a boost::slot to the sigint event. More...
 
static void DisconnectStep (ConnectionPtr _subscriber)
 Disconnect a boost::slot the the step signal. More...
 
static void DisconnectStop (ConnectionPtr _subscriber)
 Disconnect a boost::slot the the stop signal. More...
 
static void DisconnectWorldCreated (ConnectionPtr _subscriber)
 Disconnect a boost::slot the the world created signal. More...
 
static void DisconnectWorldUpdateBegin (ConnectionPtr _subscriber)
 Disconnect a boost::slot the the world update start signal. More...
 
static void DisconnectWorldUpdateEnd (ConnectionPtr _subscriber)
 Disconnect a boost::slot the the world update end signal. More...
 

Static Public Attributes

static EventT< void(std::string)> addEntity
 An entity has been added. More...
 
static EventT< void(std::string)> deleteEntity
 An entity has been deleted. More...
 
static EventT< void(std::string)> diagTimerStart
 Diagnostic timer start. More...
 
static EventT< void(std::string)> diagTimerStop
 Diagnostic timer stop. More...
 
static EventT< void(std::string)> entityCreated
 An entity has been created. More...
 
static EventT< void(bool)> pause
 Pause signal. More...
 
static EventT< void()> postRender
 Post-Render. More...
 
static EventT< void()> preRender
 Pre-render. More...
 
static EventT< void()> render
 Render. More...
 
static EventT< void(std::string,
std::string)> 
setSelectedEntity
 An entity has been selected. More...
 
static EventT< void()> sigInt
 Simulation stop signal. More...
 
static EventT< void()> step
 Step the simulation once signal. More...
 
static EventT< void()> stop
 Simulation stop signal. More...
 
static EventT< void(std::string)> worldCreated
 A world has been created. More...
 
static EventT< void(const
common::UpdateInfo &)> 
worldUpdateBegin
 World update has started. More...
 
static EventT< void()> worldUpdateEnd
 World update has ended. More...
 

Detailed Description

An Event class to get notifications for simulator events.

Member Function Documentation

template<typename T >
static ConnectionPtr gazebo::event::Events::ConnectAddEntity ( _subscriber)
inlinestatic

Connect a boost::slot the the add entity signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

References addEntity, and gazebo::event::EventT< T >::Connect().

template<typename T >
static ConnectionPtr gazebo::event::Events::ConnectCreateEntity ( _subscriber)
inlinestatic

Connect a boost::slot the the add entity signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

References gazebo::event::EventT< T >::Connect(), and entityCreated.

template<typename T >
static ConnectionPtr gazebo::event::Events::ConnectDeleteEntity ( _subscriber)
inlinestatic

Connect a boost::slot the delete entity.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

References gazebo::event::EventT< T >::Connect(), and deleteEntity.

template<typename T >
static ConnectionPtr gazebo::event::Events::ConnectDiagTimerStart ( _subscriber)
inlinestatic

Connect a boost::slot the diagnostic timer start signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

References gazebo::event::EventT< T >::Connect(), and diagTimerStart.

template<typename T >
static ConnectionPtr gazebo::event::Events::ConnectDiagTimerStop ( _subscriber)
inlinestatic

Connect a boost::slot the diagnostic timer stop signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

References gazebo::event::EventT< T >::Connect(), and diagTimerStop.

template<typename T >
static ConnectionPtr gazebo::event::Events::ConnectPause ( _subscriber)
inlinestatic

Connect a boost::slot the the pause signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

References gazebo::event::EventT< T >::Connect(), and pause.

template<typename T >
static ConnectionPtr gazebo::event::Events::ConnectPostRender ( _subscriber)
inlinestatic

Connect a boost::slot the post render update signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

References gazebo::event::EventT< T >::Connect(), and postRender.

template<typename T >
static ConnectionPtr gazebo::event::Events::ConnectPreRender ( _subscriber)
inlinestatic

Render start signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

References gazebo::event::EventT< T >::Connect(), and preRender.

template<typename T >
static ConnectionPtr gazebo::event::Events::ConnectRender ( _subscriber)
inlinestatic

Connect a boost::slot the render update signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

References gazebo::event::EventT< T >::Connect(), and render.

template<typename T >
static ConnectionPtr gazebo::event::Events::ConnectSetSelectedEntity ( _subscriber)
inlinestatic

Connect a boost::slot the set selected entity.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

References gazebo::event::EventT< T >::Connect(), and setSelectedEntity.

template<typename T >
static ConnectionPtr gazebo::event::Events::ConnectSigInt ( _subscriber)
inlinestatic

Connect a boost::slot to the sigint event.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

References gazebo::event::EventT< T >::Connect(), and sigInt.

template<typename T >
static ConnectionPtr gazebo::event::Events::ConnectStep ( _subscriber)
inlinestatic

Connect a boost::slot the the step signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

References gazebo::event::EventT< T >::Connect(), and step.

template<typename T >
static ConnectionPtr gazebo::event::Events::ConnectStop ( _subscriber)
inlinestatic

Connect a boost::slot the the stop signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

References gazebo::event::EventT< T >::Connect(), and stop.

template<typename T >
static ConnectionPtr gazebo::event::Events::ConnectWorldCreated ( _subscriber)
inlinestatic

Connect a boost::slot the the world created signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

References gazebo::event::EventT< T >::Connect(), and worldCreated.

template<typename T >
static ConnectionPtr gazebo::event::Events::ConnectWorldUpdateBegin ( _subscriber)
inlinestatic

Connect a boost::slot the the world update start signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

References gazebo::event::EventT< T >::Connect(), and worldUpdateBegin.

template<typename T >
static ConnectionPtr gazebo::event::Events::ConnectWorldUpdateEnd ( _subscriber)
inlinestatic

Connect a boost::slot the the world update end signal.

Parameters
[in]_subscriberthe subscriber to this event
Returns
a connection

References gazebo::event::EventT< T >::Connect(), and worldUpdateEnd.

static void gazebo::event::Events::DisconnectAddEntity ( ConnectionPtr  _subscriber)
inlinestatic

Disconnect a boost::slot the the add entity signal.

Parameters
[in]_subscriberthe subscriber to this event

References addEntity, and gazebo::event::EventT< T >::Disconnect().

static void gazebo::event::Events::DisconnectCreateEntity ( ConnectionPtr  _subscriber)
inlinestatic

Disconnect a boost::slot the the add entity signal.

Parameters
[in]_subscriberthe subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and entityCreated.

static void gazebo::event::Events::DisconnectDeleteEntity ( ConnectionPtr  _subscriber)
inlinestatic

Disconnect a boost::slot the delete entity.

Parameters
[in]_subscriberthe subscriber to this event

References deleteEntity, and gazebo::event::EventT< T >::Disconnect().

static void gazebo::event::Events::DisconnectDiagTimerStart ( ConnectionPtr  _subscriber)
inlinestatic

Disconnect a boost::slot the diagnostic timer start signal.

Parameters
[in]_subscriberthe subscriber to this event

References diagTimerStart, and gazebo::event::EventT< T >::Disconnect().

static void gazebo::event::Events::DisconnectDiagTimerStop ( ConnectionPtr  _subscriber)
inlinestatic

Disconnect a boost::slot the diagnostic timer stop signal.

Parameters
[in]_subscriberthe subscriber to this event

References diagTimerStop, and gazebo::event::EventT< T >::Disconnect().

static void gazebo::event::Events::DisconnectPause ( ConnectionPtr  _subscriber)
inlinestatic

Disconnect a boost::slot the the pause signal.

Parameters
[in]_subscriberthe subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and pause.

static void gazebo::event::Events::DisconnectPostRender ( ConnectionPtr  _subscriber)
inlinestatic

Disconnect a boost::slot the post render update signal.

Parameters
[in]_subscriberthe subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and postRender.

static void gazebo::event::Events::DisconnectPreRender ( ConnectionPtr  _subscriber)
inlinestatic

Disconnect a render start signal.

Parameters
[in]_subscriberthe subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and preRender.

static void gazebo::event::Events::DisconnectRender ( ConnectionPtr  _subscriber)
inlinestatic

Disconnect a boost::slot the render update signal.

Parameters
[in]_subscriberthe subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and render.

static void gazebo::event::Events::DisconnectSetSelectedEntity ( ConnectionPtr  _subscriber)
inlinestatic

Disconnect a boost::slot the set selected entity.

Parameters
[in]_subscriberthe subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and setSelectedEntity.

static void gazebo::event::Events::DisconnectSigInt ( ConnectionPtr  _subscriber)
inlinestatic

Disconnect a boost::slot to the sigint event.

Parameters
[in]_subscriberthe subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and sigInt.

static void gazebo::event::Events::DisconnectStep ( ConnectionPtr  _subscriber)
inlinestatic

Disconnect a boost::slot the the step signal.

Parameters
[in]_subscriberthe subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and step.

static void gazebo::event::Events::DisconnectStop ( ConnectionPtr  _subscriber)
inlinestatic

Disconnect a boost::slot the the stop signal.

Parameters
[in]_subscriberthe subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and stop.

static void gazebo::event::Events::DisconnectWorldCreated ( ConnectionPtr  _subscriber)
inlinestatic

Disconnect a boost::slot the the world created signal.

References gazebo::event::EventT< T >::Disconnect(), and worldCreated.

static void gazebo::event::Events::DisconnectWorldUpdateBegin ( ConnectionPtr  _subscriber)
static

Disconnect a boost::slot the the world update start signal.

Parameters
[in]_subscriberthe subscriber to this event
static void gazebo::event::Events::DisconnectWorldUpdateEnd ( ConnectionPtr  _subscriber)
inlinestatic

Disconnect a boost::slot the the world update end signal.

Parameters
[in]_subscriberthe subscriber to this event

References gazebo::event::EventT< T >::Disconnect(), and worldUpdateEnd.

Member Data Documentation

EventT<void (std::string)> gazebo::event::Events::addEntity
static

An entity has been added.

Referenced by ConnectAddEntity(), and DisconnectAddEntity().

EventT<void (std::string)> gazebo::event::Events::deleteEntity
static

An entity has been deleted.

Referenced by ConnectDeleteEntity(), and DisconnectDeleteEntity().

EventT<void (std::string)> gazebo::event::Events::diagTimerStart
static

Diagnostic timer start.

Referenced by ConnectDiagTimerStart(), and DisconnectDiagTimerStart().

EventT<void (std::string)> gazebo::event::Events::diagTimerStop
static

Diagnostic timer stop.

Referenced by ConnectDiagTimerStop(), and DisconnectDiagTimerStop().

EventT<void (std::string)> gazebo::event::Events::entityCreated
static

An entity has been created.

Referenced by ConnectCreateEntity(), and DisconnectCreateEntity().

EventT<void (bool)> gazebo::event::Events::pause
static

Pause signal.

Referenced by ConnectPause(), and DisconnectPause().

EventT<void ()> gazebo::event::Events::postRender
static

Post-Render.

Referenced by ConnectPostRender(), and DisconnectPostRender().

EventT<void ()> gazebo::event::Events::preRender
static

Pre-render.

Referenced by ConnectPreRender(), and DisconnectPreRender().

EventT<void ()> gazebo::event::Events::render
static

Render.

Referenced by ConnectRender(), and DisconnectRender().

EventT<void (std::string, std::string)> gazebo::event::Events::setSelectedEntity
static

An entity has been selected.

Referenced by ConnectSetSelectedEntity(), and DisconnectSetSelectedEntity().

EventT<void ()> gazebo::event::Events::sigInt
static

Simulation stop signal.

Referenced by ConnectSigInt(), and DisconnectSigInt().

EventT<void ()> gazebo::event::Events::step
static

Step the simulation once signal.

Referenced by ConnectStep(), and DisconnectStep().

EventT<void ()> gazebo::event::Events::stop
static

Simulation stop signal.

Referenced by ConnectStop(), and DisconnectStop().

EventT<void (std::string)> gazebo::event::Events::worldCreated
static

A world has been created.

Referenced by ConnectWorldCreated(), and DisconnectWorldCreated().

EventT<void (const common::UpdateInfo &)> gazebo::event::Events::worldUpdateBegin
static

World update has started.

Referenced by ConnectWorldUpdateBegin().

EventT<void ()> gazebo::event::Events::worldUpdateEnd
static

World update has ended.

Referenced by ConnectWorldUpdateEnd(), and DisconnectWorldUpdateEnd().


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