datetime.h

Go to the documentation of this file.

// Copyright 2021-2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
 
 
#pragma once
 
#include <satcat5/io_core.h>
#include <satcat5/polling.h>
#include <satcat5/ptp_time.h>
#include <satcat5/timeref.h>
 
namespace satcat5 {
    namespace datetime {
        static constexpr u32 ONE_SECOND = 1000;
        static constexpr u32 ONE_MINUTE = 60 * ONE_SECOND;
        static constexpr u32 ONE_HOUR   = 60 * ONE_MINUTE;
        static constexpr u32 ONE_DAY    = 24 * ONE_HOUR;
        static constexpr u32 ONE_WEEK   = 7 * ONE_DAY;
 
        static constexpr s64 TIME_ERROR = 0;
 
        satcat5::datetime::GpsTime to_gps(s64 time);
        satcat5::ptp::Time to_ptp(s64 time);
        satcat5::datetime::RtcTime to_rtc(s64 time);
 
        s64 from_gps(const satcat5::datetime::GpsTime& time);
        s64 from_ptp(const satcat5::ptp::Time& time);
        s64 from_rtc(const satcat5::datetime::RtcTime& time);
 
        struct GpsTime {
            s32 wkn;    
            u32 tow;    
 
            GpsTime() = default;
            GpsTime(const GpsTime& t) = default;
            GpsTime& operator=(const GpsTime& t) = default;
 
            inline s64 convert() const
                { return satcat5::datetime::from_gps(*this); }
 
            bool operator==(const satcat5::datetime::GpsTime& other) const;
            bool operator<(const satcat5::datetime::GpsTime& other) const;
            inline bool operator!=(const satcat5::datetime::GpsTime& other) const
                {return !operator==(other);}
 
            inline void write_to(satcat5::io::Writeable* wr) const
                {wr->write_u32((u32)wkn); wr->write_u32(tow);}
            bool read_from(satcat5::io::Readable* rd);
        };
 
        struct RtcTime {
            u8 dw;      
            u8 ct;      
            u8 yr;      
            u8 mo;      
            u8 dt;      
            u8 hr;      
            u8 mn;      
            u8 sc;      
            u8 ss;      
 
            RtcTime() = default;
            RtcTime(const RtcTime& t) = default;
            RtcTime& operator=(const RtcTime& t) = default;
 
            inline s64 convert() const
                { return satcat5::datetime::from_rtc(*this); }
 
            u32 days_since_epoch() const;
            u32 msec_since_midnight() const;
            bool validate() const;
 
            bool operator==(const satcat5::datetime::RtcTime& other) const;
            bool operator<(const satcat5::datetime::RtcTime& other) const;
 
            void write_to(satcat5::io::Writeable* wr) const;
 
            bool read_from(satcat5::io::Readable* rd);
 
            void log_to(satcat5::log::LogBuffer& wr) const;
        };
 
        static const datetime::RtcTime RTC_ERROR = {0, 0, 0, 0, 0, 0, 0, 0, 0};
 
        static const u8 RTC_MIL_BIT = 0x80;
 
        class Clock : protected satcat5::poll::Timer {
        public:
            Clock();
 
            inline u32 uptime_msec() const {return m_tcount;}
 
            u32 uptime_usec() const;
 
            void reset(bool full = false);
 
            void set(s64 gps);
 
            inline s64 now() const {return m_gps;}
            inline satcat5::datetime::GpsTime gps() const
                { return satcat5::datetime::to_gps(m_gps); }
            inline satcat5::ptp::Time ptp() const
                { return satcat5::datetime::to_ptp(m_gps); }
            inline satcat5::datetime::RtcTime rtc() const
                { return satcat5::datetime::to_rtc(m_gps); }
 
        protected:
            friend satcat5::poll::OnDemandHelper;
            void timer_event() override;
 
            satcat5::util::TimeVal m_tref;
            u32 m_tcount;
            s64 m_gps;
        };
 
        extern satcat5::datetime::Clock clock;
    }
}