adtf::filter::cTriggerFunctionBase Class Reference

#include <triggerfunction_base.h>

Inherits adtf::base::runnable< DEFAULT_ACTIVATION_TYPE, ANT_INTERFACE, flash::IRunnable, CALLABLE >, and adtf::base::ant::configuration< Interface >.

Inherited by adtf::filter::ant::cTriggerFunction.

Public Member Functions
	cTriggerFunctionBase ()
	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)
virtual tResult	ProcessInputs (tTimeStamp)
virtual tResult	Process (tTimeStamp tmTime)=0
	this is to implement your functionality and needs to overwrite
virtual tResult	ProcessOutputs (tTimeStamp)
Public Member Functions inherited from adtf::base::runnable< DEFAULT_ACTIVATION_TYPE, ANT_INTERFACE, flash::IRunnable, CALLABLE >
	runnable ()=delete
	CTOR.
	runnable (CALLABLE &&fcRunFunc) noexcept
	runnable (CALLABLE_WITH_TIMSTAMP &&fcRunFunc) noexcept
	runnable (CALLABLE &&fcRunFunc, ant::IRunnable::tActivationType ui32ActivationType) noexcept
	~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 *pvUserData, size_t nUserDataSize) override
ant::IRunnable::tActivationType	GetActivationType () const override
	runnable ()=delete
	CTOR.
	runnable (CALLABLE &&fcRunFunc) noexcept
	runnable (CALLABLE_WITH_TIMSTAMP &&fcRunFunc) noexcept
	runnable (CALLABLE &&fcRunFunc, ant::IRunnable::tActivationType ui32ActivationType) noexcept
	~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 *pvUserData, size_t nUserDataSize) override
ant::IRunnable::tActivationType	GetActivationType () const override
Public Member Functions inherited from adtf::ucom::catwo::object< Bases >
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 adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
Public Member Functions inherited from adtf::base::ant::configuration< Interface >
	configuration ()
	CTOR.
virtual	~configuration ()=default
	DTOR.
tResult	GetProperties (adtf::ucom::ant::iobject_ptr< const IProperties > &pProperties) const override
tResult	GetProperties (adtf::ucom::ant::iobject_ptr< IProperties > &pProperties) override
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 adtf::ucom::catwo::object< IConfiguration, IConfiguration >
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.

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 adtf::base::runnable< DEFAULT_ACTIVATION_TYPE, ANT_INTERFACE, flash::IRunnable, CALLABLE >
std::decay_t< CALLABLE >	m_fcRunFunc
	given function to call on Run
std::decay_t< CALLABLE >	m_fcRunFunc
	given function to call on Run
Protected Attributes inherited from adtf::base::ant::configuration< Interface >
adtf::ucom::object_ptr< spider::cProperties >	m_pProperties = nullptr
	the current runtiem property set

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

Detailed Description

Concept class: Basic Trigger functionality. This concept class can be used within the templates to generate a filter implementation.

See also

data_triggered_filter

time_triggered_filter

thread_triggered_filter

triggered_filter

Constructor & Destructor Documentation

cTriggerFunctionBase()

adtf::filter::ant::cTriggerFunctionBase::cTriggerFunctionBase

(

)

CTOR This will create a lambda connection between the ITriggerPipeItem::Run call and your implemeted functionality within cTriggerFunctionBase::RunTrigger

Member Function Documentation

ProcessInputs()

virtual tResult adtf::filter::ant::cTriggerFunctionBase::ProcessInputs ( tTimeStamp )

virtual

this function is only a structural hint implement your data collection within this method before Process is called

ProcessOutputs()

virtual tResult adtf::filter::ant::cTriggerFunctionBase::ProcessOutputs ( tTimeStamp )

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

RunTrigger()

tResult adtf::filter::ant::cTriggerFunctionBase::RunTrigger

(

tTimeStamp

tmTimeofActivation

)

The Basic Activities are implemented in this Function.

Parameters

[in]

tmTimeofActivation

---

The documentation for this class was generated from the following file:

• src/libraries/filtersdk/include/adtffiltersdk/triggerfunction_base.h