PeriodTimer Class Reference

#include <TimeUtils.h>

Collaboration diagram for PeriodTimer:

Public Member Functions
enum PeriodTimerState	getEdgeTriggeredState ()
void	init (bool enableTriggerNow, const Engine::UTCTimeOnly &periodStart, const Engine::UTCTimeOnly &periodEnd)
void	init (bool enableTriggerNow, const Engine::UTCTimeOnly &periodStart, const Engine::UTCTimeOnly &periodEnd, const Engine::UTCTimeOnly &now)
bool	isNowWithinPeriod ()
bool	isWithinPeriod (const Engine::UTCTimeOnly &now)
	PeriodTimer ()
void	tick (const Engine::UTCTimeOnly &now)

Public Attributes
bool	initialized_
Engine::UTCTimeOnly	periodEnd_
Engine::UTCTimeOnly	periodStart_
enum PeriodTimerState	state_
bool	wasWithinPeriodOnLastTick_

Constructor & Destructor Documentation

PeriodTimer::PeriodTimer ( )

inline

Member Function Documentation

enum PeriodTimerState PeriodTimer::getEdgeTriggeredState ( )

inline

References initialized_, NO_CHANGE_SINCE_LAST_CHECK, and state_.

void PeriodTimer::init ( bool  enableTriggerNow, const Engine::UTCTimeOnly &  periodStart, const Engine::UTCTimeOnly &  periodEnd  )

inline

References Engine::UTCTimeOnly::now().

void PeriodTimer::init ( bool  enableTriggerNow, const Engine::UTCTimeOnly &  periodStart, const Engine::UTCTimeOnly &  periodEnd, const Engine::UTCTimeOnly &  now  )

inline

References initialized_, isWithinTimePeriod(), NO_CHANGE_SINCE_LAST_CHECK, periodEnd_, periodStart_, state_, wasWithinPeriodOnLastTick_, and WENT_INTO_TIME_PERIOD.

bool PeriodTimer::isNowWithinPeriod ( )

inline

References initialized_, isWithinPeriod(), and Engine::UTCTimeOnly::now().

bool PeriodTimer::isWithinPeriod ( const Engine::UTCTimeOnly &  now )

inline

References initialized_, isWithinTimePeriod(), periodEnd_, and periodStart_.

Referenced by isNowWithinPeriod().

void PeriodTimer::tick ( const Engine::UTCTimeOnly &  now )

inline

References initialized_, isWithinTimePeriod(), periodEnd_, periodStart_, state_, wasWithinPeriodOnLastTick_, WENT_INTO_TIME_PERIOD, and WENT_OUT_OF_TIME_PERIOD.

Member Data Documentation

bool PeriodTimer::initialized_

Referenced by getEdgeTriggeredState(), init(), isNowWithinPeriod(), isWithinPeriod(), and tick().

Engine::UTCTimeOnly PeriodTimer::periodEnd_

Referenced by init(), isWithinPeriod(), and tick().

Engine::UTCTimeOnly PeriodTimer::periodStart_

Referenced by init(), isWithinPeriod(), and tick().

enum PeriodTimerState PeriodTimer::state_

Referenced by getEdgeTriggeredState(), init(), and tick().

bool PeriodTimer::wasWithinPeriodOnLastTick_

Referenced by init(), and tick().