Gazebo Transport

API Reference

12.2.1
Clock Class Referenceabstract

A Clock interface for time tracking. More...

#include <Clock.hh>

Public Member Functions

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

Detailed Description

A Clock interface for time tracking.

Constructor & Destructor Documentation

◆ ~Clock()

virtual ~Clock ( )
virtualdefault

Virtual destructor.

Member Function Documentation

◆ IsReady()

virtual bool IsReady ( ) const
pure virtual

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

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

Implemented in WallClock, and NetworkClock.

◆ Time()

virtual std::chrono::nanoseconds Time ( ) const
pure virtual

Gets clock time.

Returns
Current clock time, in nanoseconds

Implemented in WallClock, and NetworkClock.


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