ecstasy::Timer Class Reference

Timer class to control the execution of systems. More...

#include <Timer.hpp>

Collaboration diagram for ecstasy::Timer:

Classes
struct	Rate
struct	TimeInterval

Public Types
enum class	Type { TimeInterval , Rate }
	Possible types of timers. More...
using	TimePoint = std::chrono::time_point< std::chrono::system_clock >
	Type of time points.
using	Interval = std::chrono::milliseconds
	Type of time intervals.

Public Member Functions
	Timer ()
	Construct a new Timer.
	Timer (Interval interval)
	Construct a new Timer with the given interval.
	Timer (std::uint32_t rate)
	Construct a new Timer with the given rate.
	Timer (const Timer &)=default
	Copy constructor.
	Timer (Timer &&)=default
	Move constructor.
	~Timer ()=default
	Destroy the Timer.
Timer &	operator= (const Timer &)=default
	Copy assignment operator.
Timer &	operator= (Timer &&)=default
	Move assignment operator.
constexpr Type	getType () const noexcept
	Get the Type of the timer.
constexpr TimePoint	getLastTrigger () const noexcept
	Get the last time the timer was triggered.
void	setRate (std::uint32_t rate) noexcept
	Set the Rate of the timer.
std::uint32_t	getRate () const
	Get the Rate of the timer.
void	setInterval (Interval interval) noexcept
	Set the Interval of the timer.
Interval	getInterval () const
	Get the Interval of the timer.
bool	trigger () noexcept
	Trigger the timer if it is time to do so.

Private Attributes
Type	_type
	Type of the timer.
TimePoint	_lastTrigger
	Last time the timer was triggered.
union {
TimeInterval   _timer
Rate   _rate
};
	Interval or rate of the timer.

Detailed Description

Timer class to control the execution of systems.

Timers can be assigned to systems or phases to control their execution.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-11-22)

Definition at line 32 of file Timer.hpp.

Member Typedef Documentation

Interval

using ecstasy::Timer::Interval = std::chrono::milliseconds

Type of time intervals.

Definition at line 37 of file Timer.hpp.

TimePoint

using ecstasy::Timer::TimePoint = std::chrono::time_point<std::chrono::system_clock>

Type of time points.

Definition at line 35 of file Timer.hpp.

Member Enumeration Documentation

Type

enum class ecstasy::Timer::Type

strong

Possible types of timers.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-11-22)

Enumerator
TimeInterval	Timer that triggers every time interval. Ex: every 5 seconds.
Rate	Timer that triggers at a fixed rate. Ex: every 5 frames.

Definition at line 56 of file Timer.hpp.

                        {
            TimeInterval, 
            Rate,         
        };

Constructor & Destructor Documentation

Timer() [1/5]

ecstasy::Timer::Timer

(

)

Construct a new Timer.

Note

The default timer is a Rate with a 0 interval, ie run every frame.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-11-22)

Definition at line 17 of file Timer.cpp.

    {
        _lastTrigger = TimePoint::min();
        setRate(0);
    }

Timer() [2/5]

ecstasy::Timer::Timer

(

Timer::Interval

interval

)

Construct a new Timer with the given interval.

Parameters

[in]

interval

Interval of the timer.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-11-22)

Definition at line 23 of file Timer.cpp.

                                       : Timer()
    {
        setInterval(interval);
    }

Timer() [3/5]

ecstasy::Timer::Timer

(

std::uint32_t

rate

)

Construct a new Timer with the given rate.

Parameters

[in]

rate

Rate of the timer.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-11-22)

Definition at line 28 of file Timer.cpp.

                                 : Timer()
    {
        setRate(rate);
    }

Timer() [4/5]

ecstasy::Timer::Timer ( const Timer &  )

default

Copy constructor.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-11-22)

Timer() [5/5]

ecstasy::Timer::Timer ( Timer &&  )

default

Move constructor.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-11-22)

~Timer()

ecstasy::Timer::~Timer ( )

default

Destroy the Timer.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-11-22)

Member Function Documentation

getInterval()

Timer::Interval ecstasy::Timer::getInterval

(

)

const

