xentara::process::TimerSchedule Class Reference

Scheduling information for a timer. More...

#include <xentara/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.
constexpr auto	operator== (const TimerSchedule &) const noexcept -> bool=default
	Comparison operator.
constexpr auto	operator<=> (const TimerSchedule &) const noexcept -> auto=default
	Three-way comparison operator.

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

period	The period of the timer
referenceTime	The reference time of the timer

Member Function Documentation

operator<=>()

constexpr auto xentara::process::TimerSchedule::operator<=> ( const TimerSchedule &  ) const -> auto=default

constexprdefaultnoexcept

Three-way comparison operator.

This operator allows TimerSchedule to be used as a key in std::set and std::map.

operator==()

constexpr auto xentara::process::TimerSchedule::operator== ( const TimerSchedule &  ) const -> bool=default

constexprdefaultnoexcept

Comparison operator.

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.