Drake
PeriodicEventData Class Reference

A token describing an event that recurs on a fixed period. More...

#include <drake/systems/framework/event.h>

Inheritance diagram for PeriodicEventData:
[legend]
Collaboration diagram for PeriodicEventData:
[legend]

Public Member Functions

 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...
 
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
 PeriodicEventData (const PeriodicEventData &)=default
 
PeriodicEventDataoperator= (const PeriodicEventData &)=default
 
 PeriodicEventData (PeriodicEventData &&)=default
 
PeriodicEventDataoperator= (PeriodicEventData &&)=default
 
- Public Member Functions inherited from EventData
 EventData ()
 
virtual ~EventData ()
 
virtual std::unique_ptr< EventDataClone () const
 
 EventData (const EventData &)=default
 
EventDataoperator= (const EventData &)=default
 
 EventData (EventData &&)=default
 
EventDataoperator= (EventData &&)=default
 

Additional Inherited Members

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.

Constructor & Destructor Documentation

PeriodicEventData ( )
inline
PeriodicEventData ( const PeriodicEventData )
default

Member Function Documentation

double offset_sec ( ) const
inline

Gets the time after zero when this event should first occur.

Here is the caller graph for this function:

PeriodicEventData& operator= ( const PeriodicEventData )
default
PeriodicEventData& operator= ( PeriodicEventData &&  )
default
double period_sec ( ) const
inline

Gets the period with which this event should recur.

Here is the caller graph for this function:

void set_offset_sec ( double  offset_sec)
inline

Sets the time after zero when this event should first occur.

Here is the call graph for this function:

Here is the caller graph for this function:

void set_period_sec ( double  period_sec)
inline

Sets the period with which this event should recur.

Here is the caller graph for this function:


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