ADTF  3.14.3
cLegacyFilter

Class that helps with porting old ADTF 2 Filters to ADTF 3. More...

Inheritance diagram for cLegacyFilter:
[legend]

Public Member Functions

tResult Process (tTimeStamp) override
 Used internally to emulate to old IPinEventSink interface. More...
 
tResult ConnectReadersAndWriters (adtf::filter::ant::cFilter &oFilter) override
 Used internally to construct the same trigger model as used in ADTF 2. More...
 
- Public Member Functions inherited from cTriggerFunction
 cTriggerFunction (const char *strName)
 
tResult SetDefaultProperties (base::ant::IConfiguration &oFilterConfig)
 
tResult ProcessOutputs (tTimeStamp) override
 This function is a structural hint to process the outputs after Process was called. More...
 
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 cTriggerFunctionBase
 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 Configure ()
 
virtual tResult SetFilter (cFilter &oFilter)
 
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
 
- 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 Member Functions

tResult RegisterPin (cLegacyInputPin &oInput)
 Compatibility method to register Pins. More...
 
tResult RegisterPin (cLegacyOutputPin &oOutput)
 Compatibility method to register Pins. More...
 
adtf_util::cString OIGetInstanceName ()
 Compatibility method to retrieve the name of the current filter instance. More...
 
- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 
- Protected Member Functions inherited from cKernelAndClockHelper
 cKernelAndClockHelper ()
 Constructor. More...
 
- Protected Member Functions inherited from cConfigurationHelper< cLegacyFilter >
void SetPropertyBool (const char *strName, bool bValue)
 Sets a Property value. More...
 
void SetPropertyInt (const char *strName, int nValue)
 Sets a Property value. More...
 
void SetPropertyFloat (const char *strName, double fValue)
 Sets a Property value. More...
 
void SetPropertyStr (const char *strName, const char *strValue)
 Sets a Property value. More...
 
bool GetPropertyBool (const char *strName, bool bDefault=false)
 Gets a Property value. More...
 
int GetPropertyInt (const char *strName, int nDefault=0)
 Gets a Property value. More...
 
double GetPropertyFloat (const char *strName, double fDefault=0.0)
 Gets a Property value. More...
 
adtf_util::cString GetPropertyStr (const tChar *strName, const tChar *strDefault="")
 Gets a Property value. More...
 
- Protected Member Functions inherited from cLegacyPinEvents
virtual tResult OnSampleReceived (cLegacyInputPin *, const adtf::ucom::iobject_ptr< const adtf::streaming::ISample > &)
 This is called whenever a sample is received via one of the input Pins. More...
 
virtual tResult OnTypeChanged (cLegacyInputPin *pPin, const adtf::ucom::iobject_ptr< const adtf::streaming::IStreamType > &pType)
 This is called whenever a type has been changed/received on one of the input Pins. More...
 
- Protected Member Functions inherited from cLegacyStateHandler
virtual tResult Init (tInitStage)
 Emulates the old Init method. More...
 
virtual tResult Start ()
 Emulates the old Start method. More...
 
virtual tResult Stop ()
 Emulates the old Stop method. More...
 
virtual tResult Shutdown (tInitStage)
 Emulates the old Shutdown method. More...
 

Additional Inherited Members

- Public Types inherited from cLegacyStateHandler
enum  tInitStage { StageFirst = 0 , StageNormal = 1 , StageGraphReady = 2 }
 Old init stages.
 
- Protected Attributes inherited from cTriggerFunction
std::vector< streaming::ant::cSampleReader * > m_vecOfReaders
 
std::vector< streaming::ant::cSampleWriter * > m_vecOfWriters
 
- Protected Attributes inherited from 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 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< cPropertiesm_pProperties = nullptr
 the current runtiem property set
 
- Protected Attributes inherited from cKernelAndClockHelper
adtf::ucom::object_ptr< adtf::services::IReferenceClock_clock
 pointer to the current reference clock
 
adtf::ucom::object_ptr< adtf::services::IKernel_kernel
 pointer to the kernel service
 

Detailed Description

Class that helps with porting old ADTF 2 Filters to ADTF 3.

Use this class for all Filters that process data based only on its Pin inputs and Pin outputs. For I/O Filters use the cLegacyStreamingSource or cLegacyStreamingSink classes instead. Take a look at the Demo Legacy Data Trigger Plugin for an example demonstrating the use.

Definition at line 341 of file legacy_filter.h.

Member Function Documentation

◆ ConnectReadersAndWriters()

tResult ConnectReadersAndWriters ( adtf::filter::ant::cFilter oFilter)
inlineoverridevirtual

Used internally to construct the same trigger model as used in ADTF 2.

Parameters
[in]oFilterused internally.
Returns
Standard result.

Reimplemented from cTriggerFunction.

Definition at line 381 of file legacy_filter.h.

References adtf_string_intf, and RETURN_IF_FAILED.

◆ OIGetInstanceName()

adtf_util::cString OIGetInstanceName ( )
inlineprotected

Compatibility method to retrieve the name of the current filter instance.

Returns
The name of the instance.

Definition at line 432 of file legacy_filter.h.

References adtf_string_intf.

◆ Process()

tResult Process ( tTimeStamp  )
inlineoverridevirtual

Used internally to emulate to old IPinEventSink interface.

Parameters
[in]tmTimeOfTriggerna
Returns
Standard result

Implements cTriggerFunctionBase.

Definition at line 354 of file legacy_filter.h.

References cLegacyPinEvents::OnSampleReceived(), and RETURN_IF_FAILED.

◆ RegisterPin() [1/2]

tResult RegisterPin ( cLegacyInputPin oInput)
inlineprotected

Compatibility method to register Pins.

Make sure cLegacyInputPin::Create has been called before.

Parameters
[in]oInputThe pin to register.
Returns
Standard result.

Definition at line 407 of file legacy_filter.h.

References cLegacyPinEvents::OnTypeChanged().

◆ RegisterPin() [2/2]

tResult RegisterPin ( cLegacyOutputPin oOutput)
inlineprotected

Compatibility method to register Pins.

Make sure cLegacyOutputPin::Create has been called before.

Parameters
[in]oOutputThe pin to register.
Returns
Standard result.

Definition at line 423 of file legacy_filter.h.


Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Thu Jun 9 2022 by doxygen 1.9.1)