Panda3D
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
TrueClock Class Reference

An interface to whatever real-time clock we might have available in the current environment. More...

Public Member Functions

int getErrorCount ()
 Returns the number of clock errors that have been detected. More...
 
double getLongTime ()
 
double getShortRawTime ()
 
double getShortTime ()
 
bool setCpuAffinity (uint32_t mask)
 

Static Public Member Functions

static TrueClock getGlobalPtr ()
 Returns a pointer to the one TrueClock object in the world. More...
 

Public Attributes

int error_count
 Returns the number of clock errors that have been detected. More...
 
double long_time
 get_long_time() returns the most accurate timer we have over a long interval. It may not be very precise for measuring short intervals, but it should not drift substantially over the long haul. More...
 
double short_raw_time
 get_short_raw_time() is like get_short_time(), but does not apply any corrections (e.g. paranoid-clock) to the result returned by the OS. More...
 
double short_time
 get_short_time() returns the most precise timer we have over a short interval. It may tend to drift over the long haul, but it should have lots of digits to measure short intervals very precisely. More...
 

Detailed Description

An interface to whatever real-time clock we might have available in the current environment.

There is only one TrueClock in existence, and it constructs itself.

The TrueClock returns elapsed real time in seconds since some undefined epoch. Since it is not defined at what time precisely the clock indicates zero, this value can only be meaningfully used to measure elapsed time, by sampling it at two different times and subtracting.

Member Function Documentation

◆ getErrorCount()

int getErrorCount ( )

Returns the number of clock errors that have been detected.

Each time a clock error is detected, in which the value returned by either of the above methods is suspect, the value returned by this method will be incremented. Applications can monitor this value and react, for instance, by resynchronizing their clocks each time this value changes.

◆ getGlobalPtr()

static TrueClock getGlobalPtr ( )
static

Returns a pointer to the one TrueClock object in the world.

◆ getLongTime()

double getLongTime ( )

◆ getShortRawTime()

double getShortRawTime ( )

◆ getShortTime()

double getShortTime ( )

◆ setCpuAffinity()

bool setCpuAffinity ( uint32_t  mask)

Member Data Documentation

◆ error_count

int error_count

Returns the number of clock errors that have been detected.

Each time a clock error is detected, in which the value returned by either of the above methods is suspect, the value returned by this method will be incremented. Applications can monitor this value and react, for instance, by resynchronizing their clocks each time this value changes.

◆ long_time

double long_time

get_long_time() returns the most accurate timer we have over a long interval. It may not be very precise for measuring short intervals, but it should not drift substantially over the long haul.

◆ short_raw_time

double short_raw_time

get_short_raw_time() is like get_short_time(), but does not apply any corrections (e.g. paranoid-clock) to the result returned by the OS.

◆ short_time

double short_time

get_short_time() returns the most precise timer we have over a short interval. It may tend to drift over the long haul, but it should have lots of digits to measure short intervals very precisely.