Source code for malcolm.core.timestamp

import time
from typing import Union

import numpy as np
from annotypes import Anno, Serializable

with Anno("Seconds since Jan 1, 1970 00:00:00 UTC"):
    ASecondsPastEpoch = Union[np.int64]
with Anno("Nanoseconds relative to the secondsPastEpoch field"):
    ANanoseconds = Union[np.int32]
with Anno("An integer value whose interpretation is deliberately undefined"):
    AUserTag = Union[np.int32]


zero32 = np.int32(0)


@Serializable.register_subclass("time_t")
class TimeStamp(Serializable):
    __slots__ = ["secondsPastEpoch", "nanoseconds", "userTag"]

    # noinspection PyPep8Naming
    # secondsPastEpoch and userTag are camelCase to maintain compatibility with
    # EPICS normative types
    def __init__(
        self,
        secondsPastEpoch: ASecondsPastEpoch = None,
        nanoseconds: ANanoseconds = None,
        userTag: AUserTag = zero32,
    ) -> None:
        # Set initial values
        if secondsPastEpoch is None or nanoseconds is None:
            now = time.time()
            self.secondsPastEpoch = np.int64(now)
            self.nanoseconds = np.int32(now % 1 / 1e-9)
        else:
            self.secondsPastEpoch = np.int64(secondsPastEpoch)
            self.nanoseconds = np.int32(nanoseconds)
        self.userTag = userTag

    def to_time(self) -> np.float64:
        return self.secondsPastEpoch + 1e-9 * self.nanoseconds

    zero: "TimeStamp"  # filled in below


TimeStamp.zero = TimeStamp(zero32, zero32)