adtf::services::penguin::IReferenceClock::ITimeBarrier Class Reference

#include <reference_clock_intf.h>

Inherits adtf::ucom::ant::IObject.

Public Types
enum class	tTimePointId : uint8_t { Begin = 0 , End = 1 }
	The two time points of a barrier. More...

Public Member Functions
virtual tResult	WaitUntilBegin () const =0
virtual base::flash::tNanoSeconds	GetTimePoint (tTimePointId eTimePointId) const =0
virtual bool	IsBroken (tTimePointId eTimePointId) const =0
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Static Public Attributes
static constexpr base::flash::tNanoSeconds	NoTimePoint {-1}

Additional Inherited Members
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

Interface for communicating instants of time to the clock.

See also

Clock Handling

Member Enumeration Documentation

tTimePointId

enum class adtf::services::penguin::IReferenceClock::ITimeBarrier::tTimePointId : uint8_t

strong

The two time points of a barrier.

Enumerator
Begin	The begin time point.
End	The end time point.

Member Function Documentation

GetTimePoint()

virtual base::flash::tNanoSeconds adtf::services::penguin::IReferenceClock::ITimeBarrier::GetTimePoint ( tTimePointId eTimePointId ) const

pure virtual

Parameters

[in]

eTimePointId

Whether to return the beginning or the end of the barrier.

Returns

Depending on eTimePointId, either the begin or end time point of the barrier.

IsBroken()

virtual bool adtf::services::penguin::IReferenceClock::ITimeBarrier::IsBroken ( tTimePointId eTimePointId ) const

pure virtual

Parameters

[in]

eTimePointId

Whether to check the beginning or the end of the barrier.

Returns

Whether or not the barrier has been broken.

WaitUntilBegin()

virtual tResult adtf::services::penguin::IReferenceClock::ITimeBarrier::WaitUntilBegin ( ) const

pure virtual

Waits until the time has reached or passed the beginning of the barrier.

Return values

ERR_CANCELLED	Either ITimeGuard::Cancel() was called or the clock is being destroyed.
ERR_RETRY	The time base has changed. You need to create a new Barrier with ITimeGuard::CreateBarrier().

Member Data Documentation

NoTimePoint

base::flash::tNanoSeconds adtf::services::penguin::IReferenceClock::ITimeBarrier::NoTimePoint {-1}

staticconstexpr

Constant for an unspecified time point.

---

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

• src/libraries/streaming3/include/adtfstreaming3/reference_clock_intf.h