ADTF  3.18.2
cRunner

Default and simple Runner implementation. More...

Inheritance diagram for cRunner:
[legend]

Public Member Functions

 cRunner ()=default
 CTOR.
 
 cRunner (const char *strName)
 CTOR to set a name. More...
 
 cRunner (const char *strName, base::IRunnable &oRunnable)
 CTOR to set a name and initialize with a Runnable instance immediatelly. More...
 
 cRunner (const char *strName, base::IRunnable::tRunFunction oRunFunc)
 CTOR to set a name and initialize with a Runnable instance immediatelly. More...
 
void SetRunnable (adtf::base::ant::IRunnable &oRunnable)
 Sets the Runnable implementation to call if Run is called. More...
 
tResult SetName (const char *strName) override
 
tResult SetParent (const ucom::ant::IObject *oParentObject) override
 
- Public Member Functions inherited from named_graph_object< trigger_pipe_item< IRunner > >
 named_graph_object ()
 CTOR.
 
 named_graph_object (const char *strName)
 CTOR with name. More...
 
virtual ~named_graph_object ()=default
 DTOR.
 
tResult SetName (const char *strName) override
 Sets the Name of the object. More...
 
tResult GetName (base::ant::IString &&strName) const override
 Gets the Name of the object. More...
 
tResult SetParent (const ucom::ant::IObject *poParentObject) override
 Sets Parent of the object. More...
 
tResult GetParent (const ucom::ant::IObject *&poParentObject) const override
 Gets the Parent of the object. More...
 
- Public Member Functions inherited from object< Bases >
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...
 

Private Types

typedef named_graph_object< trigger_pipe_item< IRunner > > base_type
 

Private Attributes

std::shared_ptr< base::runnable< base::IRunnable::RUN_TRIGGER > > m_pInternalRunnable
 

Additional Inherited Members

- Protected Member Functions inherited from named_graph_object< trigger_pipe_item< IRunner > >
 named_graph_object (const named_graph_object &)=delete
 delete copy CTOR
 
 named_graph_object (named_graph_object &&)=delete
 delete move CTOR
 
named_graph_objectoperator= (const named_graph_object &)=delete
 delete copy operator
 
named_graph_objectoperator= (named_graph_object &&)=delete
 delete move operator
 
void LogNamedMessage (const char *strMessage)
 Helper to log a message with the full name of the object. More...
 
- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 

Detailed Description

Default and simple Runner implementation.

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

Constructor & Destructor Documentation

◆ cRunner() [1/3]

cRunner ( const char *  strName)
inline

CTOR to set a name.

Parameters
strNamename for the graph object

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

◆ cRunner() [2/3]

cRunner ( const char *  strName,
base::IRunnable oRunnable 
)
inline

CTOR to set a name and initialize with a Runnable instance immediatelly.

Parameters
strNamename for the graph object
oRunnablereference to the runnable which will be called by the runner.

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

References cRunner::SetRunnable().

◆ cRunner() [3/3]

cRunner ( const char *  strName,
base::IRunnable::tRunFunction  oRunFunc 
)
inline

CTOR to set a name and initialize with a Runnable instance immediatelly.

Parameters
strNamename for the graph object
oRunFuncreference to the function which will be called by the runner.

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

References trigger_pipe_item< INTERFACE >::SetRunnable().

Member Function Documentation

◆ SetRunnable()

void SetRunnable ( adtf::base::ant::IRunnable oRunnable)
inline

Sets the Runnable implementation to call if Run is called.

See also
trigger_pipe_item::Run implementation
Parameters
[in]oRunnableThe reference to the Runnable instance.
Remarks
Make sure the given oRunnable lives at least longer than the trigger_pipe_item
Returns
void

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

References trigger_pipe_item< INTERFACE >::SetRunnable().

Referenced by cRunner::cRunner().