ptp_time.h

Go to the documentation of this file.

// Copyright 2022-2024 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
 
#pragma once
 
#include <satcat5/types.h>
#include <satcat5/utils.h>
 
namespace satcat5 {
    namespace ptp {
        constexpr s64 NSEC_PER_SEC      = 1000000000LL;
        constexpr s64 NSEC_PER_MSEC     = 1000000LL;
        constexpr s64 NSEC_PER_USEC     = 1000LL;
        constexpr s64 USEC_PER_SEC      = 1000000LL;
        constexpr s64 MSEC_PER_SEC      = 1000LL;
        constexpr s64 SUBNS_PER_NSEC    = 65536LL;
        constexpr s64 SUBNS_PER_USEC    = SUBNS_PER_NSEC * NSEC_PER_USEC;
        constexpr s64 SUBNS_PER_MSEC    = SUBNS_PER_NSEC * NSEC_PER_MSEC;
        constexpr s64 SUBNS_PER_SEC     = SUBNS_PER_NSEC * NSEC_PER_SEC;
 
        class Time {
        public:
            constexpr Time()
                : m_secs(0), m_subns(0) {}
 
            constexpr explicit Time(s64 subnanoseconds)
                : m_secs (satcat5::util::divide(subnanoseconds, SUBNS_PER_SEC))
                , m_subns(satcat5::util::modulo(subnanoseconds, SUBNS_PER_SEC)) {}
 
            constexpr Time(const Time& other)
                : m_secs(other.m_secs), m_subns(other.m_subns) {}
 
            Time(u64 seconds, u32 nanoseconds, u16 subnanoseconds = 0);
 
            inline s64 field_secs() const
                {return m_secs;}
            inline u32 field_nsec() const
                {return (u32)satcat5::util::div_floor(m_subns, SUBNS_PER_NSEC);}
            inline u64 field_subns() const
                {return (u64)m_subns;}
 
            inline s64 round_secs() const
                {return (*this + Time(SUBNS_PER_NSEC / 2)).field_secs();}
            inline u32 round_nsec() const
                {return (*this + Time(SUBNS_PER_NSEC / 2)).field_nsec();}
 
            s64 delta_subns() const;
            s64 delta_nsec() const;
            s64 delta_usec() const;
            s64 delta_msec() const;
 
            bool read_from(satcat5::io::Readable* src);
 
            void write_to(satcat5::io::Writeable* dst) const;
 
            void log_to(satcat5::log::LogBuffer& wr) const;
 
            inline u64 correction() const
                {return (u64)satcat5::util::modulo(m_subns, SUBNS_PER_NSEC);}
 
            s64 to_datetime() const;
 
            satcat5::ptp::Time abs() const;
            void operator+=(const satcat5::ptp::Time& other);
            void operator-=(const satcat5::ptp::Time& other);
            satcat5::ptp::Time operator=(const satcat5::ptp::Time& other);
            satcat5::ptp::Time operator+(const satcat5::ptp::Time& other) const;
            satcat5::ptp::Time operator-(const satcat5::ptp::Time& other) const;
            satcat5::ptp::Time operator-() const;
 
            void operator*=(unsigned scale);
            void operator/=(unsigned scale);
            satcat5::ptp::Time operator*(unsigned scale) const;
            satcat5::ptp::Time operator/(unsigned scale) const;
 
            bool operator==(const satcat5::ptp::Time& other) const;
            bool operator<(const satcat5::ptp::Time& other) const;
            bool operator>(const satcat5::ptp::Time& other) const;
            inline bool operator!=(const satcat5::ptp::Time& other) const {return !operator==(other);}
            inline bool operator<=(const satcat5::ptp::Time& other) const {return !operator>(other);}
            inline bool operator>=(const satcat5::ptp::Time& other) const {return !operator<(other);}
 
        protected:
            void normalize();       // Reduce to canonical form
            s64 m_secs;             // Seconds since epoch (may be negative)
            s64 m_subns;            // Subnanoseconds, range [0 .. SUBNS_PER_SEC)
        };
 
        satcat5::ptp::Time from_datetime(s64 gps_msec);
 
        constexpr satcat5::ptp::Time TIME_ZERO(0LL);
        constexpr satcat5::ptp::Time ONE_NANOSECOND(SUBNS_PER_NSEC);
        constexpr satcat5::ptp::Time ONE_MICROSECOND(SUBNS_PER_USEC);
        constexpr satcat5::ptp::Time ONE_MILLISECOND(SUBNS_PER_MSEC);
        constexpr satcat5::ptp::Time ONE_SECOND(SUBNS_PER_SEC);
        constexpr satcat5::ptp::Time ONE_MINUTE(SUBNS_PER_SEC * 60);
        constexpr satcat5::ptp::Time ONE_HOUR(SUBNS_PER_SEC * 3600);
        constexpr satcat5::ptp::Time ONE_DAY(SUBNS_PER_SEC * 3600 * 24);
    }
}