Events

Namespaces
	gazebo::event
	Event namespace.

Classes
class	gazebo::event::Connection
	A class that encapsulates a connection. More...
class	gazebo::event::ConnectionPrivate
class	gazebo::event::Event
	Base class for all events. More...
class	gazebo::event::EventConnection< T >
class	gazebo::event::EventPrivate
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...
class	gazebo::event::EventTPrivate< T >

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

Detailed Description

Function Documentation

template<typename T >

gazebo::event::EventT< T >::EventT

(

)

Constructor.

References gazebo::event::Event::dataPtr.

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::SimEventConnector::ConnectSpawnModel().

template<typename T >

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

(

)

const

Get the number of connections.

Returns

Number of connection to this Event.

Number of connections.

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

Referenced by gazebo::SimEventConnector::DisconnectSpawnModel().

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.