Clock.h

Go to the documentation of this file.

// Copyright 2015 - 2026, GIBIS-UNIFESP and the wiRedPanda contributors
// SPDX-License-Identifier: GPL-3.0-or-later

 
#pragma once
 
#include <chrono>
 
#include "App/Element/GraphicElementInput.h"

class Clock : public GraphicElementInput
{
    Q_OBJECT
 
public:
    static constexpr double kDefaultFrequency = 1.0;

    static constexpr std::chrono::microseconds halfPeriod(const double freq)
    {
        using namespace std::chrono_literals;
        return std::chrono::duration_cast<std::chrono::microseconds>(1s / (2 * freq));
    }
 
    // --- Lifecycle ---

    explicit Clock(QGraphicsItem *parent = nullptr);
 
    // --- State Queries ---

    bool isOn(const int port = 0) const override;
    double frequency() const override;
    double delay() const override;
    QString genericProperties() override;
 
    // --- State Setters ---

    void setOn() override;
    void setOff() override;
 
    // Bring the base setOn(bool, int) overload into scope (hidden by setOn() above).
    using GraphicElementInput::setOn;

    void setFrequency(const double freq) override;
    void setDelay(const double delay) override;
 
    // --- Simulation ---

    void resetClock(std::chrono::steady_clock::time_point globalTime);
    void updateClock(std::chrono::steady_clock::time_point globalTime);
 
    // --- Visual ---

    QList<std::pair<int, QString>> appearanceStates() const override;
 
    // --- Serialization ---

    void load(QDataStream &stream, SerializationContext &context) override;
    void save(QDataStream &stream, SerializationOptions options) const override;
 
private:
    // --- Members ---
 
    double m_delay = 0;
    double m_frequency = kDefaultFrequency;
    std::chrono::microseconds m_interval = halfPeriod(kDefaultFrequency);
    std::chrono::steady_clock::time_point m_startTime;
};