Public Member Functions | Static Public Member Functions | Private Member Functions | List of all members
uavcan_kinetis::SystemClock Class Reference

#include <clock.hpp>

Inheritance diagram for uavcan_kinetis::SystemClock:
Inheritance graph
[legend]

Public Member Functions

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

Static Public Member Functions

static SystemClockinstance ()
 

Private Member Functions

virtual void adjustUtc (uavcan::UtcDuration adjustment)
 
 SystemClock ()
 
- Private Member Functions inherited from uavcan::Noncopyable
 Noncopyable ()
 
 ~Noncopyable ()
 

Detailed Description

Adapter for uavcan::ISystemClock.

Definition at line 106 of file platform_specific_components/kinetis/libuavcan/driver/include/uavcan_kinetis/clock.hpp.

Constructor & Destructor Documentation

◆ SystemClock()

uavcan_kinetis::SystemClock::SystemClock ( )
inlineprivate

Member Function Documentation

◆ adjustUtc()

virtual void uavcan_kinetis::SystemClock::adjustUtc ( uavcan::UtcDuration  adjustment)
inlineprivatevirtual

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 112 of file platform_specific_components/kinetis/libuavcan/driver/include/uavcan_kinetis/clock.hpp.

◆ getMonotonic()

virtual uavcan::MonotonicTime uavcan_kinetis::SystemClock::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 117 of file platform_specific_components/kinetis/libuavcan/driver/include/uavcan_kinetis/clock.hpp.

◆ getUtc()

virtual uavcan::UtcTime uavcan_kinetis::SystemClock::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 120 of file platform_specific_components/kinetis/libuavcan/driver/include/uavcan_kinetis/clock.hpp.

◆ instance()

static SystemClock& uavcan_kinetis::SystemClock::instance ( )
static

Calls clock::init() as needed. This function is thread safe.


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


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