SoftSyncAlgorithm Class Reference

Inheritance diagram for SoftSyncAlgorithm:

Public Member Functions
void	initiate () override
	initate sets value of starting parameters needed for calculation. More...
void	deInit () override
	deInit prepares closer aproximation of starting parameters from current data. More...
void	reset () override
	reset function resets all internal parameters which are used for calculation.
void	synchronizeClocks (double masterTime, double slaveTime) override
	synchronizeClocks calculates parameters needed for transformation of slave clock to master clock time domain More...
void	setDeviceTime (double masterClock, double slaveClock)
	setDeviceTime (deprecated, use synchronizeClocks) calculates parameters needed for transformation of slave clock to master clock time domain More...
double	masterTimeAt (double slaveTime) const override
	masterTimeAt transforms slave clock to master clock time domain More...
double	slaveTimeAt (double masterTime) const override
	slaveTimeAt transforms master clock to slave clock time domain More...
double	readSystemTimeD (double slaveClock)
	readSystemTimeD (deprecated, use masterTimeAt instead) transforms slave clock to master clock time domain More...
Public Member Functions inherited from SoftSyncBase
virtual void	setDeviceRate (double rate)
virtual double	getDeviceRate ()

Static Public Attributes
static constexpr int	clkNoClock = -1

Protected Member Functions
void	resetRegression ()

Protected Attributes
double	timeScale
double	timeOffset
int	numberOfSyncs
Protected Attributes inherited from SoftSyncBase
double	masterClockOld
double	slaveClockOld
double	deviceRate

Member Function Documentation

deInit()

void SoftSyncAlgorithm::deInit ( )

overridevirtual

deInit prepares closer aproximation of starting parameters from current data.

It should be called after the measurement

Implements SoftSyncBase.

initiate()

void SoftSyncAlgorithm::initiate ( )

overridevirtual

initate sets value of starting parameters needed for calculation.

It should be called before start of measurement.

Reimplemented from SoftSyncBase.

masterTimeAt()

double SoftSyncAlgorithm::masterTimeAt ( double  slaveTime ) const

overridevirtual

masterTimeAt transforms slave clock to master clock time domain

Parameters

slaveTime

float time of slave clock

Returns

double slave clock transformed to master time domain

Implements SoftSyncBase.

readSystemTimeD()

double SoftSyncAlgorithm::readSystemTimeD

(

double

slaveClock

)

readSystemTimeD (deprecated, use masterTimeAt instead) transforms slave clock to master clock time domain

Parameters

slaveClock

float value of slave clock

Returns

double slave clock transformed to master time domain

setDeviceTime()

void SoftSyncAlgorithm::setDeviceTime	(	double	masterClock,
		double	slaveClock
	)

setDeviceTime (deprecated, use synchronizeClocks) calculates parameters needed for transformation of slave clock to master clock time domain

Parameters

masterClock	float value of master clock
slaveClock	float value of slave clock

slaveTimeAt()

double SoftSyncAlgorithm::slaveTimeAt ( double  masterTime ) const

overridevirtual

slaveTimeAt transforms master clock to slave clock time domain

Parameters

masterTime

float time of master clock

Returns

double master clock transformed to slave time domain

Implements SoftSyncBase.

synchronizeClocks()

void SoftSyncAlgorithm::synchronizeClocks ( double  masterTime, double  slaveTime  )

overridevirtual

synchronizeClocks calculates parameters needed for transformation of slave clock to master clock time domain

Parameters

masterTime	float time of master clock
slaveTime	float time of slave clock

Implements SoftSyncBase.

---

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

• C:/CProjects/Libs/CommonLib/include/commonlib/synchronization/softsyncalgorithm.h