adtf::base::flash::IRunnable Class Reference

More...

#include <runnable_intf.h>

Inherited by adtf::filter::flash::cTriggerFunction, and adtf::filter::hollow::cTriggerFunction.

Public Types
typedef std::function< tResult(tNanoSeconds)>	tRunFunction
	Type definition of the function used to implement Run.
typedef ant::IRunnable::tActivationType	tActivationType

Public Member Functions
	ADTF_IID (IRunnable, "runnable.flash.base.adtf.iid")
	defintion of interface id
virtual tResult	Run (tNanoSeconds tmTimeofActivation, ant::IRunnable::tActivationType ui32ActivationType, const void *pvUserData, size_t nUserDataSize)=0

Protected Member Functions
	~IRunnable ()=default
	not destructable

Detailed Description

The Runnable interface defines common methods for a running component. Within ADTF the IRunnable interface is the main interface to use for Running objects.

See also

runnable for a base implementation.

Member Function Documentation

Run()

virtual tResult adtf::base::flash::IRunnable::Run ( tNanoSeconds tmTimeofActivation, ant::IRunnable::tActivationType ui32ActivationType, const void * pvUserData, size_t nUserDataSize )

pure virtual

The Run method to set the component in running state. This method will be called to activate the component by a given activation type.

Parameters

[in]	tmTimeofActivation	Time of activation. Usually this is the StreamTime.
[in]	ui32ActivationType	The activation type for running.
[in]	pvUserData	pointer to a activation structure depending on the activation type.
[in]	nUserDataSize	Size of the activation structure. (in byte)

Returns

Standard result code.

Return values

ERR_CANCELED

Depending on the caller (timer, cyclic thread) it will break cyclic running.

Implemented in adtf::filter::cTriggerFunction, adtf::filter::flash::cTriggerFunction, and adtf::filter::hollow::cTriggerFunction.

---

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

• src/libraries/base/include/adtfbase/runnable_intf.h