PeriodicEventData Class Reference

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

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

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
PeriodicEventData &	operator= (const PeriodicEventData &)=default
	PeriodicEventData (PeriodicEventData &&)=default
PeriodicEventData &	operator= (PeriodicEventData &&)=default
Public Member Functions inherited from EventData
	EventData ()
virtual	~EventData ()
virtual std::unique_ptr< EventData >	Clone () const
	EventData (const EventData &)=default
EventData &	operator= (const EventData &)=default
	EventData (EventData &&)=default
EventData &	operator= (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() [1/3]

PeriodicEventData ( )

inline

PeriodicEventData() [2/3]

PeriodicEventData ( const PeriodicEventData &  )

default

PeriodicEventData() [3/3]

PeriodicEventData ( PeriodicEventData &&  )

default

Member Function Documentation

offset_sec()

double offset_sec ( ) const

inline

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

operator=() [1/2]

PeriodicEventData& operator= ( const PeriodicEventData &  )

default

operator=() [2/2]

PeriodicEventData& operator= ( PeriodicEventData &&  )

default

period_sec()

double period_sec ( ) const

inline

Gets the period with which this event should recur.

set_offset_sec()

void set_offset_sec ( double  offset_sec )

inline

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

set_period_sec()

void set_period_sec ( double  period_sec )

inline

Sets the period with which this event should recur.

---

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

• drake/systems/framework/event.h