ADTF  3.18.2
cActiveRunner

Base class for implementing Active Runner. More...

Inheritance diagram for cActiveRunner:
[legend]

Public Member Functions

 cActiveRunner ()
 Constructor.
 
 ~cActiveRunner () override
 Destructor.
 
tResult GetName (base::ant::IString &&strName) const override
 
tResult SetName (const char *strName) override
 
tResult SetParent (const ucom::ant::IObject *pParentObject) override
 
tResult GetParent (const ucom::ant::IObject *&pParentObject) const override
 
tResult RegisterSubItem (const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun, tPriority ui32Prio) override
 
tResult UnregisterSubItem (const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun) override
 
tResult ChangePriority (const adtf::ucom::ant::iobject_ptr< ITriggerPipeItem > &pSubRun, tPriority ui32Prio) override
 
tResult GetSubItems (adtf::ucom::ant::iobject_enum< const ITriggerPipeItem > &lstSubItems) const override
 
- Public Member Functions inherited from object< ucom::ant::cClassInfo, ant::INamedGraphObject, ant::ITriggerPipeSource, ant::IActiveRunner, base::ant::configuration<> >
tResult GetInterface (const char *i_strIID, void *&o_pInterface) override
 Query interfaces on an object. More...
 
tResult GetInterface (const char *i_strIID, const void *&o_pInterface) const override
 Provides const correct interface querying. More...
 
void Destroy () const override
 Destruct and deallocate instantiations of type IObject. More...
 
- Public Member Functions inherited from IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 Marks the IObject to be castable with the ucom_cast() More...
 

Protected Member Functions

void Trigger (base::flash::tNanoSeconds tmTimeOfTrigger)
 This method will trigger all registered trigger pipe items. More...
 
void Trigger ()
 This method will trigger all registered trigger pipe items. More...
 
- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 

Protected Attributes

std::unique_ptr< cImplementation > m_pImplementation
 

Detailed Description

Base class for implementing Active Runner.

See Qt5 Key Event Runner Plugin for an example Active Runner that uses this base class.

Definition at line 153 of file streaming3/include/adtfstreaming3/runner.h.

Member Function Documentation

◆ Trigger() [1/2]

void 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 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]tmTimeOfTriggerThe timestamp that will passed on.