xentara-plugin v1.2.1
The Xentara Plugin Framework
Loading...
Searching...
No Matches
xentara::process::TimerSchedule Class Referencefinal

Scheduling information for a timer. More...

#include <process/TimerSchedule.hpp>

Public Member Functions

constexpr TimerSchedule (std::chrono::system_clock::duration period, std::chrono::system_clock::time_point referenceTime=std::chrono::system_clock::time_point())
 Constructor.
 
constexpr auto referenceTime () const noexcept -> std::chrono::system_clock::time_point
 Gets the timer’s reference time.
 
constexpr auto period () const noexcept -> std::chrono::system_clock::duration
 Gets the timer’s period.
 

Detailed Description

Scheduling information for a timer.

Constructor & Destructor Documentation

◆ TimerSchedule()

constexpr xentara::process::TimerSchedule::TimerSchedule ( std::chrono::system_clock::duration  period,
std::chrono::system_clock::time_point  referenceTime = std::chrono::system_clock::time_point() 
)
constexpr

Constructor.

Parameters
periodThe period of the timer
referenceTimeThe reference time of the timer

Member Function Documentation

◆ period()

constexpr auto xentara::process::TimerSchedule::period ( ) const -> std::chrono::system_clock::duration
constexprnoexcept

Gets the timer’s period.

◆ referenceTime()

constexpr auto xentara::process::TimerSchedule::referenceTime ( ) const -> std::chrono::system_clock::time_point
constexprnoexcept

Gets the timer’s reference time.