ADTF
Loading...
Searching...
No Matches
triggered_filter< TriggerFunctionImpl >

Simple Filter for Registering One Triggerfunction to a filter. More...

#include <triggered_filter.h>

Inheritance diagram for triggered_filter< TriggerFunctionImpl >:
[legend]

Protected Member Functions

tResult Init (tInitStage eStage) override
 
tResult SetParent (const adtf::ucom::ant::IObject *poParentObject) override
 
virtual tResult CreateDefaultTrigger (const char *strTriggerFuncName)
 
- Protected Member Functions inherited from cFilter
 cFilter ()
 CTOR.
 
virtual ~cFilter () override
 DTOR.
 
- Protected Member Functions inherited from cConfigurableFilter
 cConfigurableFilter ()=default
 CTOR.
 
virtual ~cConfigurableFilter ()=default
 DTOR.
 
- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor --> Only the final implementation can be destroyed!
 

Private Member Functions

 triggered_filter (const triggered_filter &)=delete
 
 triggered_filter (triggered_filter &&)=delete
 
triggered_filteroperator= (const triggered_filter &)=delete
 
triggered_filteroperator= (triggered_filter &&)=delete
 

Private Attributes

TriggerFunctionImpl m_oTriggerFunc
 

Additional Inherited Members

- Public Types inherited from cFilter
using tInitStage = streaming::ant::cFilterBase::tInitStage
 
- Public Types inherited from cConfigurableFilter
typedef base::ant::configuration base_type_conf
 used base type
 
typedef streaming::ant::cFilterBase base_type_filter
 
- Public Member Functions inherited from cFilter
tResult RegisterRunner (const char *strName, adtf::base::ant::IRunnable &oRunnable) override
 
tResult ConfigureDataInTrigger (const char *strRunnerName, const char *strPinName)
 Creates an internal trigger pipe for the given pin.
 
tResult ConfigureDataOutTrigger (const char *strRunnerName, const char *strPinName)
 Creates an internal trigger pipe for the given pin.
 
tResult ConfigureTimerTrigger (const char *strRunnerName, tTimeStamp tmPeriod)
 Creates an internal a internal trigger configuration for a timing trigger.
 
tResult ConfigureThreadTrigger (const char *strRunnerName, bool bCallCyclic)
 Creates an internal a internal thread configuration for a timing trigger.
 
- Public Member Functions inherited from cConfigurableFilter
tResult GetProperties (ucom::ant::iobject_ptr< const base::ant::IProperties > &pProperties) const override
 Gets the properties with read access.
 
tResult GetProperties (ucom::ant::iobject_ptr< base::ant::IProperties > &pProperties) override
 Gets the properties with read access.
 
tResult AttachConfiguration (const char *strName, base::ant::IConfiguration &oAttachedConfiguration) override
 Attaches the given configuration and its properties as property tree item of this.
 
tResult DetachConfiguration (const char *strName) override
 Detaches a configuration with the specified name.
 
- Public Member Functions inherited from object< streaming::ant::cFilterBase, base::ant::configuration<> >
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()
 

Detailed Description

template<typename TriggerFunctionImpl>
class adtf::filter::ant::triggered_filter< TriggerFunctionImpl >

Simple Filter for Registering One Triggerfunction to a filter.

This is the base template creating a filter which auto register reader and writers to pins. The Pins will be created. The TriggerFunctionImpl must declared as a sub class of cTriggerFunction.

Template Parameters
TriggerFunctionImplTriggerFunction type.

Definition at line 27 of file triggered_filter.h.

Constructor & Destructor Documentation

◆ triggered_filter()

template<typename TriggerFunctionImpl>
triggered_filter ( )
inlineprotected

Definition at line 38 of file triggered_filter.h.

◆ ~triggered_filter()

template<typename TriggerFunctionImpl>
~triggered_filter ( )
inlineprotected

Definition at line 49 of file triggered_filter.h.

Member Function Documentation

◆ CreateDefaultTrigger()

template<typename TriggerFunctionImpl>
virtual tResult CreateDefaultTrigger ( const char * strTriggerFuncName)
inlineprotectedvirtual

Definition at line 74 of file triggered_filter.h.

◆ Init()

template<typename TriggerFunctionImpl>
tResult Init ( tInitStage eStage)
inlineoverrideprotected

Definition at line 52 of file triggered_filter.h.

◆ SetParent()

template<typename TriggerFunctionImpl>
tResult SetParent ( const adtf::ucom::ant::IObject * poParentObject)
inlineoverrideprotected

Definition at line 67 of file triggered_filter.h.

Member Data Documentation

◆ m_oTriggerFunc

template<typename TriggerFunctionImpl>
TriggerFunctionImpl m_oTriggerFunc
private

Definition at line 35 of file triggered_filter.h.