Events

Namespaces
namespace	gazebo::event
	Event namespace.

Classes
class	gazebo::event::Connection
	A class that encapsulates a connection. More...
class	gazebo::event::Event
	Base class for all events. More...
class	gazebo::event::Events
	An Event class to get notifications for simulator events. More...
class	gazebo::event::EventT< T >
	A class for event processing. More...

Functions
virtual	gazebo::event::EventT< T >::~EventT ()
	Destructor.
ConnectionPtr	gazebo::event::EventT< T >::Connect (const boost::function< T > &_subscriber)
	Connect a callback to this event.
unsigned int	gazebo::event::EventT< T >::ConnectionCount () const
	Get the number of connections.
virtual void	gazebo::event::EventT< T >::Disconnect (ConnectionPtr _c)
	Disconnect a callback to this event.
virtual void	gazebo::event::EventT< T >::Disconnect (int _id)
	Disconnect a callback to this event.

Detailed Description

Function Documentation

template<typename T >

gazebo::event::EventT< T >::~EventT ( )

virtual

Destructor.

Destructor. Deletes all the associated connections.

template<typename T>

ConnectionPtr gazebo::event::EventT< T >::Connect

(

const boost::function< T > &

_subscriber

)

Connect a callback to this event.

Adds a connection.

Parameters

[in]

_subscriber

Pointer to a callback function

Returns

A Connection object, which will automatically call Disconnect when it goes out of scope

Parameters

[in]

_subscriber

the subscriber to connect

Referenced by gazebo::event::Events::ConnectAddEntity(), gazebo::physics::Collision::ConnectContact(), gazebo::event::Events::ConnectCreateEntity(), gazebo::rendering::Events::ConnectCreateScene(), gazebo::event::Events::ConnectDeleteEntity(), gazebo::event::Events::ConnectDiagTimerStart(), gazebo::event::Events::ConnectDiagTimerStop(), gazebo::physics::Link::ConnectEnabled(), gazebo::physics::Joint::ConnectJointUpdate(), gazebo::rendering::DepthCamera::ConnectNewDepthFrame(), gazebo::rendering::Camera::ConnectNewImageFrame(), gazebo::rendering::GpuLaser::ConnectNewLaserFrame(), gazebo::physics::MultiRayShape::ConnectNewLaserScans(), gazebo::rendering::DepthCamera::ConnectNewRGBPointCloud(), gazebo::event::Events::ConnectPause(), gazebo::event::Events::ConnectPostRender(), gazebo::event::Events::ConnectPreRender(), gazebo::rendering::Events::ConnectRemoveScene(), gazebo::event::Events::ConnectRender(), gazebo::event::Events::ConnectSetSelectedEntity(), gazebo::event::Events::ConnectStep(), gazebo::event::Events::ConnectStop(), gazebo::transport::Connection::ConnectToShutdown(), gazebo::sensors::Sensor::ConnectUpdated(), gazebo::rendering::Events::ConnectViewContacts(), gazebo::event::Events::ConnectWorldCreated(), gazebo::event::Events::ConnectWorldUpdateEnd(), and gazebo::event::Events::ConnectWorldUpdateStart().

template<typename T >

unsigned int gazebo::event::EventT< T >::ConnectionCount

(

)

const

Get the number of connections.

Returns

Number of connection to this Event.

template<typename T >

void gazebo::event::EventT< T >::Disconnect ( ConnectionPtr  _c )

virtual

Disconnect a callback to this event.

Removes a connection.

Parameters

[in]	_c	The connection to disconnect
[in]	_c	the connection

Implements gazebo::event::Event.

References gazebo::event::Connection::GetId(), and NULL.

Referenced by gazebo::event::Events::DisconnectAddEntity(), gazebo::physics::Collision::DisconnectContact(), gazebo::event::Events::DisconnectCreateEntity(), gazebo::rendering::Events::DisconnectCreateScene(), gazebo::event::Events::DisconnectDeleteEntity(), gazebo::event::Events::DisconnectDiagTimerStart(), gazebo::event::Events::DisconnectDiagTimerStop(), gazebo::physics::Link::DisconnectEnabled(), gazebo::physics::Joint::DisconnectJointUpdate(), gazebo::rendering::DepthCamera::DisconnectNewDepthFrame(), gazebo::rendering::Camera::DisconnectNewImageFrame(), gazebo::rendering::GpuLaser::DisconnectNewLaserFrame(), gazebo::physics::MultiRayShape::DisconnectNewLaserScans(), gazebo::rendering::DepthCamera::DisconnectNewRGBPointCloud(), gazebo::event::Events::DisconnectPause(), gazebo::event::Events::DisconnectPostRender(), gazebo::event::Events::DisconnectPreRender(), gazebo::rendering::Events::DisconnectRemoveScene(), gazebo::event::Events::DisconnectRender(), gazebo::event::Events::DisconnectSetSelectedEntity(), gazebo::transport::Connection::DisconnectShutdown(), gazebo::event::Events::DisconnectStep(), gazebo::event::Events::DisconnectStop(), gazebo::sensors::Sensor::DisconnectUpdated(), gazebo::rendering::Events::DisconnectViewContacts(), gazebo::event::Events::DisconnectWorldCreated(), gazebo::event::Events::DisconnectWorldUpdateEnd(), and gazebo::event::Events::DisconnectWorldUpdateStart().

template<typename T >

void gazebo::event::EventT< T >::Disconnect ( int  _id )

virtual

Disconnect a callback to this event.

Removes a connection.

Parameters

[in]	_id	The id of the connection to disconnect
[in]	_id	the connection index

Implements gazebo::event::Event.