tin  1.5.9
tsm::chrono_ticks::elapsed_tick_source< Clock, TickPeriod > Class Template Reference

#include <chrono_ticks.h>

Collaboration diagram for tsm::chrono_ticks::elapsed_tick_source< Clock, TickPeriod >:
Collaboration graph

Public Types

using clock_type = Clock
 
using tick_period = TickPeriod
 
using time_point = typename Clock::time_point
 

Public Member Functions

 elapsed_tick_source (TickPeriod period)
 
 elapsed_tick_source (tick_domain< TickPeriod > domain)
 
tsm::tick_rep ticks () const
 
tsm::tick_rep poll ()
 
void reset ()
 

Detailed Description

template<typename Clock, typename TickPeriod>
class tsm::chrono_ticks::elapsed_tick_source< Clock, TickPeriod >

Polling adapter that converts a monotonic clock into elapsed semantic ticks.

The adapter belongs at the platform boundary. HSMs and task executors still receive only integer elapsed ticks through tick(elapsed).

Member Typedef Documentation

◆ clock_type

template<typename Clock , typename TickPeriod >
using tsm::chrono_ticks::elapsed_tick_source< Clock, TickPeriod >::clock_type = Clock

◆ tick_period

template<typename Clock , typename TickPeriod >
using tsm::chrono_ticks::elapsed_tick_source< Clock, TickPeriod >::tick_period = TickPeriod

◆ time_point

template<typename Clock , typename TickPeriod >
using tsm::chrono_ticks::elapsed_tick_source< Clock, TickPeriod >::time_point = typename Clock::time_point

Constructor & Destructor Documentation

◆ elapsed_tick_source() [1/2]

template<typename Clock , typename TickPeriod >
tsm::chrono_ticks::elapsed_tick_source< Clock, TickPeriod >::elapsed_tick_source ( TickPeriod  period)
inlineexplicit

◆ elapsed_tick_source() [2/2]

template<typename Clock , typename TickPeriod >
tsm::chrono_ticks::elapsed_tick_source< Clock, TickPeriod >::elapsed_tick_source ( tick_domain< TickPeriod >  domain)
inlineexplicit

Member Function Documentation

◆ poll()

template<typename Clock , typename TickPeriod >
tsm::tick_rep tsm::chrono_ticks::elapsed_tick_source< Clock, TickPeriod >::poll ( )
inline

◆ reset()

template<typename Clock , typename TickPeriod >
void tsm::chrono_ticks::elapsed_tick_source< Clock, TickPeriod >::reset ( )
inline

◆ ticks()

template<typename Clock , typename TickPeriod >
tsm::tick_rep tsm::chrono_ticks::elapsed_tick_source< Clock, TickPeriod >::ticks ( ) const
inline

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