ADTF  3.18.2
runtime_behaviour< Interface >

Default Class Template for a Runtime Behaviour implementation. More...

Inheritance diagram for runtime_behaviour< Interface >:
[legend]

Public Member Functions

tResult GetRunners (ucom::ant::iobject_list< IRunner > &lstRunners) const override
 Returns the current Runners. More...
 
tResult FindRunner (const char *strName, ucom::ant::iobject_ptr< adtf::ucom::ant::IObject > &pRunner) const override
 Find a Runner with the name of strName (only const access) More...
 
tResult GetInnerPipes (ucom::ant::iobject_list< ITriggerPipe > &lstInnerTriggerPipes) const override
 Returns the current internal TriggerPipes. More...
 
- Public Member Functions inherited from object< IRuntimeBehaviour, Interface >
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...
 
- Public Member Functions inherited from cRuntimeBehaviour
tResult GetRunners (ucom::ant::iobject_list< IRunner > &lstRunners) const
 copydoc IRuntimeBehaviour::GetRunners
 
tResult FindRunner (const char *strName, ucom::ant::iobject_ptr< ucom::ant::IObject > &pRunner) const
 copydoc IRuntimeBehaviour::FindRunner
 
tResult GetInnerPipes (ucom::ant::iobject_list< ITriggerPipe > &lstInnerpTriggerPipe) const
 copydoc IRuntimeBehaviour::GetInnerPipes
 
virtual tResult RegisterRunner (const ucom::ant::iobject_ptr< IRunner > &pRunner)
 Registers and publishes a IRunner object to the IRuntimeBehaviour. More...
 
virtual tResult RegisterRunner (const char *strName, base::ant::IRunnable &oRunnable)
 Create and Registers a IRunner object for your oRunnable with the name strName. More...
 
virtual tResult UnregisterRunner (const ucom::ant::iobject_ptr< IRunner > &pRunner)
 Unregisters a Runner. More...
 
tResult ReleaseRunners ()
 Release every registered Runners
More...
 
virtual tResult RegisterInnerPipe (const ucom::ant::iobject_ptr< ITriggerPipe > &pTriggerPipe)
 Registers and publishes an inner ITriggerPipe object to the IRuntimeBehaviour. More...
 
virtual tResult UnregisterInnerPipe (const ucom::ant::iobject_ptr< ITriggerPipe > &pTriggerPipe)
 Unregisters an inner ITriggerPipe object. More...
 
tResult ReleaseTriggerPipes ()
 Release and unregister every registered TriggerPipes. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 
- Protected Member Functions inherited from cRuntimeBehaviour
 cRuntimeBehaviour ()
 CTOR.
 
virtual ~cRuntimeBehaviour ()
 DTOR.
 

Detailed Description

template<typename Interface>
class adtf::streaming::ant::runtime_behaviour< Interface >

Default Class Template for a Runtime Behaviour implementation.

This template helps to prevent multiple inheritance.

Template Parameters
InterfaceUse the parameter for your type which is derived by IRuntimeBehaviour.

Definition at line 113 of file runtime_behaviour.h.

Member Function Documentation

◆ FindRunner()

tResult FindRunner ( const char *  strName,
ucom::ant::iobject_ptr< adtf::ucom::ant::IObject > &  pRunner 
) const
inlineoverride

Find a Runner with the name of strName (only const access)

Parameters
strName[in] Pointer to a string that identifies the pin that searches for. Call the IRunner::GetName method to retrieve a runner's identifier.
pRunner[out] contains the runner if found.
Returns
Returns a standard result code.
Return values
ERR_NOT_FOUNDRunner with the given name strName not found.

Definition at line 122 of file runtime_behaviour.h.

References cRuntimeBehaviour::FindRunner().

◆ GetInnerPipes()

tResult GetInnerPipes ( ucom::ant::iobject_list< ITriggerPipe > &  lstInnerTriggerPipes) const
inlineoverride

Returns the current internal TriggerPipes.

Parameters
[out]lstInnerTriggerPipesobject_list where to push the triggerpipes to.
Returns
Returns a standard result code.

Definition at line 127 of file runtime_behaviour.h.

References cRuntimeBehaviour::GetInnerPipes().

◆ GetRunners()

tResult GetRunners ( ucom::ant::iobject_list< IRunner > &  lstRunners) const
inlineoverride

Returns the current Runners.

Parameters
[out]lstRunnersobject_list where to push the runners to.
Returns
Returns a standard result code.

Definition at line 117 of file runtime_behaviour.h.

References cRuntimeBehaviour::GetRunners().