:py:mod:`phoenix6.all_timestamps`
=================================

.. py:module:: phoenix6.all_timestamps

Module Contents
---------------


.. py:class:: AllTimestamps


   A collection of timestamps for a received signal.

   .. py:method:: update(system_timestamp_seconds: phoenix6.units.second, system_timestamp_source: phoenix6.timestamp.TimestampSource, system_timestamp_valid: bool, canivore_timestamp_seconds: phoenix6.units.second, canivore_timestamp_source: phoenix6.timestamp.TimestampSource, canivore_timestamp_valid: bool, device_timestamp_seconds: phoenix6.units.second, device_timestamp_source: phoenix6.timestamp.TimestampSource, device_timestamp_valid: bool)

      Update this timestamp with the new timestamps

      :param system_timestamp_seconds: New system timestamp seconds
      :type system_timestamp_seconds: second
      :param system_timestamp_source: New System timestamp source
      :type system_timestamp_source: TimestampSource
      :param system_timestamp_valid: Whether new System timestamp is valid
      :type system_timestamp_valid: bool
      :param canivore_timestamp_seconds: New CANivore timestamp seconds
      :type canivore_timestamp_seconds: second
      :param canivore_timestamp_source: New CANivore timestamp source
      :type canivore_timestamp_source: TimestampSource
      :param canivore_timestamp_valid: Whether new CANivore timestamp is valid
      :type canivore_timestamp_valid: bool
      :param device_timestamp_seconds: New Device timestamp seconds
      :type device_timestamp_seconds: second
      :param device_timestamp_source: New Device timestamp source
      :type device_timestamp_source: TimestampSource
      :param device_timestamp_valid: Whether new Device timestamp is valid
      :type device_timestamp_valid: bool


   .. py:method:: get_best_timestamp() -> phoenix6.timestamp.Timestamp

      Gets the most accurate timestamp available.

      The timestamp sources from most to least accurate are:

          - TimestampSource.Device
          - TimestampSource.CANivore
          - TimestampSource.System

      Note that some of these sources may not be available.

      :return: The most accurate timestamp available
      :rtype: Timestamp


   .. py:method:: get_system_timestamp() -> phoenix6.timestamp.Timestamp

      Get the timestamp as reported by the TimestampSource.System source.

      :return: Timestamp as reported by system
      :rtype: Timestamp


   .. py:method:: get_canivore_timestamp() -> phoenix6.timestamp.Timestamp

      Get the timestamp as reported by the TimestampSource.CANivore source.

      :return: Timestamp as reported by the CANivore
      :rtype: Timestamp


   .. py:method:: get_device_timestamp() -> phoenix6.timestamp.Timestamp

      Get the timestamp as reported by the TimestampSource.Device source.

      :return: Timestamp as reported by the device
      :rtype: Timestamp