The EventManager is used to send/receive notifications of simulator events. More...
Public Member Functions
|template<typename E >|
|ignition::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...|
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 events for a complete list of events. TODO: if visibility is added here the MSVC is unable to compile it. The use of smart pointer inside the unordered_map (events method) is the cause of it. Maybe a compiler bug?
Constructor & Destructor Documentation
Member Function Documentation
Add a connection to an event.
[in] _subscriber A std::function callback function. The function signature must match that of the event (template parameter E).
- A Connection pointer, which will automatically call Disconnect when it goes out of scope.
References std::endl(), and ignerr.
Emit an event signal to connected subscribers.
[in] _args function arguments to be passed to the event callbacks. Must match the signature of the event type E.
References std::endl(), reference_wrapper::get(), and ignerr.
The documentation for this class was generated from the following file: