maliput
|
This class represents a publish event.
It has an optional callback function (two forms are supported) to do custom handling of this event.
#include <src/maliput/drake/systems/framework/event.h>
Public Types | |
Publish Callbacks | |
Two callback signatures are supported. See Event Callbacks for a complete discussion. Both callback types receive a const reference to the context and this publish event. They differ in whether a const reference to the owning system is also provided. | |
typedef std::function< void(const Context< T > &, const PublishEvent< T > &)> | PublishCallback |
Callback without system reference. More... | |
typedef std::function< void(const System< T > &, const Context< T > &, const PublishEvent< T > &)> | SystemCallback |
Callback with const system reference. More... | |
Public Types inherited from Event< T > | |
using | TriggerType = systems::TriggerType |
Public Member Functions | |
DRAKE_DEFAULT_COPY_AND_MOVE_AND_ASSIGN (PublishEvent) | |
bool | is_discrete_update () const override |
Returns true if this is a DiscreteUpdateEvent. More... | |
PublishEvent () | |
Makes a PublishEvent with no trigger type, no event data, and no specified callback function. More... | |
PublishEvent (const PublishCallback &callback) | |
Makes a PublishEvent with no trigger type, no event data, and the specified callback function. More... | |
PublishEvent (const SystemCallback &system_callback) | |
Makes a PublishEvent with no trigger type, no event data, and the specified system callback function. More... | |
PublishEvent (const TriggerType &trigger_type, const PublishCallback &callback) | |
PublishEvent (const TriggerType &trigger_type, const SystemCallback &system_callback) | |
PublishEvent (const TriggerType &trigger_type) | |
void | handle (const System< T > &system, const Context< T > &context) const |
Calls the optional callback or system callback function, if one exists, with system , context , and this . More... | |
Public Member Functions inherited from Event< T > | |
Event () | |
virtual | ~Event () |
std::unique_ptr< Event > | Clone () const |
Clones this instance. More... | |
TriggerType | get_trigger_type () const |
Returns the trigger type. More... | |
bool | has_event_data () const |
Returns true if this event has associated data. More... | |
const EventData * | get_event_data () const |
Returns a const pointer to the event data. More... | |
EventData * | get_mutable_event_data () |
Returns a mutable pointer to the event data. More... | |
void | set_trigger_type (const TriggerType trigger_type) |
void | set_event_data (std::unique_ptr< EventData > data) |
void | AddToComposite (TriggerType trigger_type, CompositeEventCollection< T > *events) const |
Adds a clone of this event to the event collection events , with the given trigger type. More... | |
void | AddToComposite (CompositeEventCollection< T > *events) const |
Provides an alternate signature for adding an Event that already has the correct trigger type set. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from Event< T > | |
DRAKE_DEFAULT_COPY_AND_MOVE_AND_ASSIGN (Event) | |
Event (const TriggerType &trigger) | |
typedef std::function<void(const Context<T>&, const PublishEvent<T>&)> PublishCallback |
Callback without system reference.
typedef std::function<void(const System<T>&, const Context<T>&, const PublishEvent<T>&)> SystemCallback |
Callback with const system reference.
PublishEvent | ( | ) |
Makes a PublishEvent with no trigger type, no event data, and no specified callback function.
|
explicit |
Makes a PublishEvent with no trigger type, no event data, and the specified callback function.
|
explicit |
Makes a PublishEvent with no trigger type, no event data, and the specified system callback function.
PublishEvent | ( | const TriggerType & | trigger_type, |
const PublishCallback & | callback | ||
) |
PublishEvent | ( | const TriggerType & | trigger_type, |
const SystemCallback & | system_callback | ||
) |
|
explicit |
DRAKE_DEFAULT_COPY_AND_MOVE_AND_ASSIGN | ( | PublishEvent< T > | ) |
Calls the optional callback or system callback function, if one exists, with system
, context
, and this
.
|
overridevirtual |
Returns true
if this is a DiscreteUpdateEvent.
Implements Event< T >.