Get the Interval of the timer.

Returns

Interval Interval of the timer.

Exceptions

std::runtime_error

If the timer is not an Interval timer.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-11-22)

Definition at line 57 of file Timer.cpp.

    {
        if (_type != Type::TimeInterval)
            throw std::runtime_error("Timer is not of type Rate");
        return _timer.interval;
    }

getLastTrigger()

constexpr TimePoint ecstasy::Timer::getLastTrigger ( ) const

inlineconstexprnoexcept

Get the last time the timer was triggered.

Returns

TimePoint Last time the timer was triggered.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-11-22)

Definition at line 154 of file Timer.hpp.

        {
            return _lastTrigger;
        }

getRate()

std::uint32_t ecstasy::Timer::getRate

(

)

const

Get the Rate of the timer.

Returns

std::uint32_t Rate of the timer.

Exceptions

std::runtime_error

If the timer is not a Rate timer.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-11-22)

Definition at line 44 of file Timer.cpp.

    {
        if (_type != Type::Rate)
            throw std::runtime_error("Timer is not of type Rate");
        return _rate.rate;
    }

getType()

constexpr Type ecstasy::Timer::getType ( ) const

inlineconstexprnoexcept

Get the Type of the timer.

Returns

Type Type of the timer.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-11-22)

Definition at line 141 of file Timer.hpp.

        {
            return _type;
        }

operator=() [1/2]

Timer & ecstasy::Timer::operator= ( const Timer &  )

default

Copy assignment operator.

Returns

Timer&

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-11-22)

operator=() [2/2]

Timer & ecstasy::Timer::operator= ( Timer &&  )

default

Move assignment operator.

Returns

Timer&

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-11-22)

setInterval()

void ecstasy::Timer::setInterval ( Timer::Interval  interval )

noexcept

Set the Interval of the timer.

This will convert the timer to an Interval timer.

Parameters

[in]

interval

Interval of the timer.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-11-22)

Definition at line 51 of file Timer.cpp.

    {
        _type = Type::TimeInterval;
        _timer.interval = interval;
    }

setRate()

void ecstasy::Timer::setRate ( std::uint32_t  rate )

noexcept

Set the Rate of the timer.

This will convert the timer to a Rate timer.

Parameters

[in]

rate

Rate of the timer.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-11-22)

Definition at line 33 of file Timer.cpp.

    {
        _type = Type::Rate;
        if (rate == 0) {
            rate = 1;
        }
        _rate.rate = rate;
        // Reset the countdown to trigger to run the first time
        _rate.triggerCountdown = 0;
    }

trigger()

bool ecstasy::Timer::trigger ( )

noexcept

Trigger the timer if it is time to do so.

Warning

This does not call the system or phase, it only checks if it is allowed to run now.

Returns

bool true if the timer was triggered, false otherwise.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2024-11-22)

Definition at line 64 of file Timer.cpp.

    {
        switch (_type) {
            case Type::TimeInterval: {
                auto tp = std::chrono::system_clock::now();
 
                if (tp - _timer.interval >= _lastTrigger) {
                    _lastTrigger = tp;
                    return true;
                }
                return false;
            }
            case Type::Rate: {
                if (_rate.triggerCountdown == 0) {
                    _rate.triggerCountdown = _rate.rate - 1;
                    _lastTrigger = std::chrono::system_clock::now();
                    return true;
                }
                --_rate.triggerCountdown;
                return false;
            }
        }
        return false;
    }

Member Data Documentation

[union]

union { ... } ecstasy::Timer

Interval or rate of the timer.

_lastTrigger

TimePoint ecstasy::Timer::_lastTrigger

private

Last time the timer was triggered.

Definition at line 219 of file Timer.hpp.

_rate

Rate ecstasy::Timer::_rate

Definition at line 223 of file Timer.hpp.

_timer

TimeInterval ecstasy::Timer::_timer

Definition at line 222 of file Timer.hpp.

_type

Type ecstasy::Timer::_type

private

Type of the timer.

Definition at line 217 of file Timer.hpp.

---

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

• src/ecstasy/system/Timer.hpp
• src/ecstasy/system/Timer.cpp