Ignition Transport

API Reference

10.0.0

A Clock implementation that leverages host OS time APIs. More...

#include <Clock.hh>

Public Member Functions

bool IsReady () const override
 Checks whether the clock is ready to be used or not. More...
 
std::chrono::nanoseconds Time () const override
 Gets clock time. More...
 
- Public Member Functions inherited from Clock
virtual ~Clock ()=default
 Virtual destructor. More...
 

Static Public Member Functions

static WallClockInstance ()
 Returns system wall clock interface. More...
 

Detailed Description

A Clock implementation that leverages host OS time APIs.

Member Function Documentation

◆ Instance()

static WallClock* Instance ( )
static

Returns system wall clock interface.

Returns
The sole wall clock instance (a singleton)

◆ IsReady()

bool IsReady ( ) const
overridevirtual

Checks whether the clock is ready to be used or not.

Returns
True if clock is ready to be used, false otherwise

Implements Clock.

◆ Time()

std::chrono::nanoseconds Time ( ) const
overridevirtual

Gets clock time.

Returns
Current clock time, in nanoseconds

Implements Clock.


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