adtf::streaming::ant::ISampleStreamer Class Reference

Local Sample Streamer Interface. This interface is only used to create a cInPin and cOutPin in a generic way. concrete implementations are cSampleReder and cSampleWriter. Use the sample_streamer template to implement own Writers and Readers. More...

#include <samplestreamer_intf.h>

Inherited by adtf::streaming::ant::ISampleReader, and adtf::streaming::ant::ISampleWriter.

Public Member Functions
virtual tResult	EndStreaming ()=0
virtual tResult	GetType (ucom::ant::iobject_ptr< const IStreamType > &pStreamType) const =0

Protected Member Functions
	~ISampleStreamer ()=default
	not destructable

Detailed Description

Local Sample Streamer Interface. This interface is only used to create a cInPin and cOutPin in a generic way. concrete implementations are cSampleReder and cSampleWriter. Use the sample_streamer template to implement own Writers and Readers.

Member Function Documentation

EndStreaming()

virtual tResult adtf::streaming::ant::ISampleStreamer::EndStreaming ( )

pure virtual

Sample Stream disconnected. Streaming ends.

Returns

Standard Result Code. Depends on implmentation.

Implemented in adtf::streaming::ant::cSampleReader, and adtf::streaming::ant::cSampleWriter.

GetType()

virtual tResult adtf::streaming::ant::ISampleStreamer::GetType ( ucom::ant::iobject_ptr< const IStreamType > & pStreamType ) const

pure virtual

Retrievs the Stream Type of the streamer. Usually this is used to open the ISampleStream and request or write a type immediatelly.

Returns

Standard Result Code. Depends on implmentation.

---

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

• src/libraries/streaming3/include/adtfstreaming3/samplestreamer_intf.h