Inherits adtf::base::ant::configuration< Interface >, and adtf::base::flash::IRunnable.

Public Member Functions
	cTriggerFunction (const char *strName)

void	SetName (const char *strName)

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

tResult	Register (streaming::flash::ISampleReader &oReader)

tResult	Register (streaming::flash::ISampleReader &oReader, const char strName, const char strDDLStruct)

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

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

tResult	Register (streaming::flash::ISampleWriter &oWriter)

tResult	Register (streaming::flash::ISampleWriter &oWriter, const char strName, const char strDDLStruct)

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

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

virtual tResult	SetFilter (cFilter &oFilter)

virtual tResult	ConnectReadersAndWriters (cFilter &oFilter)

virtual tResult	Configure ()

virtual tResult	ProcessInputs (tTimeStamp tmTime)

virtual tResult	Process (tTimeStamp tmTime)

virtual tResult	ProcessOutputs (tTimeStamp tmTime)

virtual tResult	ProcessInputs (base::flash::tNanoSeconds tmTime)

virtual tResult	Process (base::flash::tNanoSeconds tmTime)

virtual tResult	ProcessOutputs (base::flash::tNanoSeconds tmTime)

tResult	Run (base::flash::tNanoSeconds tmTimeofActivation, base::ant::IRunnable::tActivationType ui32ActivationType, const void *pvUserData, size_t nUserDataSize) override

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.

Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Public Member Functions inherited from adtf::base::flash::IRunnable
	ADTF_IID (IRunnable, "runnable.flash.base.adtf.iid")
	defintion of interface id

Additional Inherited Members
Public Types inherited from adtf::base::flash::IRunnable
typedef std::function< tResult(tNanoSeconds)>	tRunFunction
	Type definition of the function used to implement Run.

typedef ant::IRunnable::tActivationType	tActivationType

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

Protected Member Functions inherited from adtf::base::flash::IRunnable
	~IRunnable ()=default
	not destructable

Protected Attributes inherited from adtf::base::ant::configuration< Interface >
adtf::ucom::object_ptr< spider::cProperties >	m_pProperties = nullptr
	the current runtiem property set

Member Function Documentation

◆ Run()

tResult adtf::filter::flash::cTriggerFunction::Run	(	base::flash::tNanoSeconds	tmTimeofActivation,
		base::ant::IRunnable::tActivationType	ui32ActivationType,
		const void *	pvUserData,
		size_t	nUserDataSize )

overridevirtual

The Run method to set the component in running state. This method will be called to activate the component by a given activation type.

Parameters

[in]	tmTimeofActivation	Time of activation. Usually this is the StreamTime.
[in]	ui32ActivationType	The activation type for running.
[in]	pvUserData	pointer to a activation structure depending on the activation type.
[in]	nUserDataSize	Size of the activation structure. (in byte)

Returns: Standard result code.

Return values

ERR_CANCELED Depending on the caller (timer, cyclic thread) it will break cyclic running.

Implements adtf::base::flash::IRunnable.

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

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

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ Run()