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

Inheritance diagram for cLegacyStreamingSource:

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 (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< cLegacyStreamingSource >
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...

Additional Inherited Members
Public Types inherited from cLegacyStateHandler
enum	tInitStage { StageFirst = 0 , StageNormal = 1 , StageGraphReady = 2 }
	Old init stages.

Public Member Functions inherited from cSampleStreamingSource
tResult	RegisterBindingObject (const ucom::ant::iobject_ptr< IBindingObject > &pBindingObject) override

Public Member Functions inherited from object< ant::cSampleStreamingSource, 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...

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 read data from some kind of hardware device. Take a look at the cLegacyStreamingSink and cLegacyFilter classes as well. Take a look at the Demo Legacy UDP Receiver and Sender Plugin and Demo Legacy Virtual Clock Plugin for examples demonstrating the use.

Definition at line 23 of file legacy_streaming_source.h.

Member Function Documentation

◆ Construct()

virtual tResult Construct ( )

inlineprotectedvirtual

Used internally.

Returns: Standard result.

Definition at line 34 of file legacy_streaming_source.h.

References cLegacyStreamingSource::Init(), and RETURN_IF_FAILED.

◆ Destruct()

virtual tResult Destruct ( )

inlineprotectedvirtual

Used internally.

Returns: Standard result.

Definition at line 44 of file legacy_streaming_source.h.

References RETURN_IF_FAILED, and cLegacyStreamingSource::Shutdown().

◆ Init() [1/2]

virtual tResult Init ( )

inlineprotectedvirtual

Used internally.

Returns: Standard result.

Definition at line 54 of file legacy_streaming_source.h.

Referenced by cLegacyStreamingSource::Construct().

◆ Init() [2/2]

tResult Init ( tInitStage )

inlineoverrideprotectedvirtual

Emulates the old Init method.

Parameters

[in] eStage The initialization stage.

Returns: Standard result.

Reimplemented from cLegacyStateHandler.

Definition at line 93 of file legacy_streaming_source.h.

References RETURN_NOERROR.

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

References adtf_string_intf.

◆ RegisterPin()

tResult RegisterPin ( cLegacyOutputPin & oOutput )

inlineprotected

Compatibility method to register Pins.

Make sure cLegacyOutputPin::Create has been called before.

Parameters

[in] oOutput The pin to register.

Returns: Standard result.

Definition at line 129 of file legacy_streaming_source.h.

References adtf_string_intf, sample_streamer< INTERFACE, PINTYPE >::GetName(), sample_streamer< INTERFACE, PINTYPE >::ResetPin(), RETURN_IF_FAILED, and cLegacyOutputPin::SetManualTriggerRequired().

◆ Shutdown() [1/2]

virtual tResult Shutdown ( )

inlineprotectedvirtual

Used internally.

Returns: Standard result.

Definition at line 63 of file legacy_streaming_source.h.

Referenced by cLegacyStreamingSource::Destruct().

◆ Shutdown() [2/2]

tResult Shutdown ( tInitStage )

inlineoverrideprotectedvirtual

Emulates the old Shutdown method.

Parameters

[in] eStage The initialization stage.

Returns: Standard result.

Reimplemented from cLegacyStateHandler.

Definition at line 117 of file legacy_streaming_source.h.

References RETURN_NOERROR.

◆ Start()

tResult Start ( )

inlineoverrideprotectedvirtual

Emulates the old Start method.

Returns: Standard result.

Reimplemented from cLegacyStateHandler.

Definition at line 101 of file legacy_streaming_source.h.

References RETURN_NOERROR.

Referenced by cLegacyStreamingSource::StartStreaming().

◆ StartStreaming()

virtual tResult StartStreaming ( )

inlineprotectedvirtual

Used internally.

Returns: Standard result.

Definition at line 72 of file legacy_streaming_source.h.

References cLegacyStreamingSource::Start().

◆ Stop()

tResult Stop ( )

inlineoverrideprotectedvirtual

Emulates the old Stop method.

Returns: Standard result.

Reimplemented from cLegacyStateHandler.

Definition at line 109 of file legacy_streaming_source.h.

References RETURN_NOERROR.

Referenced by cLegacyStreamingSource::StopStreaming().

◆ StopStreaming()

virtual tResult StopStreaming ( )

inlineprotectedvirtual

Used internally.

Returns: Standard result.

Definition at line 81 of file legacy_streaming_source.h.

References cLegacyStreamingSource::Stop().

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Construct()

◆ Destruct()

◆ Init() [1/2]

◆ Init() [2/2]

◆ OIGetInstanceName()

◆ RegisterPin()

◆ Shutdown() [1/2]

◆ Shutdown() [2/2]

◆ Start()

◆ StartStreaming()

◆ Stop()

◆ StopStreaming()