adtf::streaming::cActiveRunner Class Reference

#include <runner.h>

Inherits adtf::streaming::trigger_pipe_source< INamedGraphObject, ucom::ant::cClassInfo, base::ant::configuration<>, ant::IActiveRunner, spider::IActiveRunner >.

Public Member Functions
	cActiveRunner ()
	~cActiveRunner () override
tResult	SetName (const char *strName) override
tResult	SetParent (const ucom::ant::IObject *pParentObject) override
tResult	WaitForDeactivation () override
Public Member Functions inherited from adtf::streaming::trigger_pipe_source< INamedGraphObject, ucom::ant::cClassInfo, base::ant::configuration<>, ant::IActiveRunner, spider::IActiveRunner >
	trigger_pipe_source ()=default
	CTOR.
virtual	~trigger_pipe_source ()=default
	DTOR.
tResult	RegisterSubItem (const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun, ITriggerPipeItem::tPriority ui32Prio) override
tResult	UnregisterSubItem (const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun) override
tResult	ChangePriority (const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun, ITriggerPipeItem::tPriority ui32Prio) override
tResult	GetSubItems (adtf::ucom::ant::iobject_enum< const ITriggerPipeItem > &lstSubItems) const override
tResult	GetName (base::ant::IString &&strName) const
tResult	SetName (const char *strName)
tResult	SetParent (const ucom::ant::IObject *oParentObject)
tResult	GetParent (const ucom::ant::IObject *&poParentObject) const
Public Member Functions inherited from adtf::ucom::catwo::object< Bases >
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Member Functions
void	Trigger (base::flash::tNanoSeconds tmTimeOfTrigger)
void	Trigger ()
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

Default Base implementation for an Active Runner. The Active Runner is the main entry point for the trigger pipe. It will trigger all registered items on its Trigger() call. If using this base class u still need to implement:

tResult Activate() override;
tResult Deactivate() override;
bool IsActivated() const override;

Constructor & Destructor Documentation

cActiveRunner()

adtf::streaming::cActiveRunner::cActiveRunner

(

)

Constructor.

~cActiveRunner()

adtf::streaming::cActiveRunner::~cActiveRunner ( )

override

Destructor.

Member Function Documentation

SetName()

tResult adtf::streaming::cActiveRunner::SetName ( const char * strName )

override

SetParent()

tResult adtf::streaming::cActiveRunner::SetParent ( const ucom::ant::IObject * pParentObject )

override

Trigger() [1/2]

void adtf::streaming::cActiveRunner::Trigger ( )

protected

This method will trigger all registered trigger pipe items.

The time stamp will be retrieved from the Reference Clock. Errors will be handled via adtf::base::elasto::IErrorHandling.

Trigger() [2/2]

void adtf::streaming::cActiveRunner::Trigger ( base::flash::tNanoSeconds tmTimeOfTrigger )

protected

This method will trigger all registered trigger pipe items.

Errors will be handled via adtf::base::elasto::IErrorHandling.

Parameters

[in]

tmTimeOfTrigger

The timestamp that will passed on.

WaitForDeactivation()

tResult adtf::streaming::cActiveRunner::WaitForDeactivation ( )

inlineoverride

This function ensures that the runner is no longer processing a trigger and is not going to emit any further trigger calls.

Returns

Standard result code. this implementation does not wait for deactivation

---

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

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