adtf::services::penguin::IReferenceClock::ITimeGuard Class Reference

#include <reference_clock_intf.h>

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

Public Member Functions
	ADTF_IID (ITimeGuard, "time_guard.reference_clock.penguin.streaming.adtf.iid")
virtual tResult	CreateBarrier (base::flash::tNanoSeconds tmBegin, base::flash::tNanoSeconds tmEnd, ucom::ant::iobject_ptr< ITimeBarrier > &pBarrier)=0
virtual void	Cancel ()=0
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

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 time manipulation and monitoring.

See also

Clock Handling

Member Function Documentation

Cancel()

virtual void adtf::services::penguin::IReferenceClock::ITimeGuard::Cancel ( )

pure virtual

Cancels all ongoing and future ITimeBarrier::WaitUntilBegin() calls.

CreateBarrier()

virtual tResult adtf::services::penguin::IReferenceClock::ITimeGuard::CreateBarrier ( base::flash::tNanoSeconds tmBegin, base::flash::tNanoSeconds tmEnd, ucom::ant::iobject_ptr< ITimeBarrier > & pBarrier )

pure virtual

Creates a new time barrier at tmTimePoint.

Parameters

[in]	tmBegin	The begin time point of the time barrier. If ITimeBarrier::NoTimePoint, no begin time point will be created and you cannot use ITimeBarrier::WaitUntilBegin().
[in]	tmEnd	The end time point of the time barrier. If ITimeBarrier::NoTimePoint, no end time point will be created and this barrier has no deadline for completion.
[out]	pBarrier	Call ITimeBarrier::WaitUntilBegin() to sleep until tmBegin is reached, and keep this object until all your computations that need to be completed before tmEnd are done.

Returns

Standard result.

---

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

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