Public Member Functions | Public Attributes | List of all members
SystemClockDriver Class Reference

#include <clock.hpp>

Inheritance diagram for SystemClockDriver:
Inheritance graph
[legend]

Public Member Functions

virtual void adjustUtc (uavcan::UtcDuration adjustment)
 
virtual uavcan::MonotonicTime getMonotonic () const
 
virtual uavcan::UtcTime getUtc () const
 
- Public Member Functions inherited from uavcan::ISystemClock
virtual ~ISystemClock ()
 

Public Attributes

uavcan::UtcDuration utc_adjustment
 

Detailed Description

Definition at line 62 of file libuavcan/libuavcan/test/clock.hpp.

Member Function Documentation

◆ adjustUtc()

virtual void SystemClockDriver::adjustUtc ( uavcan::UtcDuration  adjustment)
inlinevirtual

Adjust the network-synchronized clock. Refer to getUtc() for details.

For POSIX refer to adjtime(), settimeofday().

Parameters
[in]adjustmentAmount of time to add to the clock value.

Implements uavcan::ISystemClock.

Definition at line 91 of file libuavcan/libuavcan/test/clock.hpp.

◆ getMonotonic()

virtual uavcan::MonotonicTime SystemClockDriver::getMonotonic ( ) const
inlinevirtual

Monototic system clock.

This clock shall never jump or change rate; the base time is irrelevant. This clock is mandatory and must remain functional at all times.

On POSIX systems use clock_gettime() with CLOCK_MONOTONIC.

Implements uavcan::ISystemClock.

Definition at line 67 of file libuavcan/libuavcan/test/clock.hpp.

◆ getUtc()

virtual uavcan::UtcTime SystemClockDriver::getUtc ( ) const
inlinevirtual

Global network clock. It doesn't have to be UTC, the name is a bit misleading - actual time base doesn't matter.

This clock can be synchronized with other nodes on the bus, hence it can jump and/or change rate occasionally. This clock is optional; if it is not supported, return zero. Also return zero if the UTC time is not available yet (e.g. the device has just started up with no battery clock).

For POSIX refer to clock_gettime(), gettimeofday().

Implements uavcan::ISystemClock.

Definition at line 79 of file libuavcan/libuavcan/test/clock.hpp.

Member Data Documentation

◆ utc_adjustment

uavcan::UtcDuration SystemClockDriver::utc_adjustment

Definition at line 65 of file libuavcan/libuavcan/test/clock.hpp.


The documentation for this class was generated from the following file:


uavcan_communicator
Author(s):
autogenerated on Fri Dec 13 2024 03:10:04