ADTF
Loading...
Searching...
No Matches
adtf::remote::ant::IClock Class Referenceabstract

#include <adtf_remote_clock_intf.h>

Public Member Functions

 ADTF_IID (IClock, "clock.ant.remote.adtf")
 RPC IID of the Clock.
 
virtual tTimeStamp GetStreamTime () const =0
 
virtual tTimeStamp GetTime () const =0
 
virtual const char * GetClocks () const =0
 
virtual tTimeStamp GetTimeOfClock (const char *strClockName) const =0
 

Static Public Attributes

static constexpr const tChar *const DEFAULT_NAME = "clock"
 Default rpc object server name within an ADTF System.
 

Detailed Description

The Remote Clock interface provides access to retrieve information of the current adtf::services::ant::IReferenceClock.

See also
cADTFRemoteSystem.

Member Function Documentation

◆ GetClocks()

virtual const char * adtf::remote::ant::IClock::GetClocks ( ) const
pure virtual

Returns the current available clocks within adtf::services::ant::IReferenceClock

Returns
Return a comma separated list of the clocks.

◆ GetStreamTime()

virtual tTimeStamp adtf::remote::ant::IClock::GetStreamTime ( ) const
pure virtual

Retrieves the stream time which is reset at the start of the stream.

Returns
Returns the current streamtime in microseconds. (see also Clock Handling for further information)

◆ GetTime()

virtual tTimeStamp adtf::remote::ant::IClock::GetTime ( ) const
pure virtual

Retrieves the current reference time. The GetTime method retrieves the current reference time.

Returns
Returns the current time in microseconds. (see also Clock Handling for further information).

◆ GetTimeOfClock()

virtual tTimeStamp adtf::remote::ant::IClock::GetTimeOfClock ( const char * strClockName) const
pure virtual

Returns the current timestamp of the adtf::services::ant::IReferenceClock if strClockName is available.

Parameters
[in]strClockNameone clock name out of the return value of adtf::remote::ant::IClock::GetClocks

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