ClockPin.hh

Go to the documentation of this file.

#ifndef CLOCKPIN_HH
#define CLOCKPIN_HH
 
#include "EmuTime.hh"
#include "Schedulable.hh"
 
namespace openmsx {
 
class Scheduler;
class ClockPin;
 
class ClockPinListener
{
public:
        virtual void signal(ClockPin& pin, EmuTime::param time) = 0;
        virtual void signalPosEdge(ClockPin& pin, EmuTime::param time) = 0;
 
protected:
        ~ClockPinListener() = default;
};
 
class ClockPin final : public Schedulable
{
public:
        explicit ClockPin(Scheduler& scheduler, ClockPinListener* listener = nullptr);
 
        // input side
        void setState(bool status, EmuTime::param time);
        void setPeriodicState(EmuDuration::param total,
                              EmuDuration::param hi, EmuTime::param time);
 
        // output side
        [[nodiscard]] bool getState(EmuTime::param time) const;
        [[nodiscard]] bool isPeriodic() const { return periodic; }
        [[nodiscard]] EmuDuration::param getTotalDuration() const;
        [[nodiscard]] EmuDuration::param getHighDuration() const;
        [[nodiscard]] unsigned getTicksBetween(EmuTime::param begin,
                                               EmuTime::param end) const;
 
        // control
        void generateEdgeSignals(bool wanted, EmuTime::param time);
 
        template<typename Archive>
        void serialize(Archive& ar, unsigned version);
 
private:
        void unschedule();
        void schedule(EmuTime::param time);
        void executeUntil(EmuTime::param time) override;
 
private:
        ClockPinListener* const listener;
 
        EmuDuration totalDur;
        EmuDuration hiDur;
        EmuTime referenceTime = EmuTime::zero();
 
        bool periodic = false;
        bool status = false;
        bool signalEdge = false;
};
 
} // namespace openmsx
 
#endif