libptpmgmt  1.4
libptpmgmt library that provides the functionality of linuxptp pmc
Public Member Functions | List of all members
BaseClock Class Reference

#include <ptp.h>

Inheritance diagram for BaseClock:
Inheritance graph
[legend]

Public Member Functions

Timestamp_t getTime () const
 
bool setTime (const Timestamp_t &ts) const
 
bool offsetClock (int64_t offset) const
 
float_freq getFreq () const
 
bool setFreq (float_freq freq) const
 
bool setPhase (int64_t offset) const
 

Detailed Description

Base class for clock classes

Member Function Documentation

◆ getFreq()

float_freq BaseClock::getFreq ( ) const

Get clock adjustment frequancy

Returns
freq frequancy in ppb

◆ getTime()

Timestamp_t BaseClock::getTime ( ) const

Get clock time

Returns
clock time or zero on error

◆ offsetClock()

bool BaseClock::offsetClock ( int64_t  offset) const

Offset clock time

Parameters
[in]offsetin nanoseconeds
Returns
true for success

◆ setFreq()

bool BaseClock::setFreq ( float_freq  freq) const

Set clock adjustment frequancy

Parameters
[in]freqfrequancy in ppb
Returns
true for success

◆ setPhase()

bool BaseClock::setPhase ( int64_t  offset) const

Set clock phase offset

Parameters
[in]offsetin nanoseconeds
Returns
true for success

◆ setTime()

bool BaseClock::setTime ( const Timestamp_t ts) const

Set clock time

Parameters
[out]tsnew clock time
Returns
true for success

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