cTriggerFunctionBaseabstract
Concept class: Basic Trigger functionality. More...
Inheritance diagram for cTriggerFunctionBase:
Public Member Functions | |
| cTriggerFunctionBase () | |
| CTOR This will create a lambda connection between the ITriggerPipeItem::Run call and your implemeted functionality within cTriggerFunctionBase::RunTrigger. | |
| cTriggerFunctionBase (const char *strName) | |
| virtual tResult | GetName (base::IString &&strName) const |
| void | SetName (const char *strName) |
| virtual tResult | SetDefaultProperties (base::ant::IConfiguration &) |
| virtual tResult | Configure () |
| virtual tResult | SetFilter (cFilter &oFilter) |
| virtual tResult | ConnectReadersAndWriters (cFilter &) |
| virtual void | SetParentFullName (const adtf::util::cString &strParentFullName) |
| tResult | RunTrigger (tTimeStamp tmTimeofActivation) |
| The Basic Activities are implemented in this Function. More... | |
| virtual tResult | ProcessInputs (tTimeStamp) |
| this function is only a structural hint implement your data collection within this method before Process is called | |
| virtual tResult | Process (tTimeStamp tmTime)=0 |
| this is to implement your functionality and needs to overwrite | |
| virtual tResult | ProcessOutputs (tTimeStamp) |
| This function is a structural hint to process the outputs after Process was called. More... | |
 Public Member Functions inherited from runnable< base::ant::IRunnable::RUN_TRIGGER > | |
| runnable () | |
| CTOR. | |
| runnable (IRunnable::tRunFunction fcRunOnceFunc) | |
| Main CTOR with callable function. More... | |
| virtual | ~runnable ()=default |
| DTOR. | |
| tResult | Run (tTimeStamp tmTimeofActivation, IRunnable::tActivationType ui32ActivationType, const void *, size_t) override |
IRunnable::Run implementation which will call m_fcRunOnceFunc if ui32ActivationType is TYPE_OF_ACTIVATION. More... | |
| virtual IRunnable::tActivationType | GetActivationType () const |
| Returns the type of activation implemented. More... | |
| Public Member Functions inherited from object< IRunnable, IRunnable > | |
| 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 configuration< Interface > | |
| configuration () | |
| CTOR. | |
| virtual | ~configuration ()=default |
| DTOR. | |
| tResult | GetProperties (adtf::ucom::ant::iobject_ptr< const IProperties > &pProperties) const override |
| Gets the configuration with only read access. More... | |
| tResult | GetProperties (adtf::ucom::ant::iobject_ptr< IProperties > &pProperties) override |
| Gets the properties of configuration with only read/write access. More... | |
| tResult | AttachConfiguration (const char *strName, IConfiguration &pAttachedConfiguration) override |
| tResult | DetachConfiguration (const char *strName) override |
| tResult | RegisterPropertyVariable (const char *strName, cPropertyVariable &oPropertyVariable) |
| tResult | UnregisterPropertyVariable (cPropertyVariable &oPropertyVariable) |
| Public Member Functions inherited from object< IConfiguration, IConfiguration > | |
| 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... | |
Protected Attributes | |
| adtf_util::cString | m_strName |
| Name of the TriggerFunction used to create the IRunner. | |
| adtf_util::cString | m_strProfilingFullName |
| adtf_util::cString | m_strProfilingInputs |
| adtf_util::cString | m_strProfilingProcess |
| adtf_util::cString | m_strProfilingOutputs |
| adtf_util::cString | m_strProfilingStartedEvent |
| adtf_util::cString | m_strProfilingFinishedEvent |
| Protected Attributes inherited from runnable< base::ant::IRunnable::RUN_TRIGGER > | |
| IRunnable::tRunFunction | m_fcRunOnceFunc |
| given function to call on Run | |
| Protected Attributes inherited from configuration< Interface > | |
| adtf::ucom::object_ptr< spider::cProperties > | m_pProperties = nullptr |
| the current runtiem property set | |
Additional Inherited Members | |
| Protected Member Functions inherited from IObject | |
| ~IObject ()=default | |
| Protected destructor --> Use implemented Destroy() instead of delete! | |
Detailed Description
Concept class: Basic Trigger functionality.
This concept class can be used within the templates to generate a filter implementation.
Definition at line 36 of file triggerfunction_base.h.
Member Function Documentation
◆ ProcessOutputs()
|
virtual |
This function is a structural hint to process the outputs after Process was called.
The cTriggerFunction will use this to flush all outputs. So you do not need to flush within your Process implementation.
- Parameters
-
[in] tmTime
- See also
- cTriggerFunction::ProcessOutputs
Reimplemented in cTriggerFunction.
◆ RunTrigger()
| tResult RunTrigger | ( | tTimeStamp | tmTimeofActivation | ) |
The Basic Activities are implemented in this Function.
- Parameters
-
[in] tmTimeofActivation