PeriodicEventData Class Reference
Detailed Description
A token describing an event that recurs on a fixed period.
The events are triggered at time = offset_sec + i * period_sec, where i is a non-negative integer.
#include <src/maliput/drake/systems/framework/event.h>
Inheritance diagram for PeriodicEventData:
Public Member Functions | |
| PeriodicEventData () | |
| DRAKE_DEFAULT_COPY_AND_MOVE_AND_ASSIGN (PeriodicEventData) | |
| double | period_sec () const |
| Gets the period with which this event should recur. More... | |
| void | set_period_sec (double period_sec) |
| Sets the period with which this event should recur. More... | |
| double | offset_sec () const |
| Gets the time after zero when this event should first occur. More... | |
| void | set_offset_sec (double offset_sec) |
| Sets the time after zero when this event should first occur. More... | |
 Public Member Functions inherited from EventData | |
| EventData () | |
| DRAKE_DEFAULT_COPY_AND_MOVE_AND_ASSIGN (EventData) | |
| virtual | ~EventData () |
| virtual std::unique_ptr< EventData > | Clone () const |
Additional Inherited Members |
Constructor & Destructor Documentation
◆ PeriodicEventData()
Member Function Documentation
◆ DRAKE_DEFAULT_COPY_AND_MOVE_AND_ASSIGN()
| DRAKE_DEFAULT_COPY_AND_MOVE_AND_ASSIGN | ( | PeriodicEventData | ) |
◆ offset_sec()
| double offset_sec | ( | ) | const |
Gets the time after zero when this event should first occur.
◆ period_sec()
| double period_sec | ( | ) | const |
Gets the period with which this event should recur.
◆ set_offset_sec()
| void set_offset_sec | ( | double | offset_sec | ) |
Sets the time after zero when this event should first occur.
◆ set_period_sec()
| void set_period_sec | ( | double | period_sec | ) |
Sets the period with which this event should recur.
The documentation for this class was generated from the following file:
