runnable< TYPE_OF_ACTIVATION, AntInterface, Interface >

Inheritance diagram for runnable< TYPE_OF_ACTIVATION, AntInterface, Interface >:

Public Member Functions
	runnable ()=default
	CTOR.
	runnable (adtf::base::flash::IRunnable::tRunFunction fcRunOnceFunc)
	Main CTOR with callable function.
	runnable (ant::IRunnable::tRunFunction fcRunOnceFunc)
	Compatibility CTOR with callable function.
	~runnable () override=default
	DTOR.
tResult	Run (tTimeStamp tmTimeofActivation, ant::IRunnable::tActivationType ui32ActivationType, const void *pvUserData, size_t nUserDataSize) override
tResult	Run (tNanoSeconds tmTimeofActivation, ant::IRunnable::tActivationType ui32ActivationType, const void *, size_t) override
	IRunnable::Run implementation which will call m_fcRunOnceFunc if ui32ActivationType is TYPE_OF_ACTIVATION.
ant::IRunnable::tActivationType	GetActivationType () const override
	Returns the type of activation implemented.
Public Member Functions inherited from object< ant::IRunnable, ant::IRunnable, IRunnable, IRunnable >
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.
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.
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 IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
	Marks the IObject to be castable with the ucom_cast()

Protected Attributes
adtf::base::flash::IRunnable::tRunFunction	m_fcRunOnceFunc = nullptr
	given function to call on Run

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

Detailed Description

template<ant::IRunnable::tActivationType TYPE_OF_ACTIVATION = ant::IRunnable::RUN_UNSPECIFIED, typename AntInterface = ant::IRunnable, typename Interface = IRunnable>
class adtf::base::flash::runnable< TYPE_OF_ACTIVATION, AntInterface, Interface >

Definition at line 115 of file runnable.h.

Constructor & Destructor Documentation

runnable() [1/2]

template<ant::IRunnable::tActivationType TYPE_OF_ACTIVATION = ant::IRunnable::RUN_UNSPECIFIED, typename AntInterface = ant::IRunnable, typename Interface = IRunnable>

runnable ( adtf::base::flash::IRunnable::tRunFunction fcRunOnceFunc )

inline

Main CTOR with callable function.

Parameters

fcRunOnceFunc

run function

Definition at line 126 of file runnable.h.

runnable() [2/2]

template<ant::IRunnable::tActivationType TYPE_OF_ACTIVATION = ant::IRunnable::RUN_UNSPECIFIED, typename AntInterface = ant::IRunnable, typename Interface = IRunnable>

runnable ( ant::IRunnable::tRunFunction fcRunOnceFunc )

inline

Compatibility CTOR with callable function.

Parameters

fcRunOnceFunc

run function

Definition at line 133 of file runnable.h.

Member Function Documentation

GetActivationType()

template<ant::IRunnable::tActivationType TYPE_OF_ACTIVATION = ant::IRunnable::RUN_UNSPECIFIED, typename AntInterface = ant::IRunnable, typename Interface = IRunnable>

ant::IRunnable::tActivationType GetActivationType ( ) const

inlineoverride

Returns the type of activation implemented.

Returns

the activation type given by TYPE_OF_ACTIVATION

Definition at line 183 of file runnable.h.

Run() [1/2]

template<ant::IRunnable::tActivationType TYPE_OF_ACTIVATION = ant::IRunnable::RUN_UNSPECIFIED, typename AntInterface = ant::IRunnable, typename Interface = IRunnable>

tResult Run ( tNanoSeconds tmTimeofActivation, ant::IRunnable::tActivationType ui32ActivationType, const void * , size_t  )

inlineoverride

IRunnable::Run implementation which will call m_fcRunOnceFunc if ui32ActivationType is TYPE_OF_ACTIVATION.

Return values

ERR_NOT_INITIALIZED

m_fcRunOnceFunc is not set

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.

Definition at line 162 of file runnable.h.

Run() [2/2]

template<ant::IRunnable::tActivationType TYPE_OF_ACTIVATION = ant::IRunnable::RUN_UNSPECIFIED, typename AntInterface = ant::IRunnable, typename Interface = IRunnable>

tResult Run ( tTimeStamp tmTimeofActivation, ant::IRunnable::tActivationType ui32ActivationType, const void * pvUserData, size_t nUserDataSize )

inlineoverride

Definition at line 144 of file runnable.h.

Member Data Documentation

m_fcRunOnceFunc

template<ant::IRunnable::tActivationType TYPE_OF_ACTIVATION = ant::IRunnable::RUN_UNSPECIFIED, typename AntInterface = ant::IRunnable, typename Interface = IRunnable>

adtf::base::flash::IRunnable::tRunFunction m_fcRunOnceFunc = nullptr

protected

given function to call on Run

Definition at line 119 of file runnable.h.

Referenced by runnable< nActivationType, base::ant::IRunnable, adtf::services::ant::IKernel::IKernelRunnable >::Run().