The EventManager is used to send/receive notifications of simulator events. More...

Public Member Functions
	EventManager ()
	Constructor. More...

	~EventManager ()
	Destructor. More...

template<typename E >
gz::common::ConnectionPtr	Connect (const typename E::CallbackT &_subscriber)
	Add a connection to an event. More...

template<typename E , typename ... Args>
void	Emit (Args &&... _args)
	Emit an event signal to connected subscribers. More...

Detailed Description

The EventManager is used to send/receive notifications of simulator events.

The simulator environment and corresponding systems can either connect to an Event or emit an Event as needed to signal actions that need to occur.

See gz::sim::events for a complete list of events.

Constructor & Destructor Documentation

EventManager ( )

Constructor.

~EventManager ( )

Destructor.

gz::common::ConnectionPtr Connect ( const typename E::CallbackT & _subscriber )

inline

Add a connection to an event.

Parameters

[in] _subscriber A std::function callback function. The function signature must match that of the event (template parameter E).

Returns: A Connection pointer, which will automatically call Disconnect when it goes out of scope.

References std::endl(), and ignerr.

void Emit ( Args &&... _args )

inline

Emit an event signal to connected subscribers.

Parameters

[in] _args function arguments to be passed to the event callbacks. Must match the signature of the event type E.

References std::endl(), and ignerr.

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