Skip to content

Class hal::soft::inert_steady_clock

ClassList > hal > soft > inert_steady_clock

Inert implementation of steady clock mechanism.

  • #include <inert_steady_clock.hpp>

Inherits the following classes: hal::steady_clock

Public Functions inherited from hal::steady_clock

See hal::steady_clock

Type Name
frequency_t frequency ()
Get the operating frequency of the steady clock.
uptime_t uptime ()
Get the current value of the steady clock.
virtual ~steady_clock () = default

Public Static Functions

Type Name
result< inert_steady_clock > create (frequency_t p_frequency, uptime_t p_uptime)
Factory function to create inert_steady_clock object.

Public Static Functions Documentation

function create

Factory function to create inert_steady_clock object. 

static inline result< inert_steady_clock > hal::soft::inert_steady_clock::create (
    frequency_t p_frequency,
    uptime_t p_uptime
)

Parameters:

  • p_frequency - frequency_t object to return when frequency() is called
  • p_uptime - uptime_t object with the starting value that will be returned when uptime() is called. The uptime will increment by 1 each time uptime() is called.

Returns:

result<inert_steady_clock> - Constructed inert_steady_clock object

The documentation for this class was generated from the following file libraries/include/libhal-soft/inert_drivers/inert_steady_clock.hpp