ADTF  3.14.3
cLegacyStreamingSink

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

Inheritance diagram for cLegacyStreamingSink:
[legend]

Classes

class  cTriggerPipeItemHelper
 

Public Member Functions

 cLegacyStreamingSink ()
 Constructor.
 
- Public Member Functions inherited from cSampleStreamingSink
tResult RegisterBindingObject (const ucom::ant::iobject_ptr< IBindingObject > &pBindingObject) override
 
- Public Member Functions inherited from object< ant::cSampleStreamingSink, interface_binding<> >
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 runnable< TYPE_OF_ACTIVATION, AntInterface, Interface >
 runnable ()=default
 CTOR.
 
 runnable (adtf::base::flash::IRunnable::tRunFunction fcRunOnceFunc)
 Main CTOR with callable function. More...
 
 runnable (ant::IRunnable::tRunFunction fcRunOnceFunc)
 Compatibility CTOR with callable function. More...
 
 ~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 *, size_t) override
 IRunnable::Run implementation which will call m_fcRunOnceFunc if ui32ActivationType is TYPE_OF_ACTIVATION. More...
 
ant::IRunnable::tActivationType GetActivationType () const override
 Returns the type of activation implemented. More...
 
- Public Member Functions inherited from object< ant::IRunnable, ant::IRunnable, 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...
 

Protected Member Functions

virtual tResult Construct ()
 Used internally. More...
 
virtual tResult Destruct ()
 Used internally. More...
 
virtual tResult Init ()
 Used internally. More...
 
virtual tResult Shutdown ()
 Used internally. More...
 
virtual tResult StartStreaming ()
 Used internally. More...
 
virtual tResult StopStreaming ()
 Used internally. More...
 
tResult Init (tInitStage) override
 Emulates the old Init method. More...
 
tResult Start () override
 Emulates the old Start method. More...
 
tResult Stop () override
 Emulates the old Stop method. More...
 
tResult Shutdown (tInitStage) override
 Emulates the old Shutdown method. More...
 
tResult RegisterPin (cLegacyInputPin &oInput)
 Compatibility method to register Pins. More...
 
tResult Trigger (tTimeStamp)
 Used internally to recreate the trogger scheme from ADTF2. 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< cLegacyStreamingSink >
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...
 

Private Attributes

adtf::ucom::object_ptr< adtf::streaming::ITriggerPipeItemm_pRunner
 
std::vector< cLegacyInputPin * > m_oLegacyPins
 

Additional Inherited Members

- Public Types inherited from cLegacyStateHandler
enum  tInitStage { StageFirst = 0 , StageNormal = 1 , StageGraphReady = 2 }
 Old init stages.
 
- 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
 
- Protected Attributes inherited from runnable< TYPE_OF_ACTIVATION, AntInterface, Interface >
adtf::base::flash::IRunnable::tRunFunction m_fcRunOnceFunc = nullptr
 given function to call on Run
 

Detailed Description

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

Use this class for all Filters that write data to some kind of hardware device. Take a look at the cLegacyStreamingSource and cLegacyFilter classes as well. Take a look at the Demo Legacy UDP Receiver and Sender Plugin for an example demonstrating the use.

Definition at line 26 of file legacy_streaming_sink.h.

Member Function Documentation

◆ Construct()

virtual tResult Construct ( )
inlineprotectedvirtual

Used internally.

Returns
Standard result.

Definition at line 49 of file legacy_streaming_sink.h.

References cLegacyStreamingSink::Init(), and RETURN_IF_FAILED.

◆ Destruct()

virtual tResult Destruct ( )
inlineprotectedvirtual

Used internally.

Returns
Standard result.

Definition at line 59 of file legacy_streaming_sink.h.

References RETURN_IF_FAILED, and cLegacyStreamingSink::Shutdown().

◆ Init() [1/2]

virtual tResult Init ( )
inlineprotectedvirtual

Used internally.

Returns
Standard result.

Definition at line 69 of file legacy_streaming_sink.h.

Referenced by cLegacyStreamingSink::Construct().

◆ Init() [2/2]

tResult Init ( tInitStage  )
inlineoverrideprotectedvirtual

Emulates the old Init method.

Parameters
[in]eStageThe initialization stage.
Returns
Standard result.

Reimplemented from cLegacyStateHandler.

Definition at line 108 of file legacy_streaming_sink.h.

◆ RegisterPin()

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 144 of file legacy_streaming_sink.h.

References adtf_string_intf, ITriggerPipeSource::Normal, cLegacyPinEvents::OnTypeChanged(), and RETURN_IF_FAILED.

◆ Shutdown() [1/2]

virtual tResult Shutdown ( )
inlineprotectedvirtual

Used internally.

Returns
Standard result.

Definition at line 78 of file legacy_streaming_sink.h.

Referenced by cLegacyStreamingSink::Destruct().

◆ Shutdown() [2/2]

tResult Shutdown ( tInitStage  )
inlineoverrideprotectedvirtual

Emulates the old Shutdown method.

Parameters
[in]eStageThe initialization stage.
Returns
Standard result.

Reimplemented from cLegacyStateHandler.

Definition at line 132 of file legacy_streaming_sink.h.

◆ Start()

tResult Start ( )
inlineoverrideprotectedvirtual

Emulates the old Start method.

Returns
Standard result.

Reimplemented from cLegacyStateHandler.

Definition at line 116 of file legacy_streaming_sink.h.

Referenced by cLegacyStreamingSink::StartStreaming().

◆ StartStreaming()

virtual tResult StartStreaming ( )
inlineprotectedvirtual

Used internally.

Returns
Standard result.

Definition at line 87 of file legacy_streaming_sink.h.

References cLegacyStreamingSink::Start().

◆ Stop()

tResult Stop ( )
inlineoverrideprotectedvirtual

Emulates the old Stop method.

Returns
Standard result.

Reimplemented from cLegacyStateHandler.

Definition at line 124 of file legacy_streaming_sink.h.

Referenced by cLegacyStreamingSink::StopStreaming().

◆ StopStreaming()

virtual tResult StopStreaming ( )
inlineprotectedvirtual

Used internally.

Returns
Standard result.

Definition at line 96 of file legacy_streaming_sink.h.

References cLegacyStreamingSink::Stop().

◆ Trigger()

tResult Trigger ( tTimeStamp  )
inlineprotected

Used internally to recreate the trogger scheme from ADTF2.

Parameters
tmTimeOfActivationna.
Returns
Standard result.

Definition at line 168 of file legacy_streaming_sink.h.

References cLegacyPinEvents::OnSampleReceived(), and RETURN_IF_FAILED.


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