SysTimer.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Teknic, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
 
#ifndef __SYSTIMER_H__
#define __SYSTIMER_H__
 
#include "SysTiming.h"
 
namespace ClearCore {
 
class SysTimer {
 
protected:
    // Timer state variables
    uint32_t m_timerStart = 0;
    uint32_t m_timerDelay = 0;
    
    SysTimer() {}
 
    SysTimer(uint32_t delay) {
        m_timerDelay = delay;
    }
 
public:
    void SetDelay(uint32_t delay) {
        m_timerDelay = delay;
    }
 
    void Start(uint32_t delay) {
        m_timerDelay = delay;
        m_timerStart = Now();
    }
 
    void Start() {
        m_timerStart = Now();
    }
 
    bool Completed() {
        return (Now() - m_timerStart) >= m_timerDelay;
    }
 
    uint32_t Elapsed() {
        return Now() - m_timerStart;
    }
 
private:
    virtual uint32_t Now() = 0;
 
}; // SysTimer
 
class SysTimerMs : public SysTimer {
 
public:
    SysTimerMs() : SysTimer() {}
 
    SysTimerMs(uint32_t delay) : SysTimer(delay) {
        m_timerStart = Now();
    }
 
private:
    uint32_t Now() override {
        return Milliseconds();
    }
 
}; // SysTimerMs
 
class SysTimerUs : public SysTimer {
 
public:
    SysTimerUs() : SysTimer() {}
 
    SysTimerUs(uint32_t delay) : SysTimer(delay) {
        m_timerStart = Now();
    }
 
private:
    uint32_t Now() override {
        return Microseconds();
    }
 
}; // SysTimerUs
 
} // ClearCore namespace
 
#endif //__SYSTIMER_H__