|
Drake
|
|
Drake
|
CompositeEventCollection for a Diagram.
End users should never need to use or know about this class. It is for internal use only.
#include <drake/systems/framework/event_collection.h>
Public Member Functions | |
| DiagramCompositeEventCollection (std::vector< std::unique_ptr< CompositeEventCollection< T >>> subevents) | |
Allocated CompositeEventCollection for all constituent subsystems are passed in subevents (a vector of size of the number of subsystems of the corresponding diagram), for which ownership is also transferred to this. More... | |
| int | num_subsystems () const |
| Returns the number of subsystems for which this object contains event collections. More... | |
| CompositeEventCollection< T > & | get_mutable_subevent_collection (int index) |
| const CompositeEventCollection< T > & | get_subevent_collection (int index) const |
Does not allow copy, move, or assignment | |
| DiagramCompositeEventCollection (const DiagramCompositeEventCollection &)=delete | |
| DiagramCompositeEventCollection & | operator= (const DiagramCompositeEventCollection &)=delete |
| DiagramCompositeEventCollection (DiagramCompositeEventCollection &&)=delete | |
| DiagramCompositeEventCollection & | operator= (DiagramCompositeEventCollection &&)=delete |
 Public Member Functions inherited from CompositeEventCollection< T > | |
| virtual | ~CompositeEventCollection () |
| void | Clear () |
| Clears all the events. More... | |
| bool | HasEvents () const |
Returns true if and only if this collection contains any events. More... | |
| bool | HasPublishEvents () const |
Returns true if and only if this collection contains one or more publish events. More... | |
| bool | HasDiscreteUpdateEvents () const |
Returns true if and only if this collection contains one or more discrete update events. More... | |
| bool | HasUnrestrictedUpdateEvents () const |
Returns true if and only if this collection contains one or more unrestricted update events. More... | |
| void | AddPublishEvent (PublishEvent< T > event) |
Assuming the internal publish event collection is an instance of LeafEventCollection, adds the publish event event (ownership is also transferred) to it. More... | |
| void | AddDiscreteUpdateEvent (DiscreteUpdateEvent< T > event) |
Assuming the internal discrete update event collection is an instance of LeafEventCollection, adds the discrete update event event (ownership is also transferred) to it. More... | |
| void | AddUnrestrictedUpdateEvent (UnrestrictedUpdateEvent< T > event) |
Assuming the internal unrestricted update event collection is an instance of LeafEventCollection, adds the unrestricted update event event (ownership is also transferred) to it. More... | |
| void | AddToEnd (const CompositeEventCollection< T > &other) |
Adds the contained homogeneous event collections (e.g., EventCollection<PublishEvent<T>>, EventCollection<DiscreteUpdateEvent<T>>, etc.) from other to the end of this. More... | |
| void | SetFrom (const CompositeEventCollection< T > &other) |
Copies the collections of homogeneous events from other to this. More... | |
| const EventCollection< PublishEvent< T > > & | get_publish_events () const |
| Returns a const reference to the collection of publish events. More... | |
| const EventCollection< DiscreteUpdateEvent< T > > & | get_discrete_update_events () const |
| Returns a const reference to the collection of discrete update events. More... | |
| const EventCollection< UnrestrictedUpdateEvent< T > > & | get_unrestricted_update_events () const |
| Returns a const reference to the collection of unrestricted update events. More... | |
| EventCollection< PublishEvent< T > > & | get_mutable_publish_events () const |
| Returns a mutable reference to the collection of publish events. More... | |
| EventCollection< DiscreteUpdateEvent< T > > & | get_mutable_discrete_update_events () const |
| Returns a mutable reference to the collection of discrete update events. More... | |
| EventCollection< UnrestrictedUpdateEvent< T > > & | get_mutable_unrestricted_update_events () const |
| Returns a mutable reference to the collection of unrestricted update events. More... | |
| CompositeEventCollection (const CompositeEventCollection &)=delete | |
| CompositeEventCollection & | operator= (const CompositeEventCollection &)=delete |
| CompositeEventCollection (CompositeEventCollection &&)=delete | |
| CompositeEventCollection & | operator= (CompositeEventCollection &&)=delete |
| internal::SystemId | get_system_id () const |
| (Internal use only) Gets the id of the subsystem that created this collection. More... | |
| void | set_system_id (internal::SystemId id) |
| (Internal use only) Records the id of the subsystem that created this collection. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from CompositeEventCollection< T > | |
| CompositeEventCollection (std::unique_ptr< EventCollection< PublishEvent< T >>> pub, std::unique_ptr< EventCollection< DiscreteUpdateEvent< T >>> discrete, std::unique_ptr< EventCollection< UnrestrictedUpdateEvent< T >>> unrestricted) | |
Takes ownership of pub, discrete and unrestricted. More... | |
|
delete |
|
delete |
|
explicit |
Allocated CompositeEventCollection for all constituent subsystems are passed in subevents (a vector of size of the number of subsystems of the corresponding diagram), for which ownership is also transferred to this.
| CompositeEventCollection<T>& get_mutable_subevent_collection | ( | int | index | ) |
| const CompositeEventCollection<T>& get_subevent_collection | ( | int | index | ) | const |
| int num_subsystems | ( | ) | const |
Returns the number of subsystems for which this object contains event collections.
|
delete |
|
delete |