Inherits adtf::filter::ant::cTriggerFunctionBase.

Public Member Functions
	cTriggerFunction (const char *strName)

tResult	SetDefaultProperties (base::ant::IConfiguration &oFilterConfig)

tResult	ConnectReadersAndWriters (cFilter &oFilter) override

tResult	ProcessOutputs (tTimeStamp) override

tResult	Register (adtf::streaming::ant::cSampleReader &oReader)

tResult	Register (adtf::streaming::ant::cSampleReader &oReader, const char strName, const char strDDLStruct)

tResult	Register (adtf::streaming::ant::cSampleReader &oReader, const char *strName, const ucom::ant::iobject_ptr< const adtf::streaming::IStreamType > &poStreamType)

tResult	Register (adtf::streaming::ant::cSampleReader &oReader, const char *strName, const adtf::streaming::IStreamType &oStreamType)

tResult	Register (adtf::streaming::ant::cSampleWriter &oWriter)

tResult	Register (adtf::streaming::ant::cSampleWriter &oWriter, const char strName, const char strDDLStruct)

tResult	Register (adtf::streaming::ant::cSampleWriter &oWriter, const char *strName, const ucom::ant::iobject_ptr< const adtf::streaming::IStreamType > &poStreamType)

tResult	Register (adtf::streaming::ant::cSampleWriter &oWriter, const char *strName, const streaming::IStreamType &oStreamType)

Public Member Functions inherited from adtf::filter::ant::cTriggerFunctionBase
	cTriggerFunctionBase ()

	cTriggerFunctionBase (const char *strName)

virtual tResult	GetName (base::IString &&strName) const

void	SetName (const char *strName)

virtual tResult	Configure ()

virtual tResult	SetFilter (cFilter &oFilter)

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

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
std::vector< streaming::ant::cSampleReader * >	m_vecOfReaders

std::vector< streaming::ant::cSampleWriter * >	m_vecOfWriters

Protected Attributes inherited from adtf::filter::ant::cTriggerFunctionBase
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!

Member Function Documentation

◆ ConnectReadersAndWriters()

tResult adtf::filter::ant::cTriggerFunction::ConnectReadersAndWriters ( cFilter & oFilter )

overridevirtual

Reimplemented from adtf::filter::ant::cTriggerFunctionBase.

◆ ProcessOutputs()

tResult adtf::filter::ant::cTriggerFunction::ProcessOutputs ( tTimeStamp )

overridevirtual

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 from adtf::filter::ant::cTriggerFunctionBase.

◆ SetDefaultProperties()

tResult adtf::filter::ant::cTriggerFunction::SetDefaultProperties ( base::ant::IConfiguration & oFilterConfig )

virtual

Reimplemented from adtf::filter::ant::cTriggerFunctionBase.

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ ConnectReadersAndWriters()

◆ ProcessOutputs()

◆ SetDefaultProperties()