adtf::streaming::flash::ISampleReader Class Reference

#include <samplestreamer_intf.h>

Inherits adtf::streaming::flash::ISampleStreamer.

Inherited by adtf::streaming::flash::cSampleReader, and adtf::streaming::kiwi::cNullReader.

Public Member Functions
virtual tResult	GetNextSample (ucom::ant::iobject_ptr< const ant::ISample > &pSample)=0
virtual tResult	GetLastSample (ucom::ant::iobject_ptr< const ant::ISample > &pSample)=0
virtual tResult	GetLastType (ucom::ant::iobject_ptr< const IStreamType > &pType)=0
virtual tResult	SetStreamError (tResult oError)=0
virtual tResult	ReadAllAvailableItems ()=0
Public Member Functions inherited from adtf::streaming::flash::ISampleStreamer
virtual void	SetName (const char *strName)=0
virtual tResult	GetName (base::ant::IString &&strName)=0
virtual tResult	SetType (const ucom::ant::iobject_ptr< const ant::IStreamType > &pStreamType)=0
virtual tResult	GetType (ucom::ant::iobject_ptr< const ant::IStreamType > &pStreamType) const =0
virtual tResult	BeginStreaming (ant::ISampleStream &pStream)=0
virtual tResult	EndStreaming ()=0
virtual tResult	SetStreamerPin (const ucom::ant::iobject_ptr< flash::IStreamerPin > &pStreamerPin)=0

Detailed Description

Interface for sample reads that read from sample streams via input pins.

Member Function Documentation

GetLastSample()

virtual tResult adtf::streaming::flash::ISampleReader::GetLastSample ( ucom::ant::iobject_ptr< const ant::ISample > & pSample )

pure virtual

Reads the latest available sample from the associated sample stream.

If more than a single new sample was availablle, all but the last sample will be discarded.

If no new sample was available the last sample previously fetched will be returned again.

Parameters

[out]

pSample

This will refrerence the sample.

Return values

ERR_EMTPY

No sample available

Implemented in adtf::streaming::cNullReader, adtf::streaming::cSampleReader, adtf::streaming::flash::cSampleReader, and adtf::streaming::kiwi::cNullReader.

GetLastType()

virtual tResult adtf::streaming::flash::ISampleReader::GetLastType ( ucom::ant::iobject_ptr< const IStreamType > & pType )

pure virtual

Returns the last stream type that was read from the sample stream.

Parameters

[out]

pType

This will reference the last stream type

Returns

Implemented in adtf::streaming::cNullReader, adtf::streaming::cSampleReader, adtf::streaming::flash::cSampleReader, and adtf::streaming::kiwi::cNullReader.

GetNextSample()

virtual tResult adtf::streaming::flash::ISampleReader::GetNextSample ( ucom::ant::iobject_ptr< const ant::ISample > & pSample )

pure virtual

Reads the next available sample from the associated sample stream.

Parameters

[out]

pSample

This will refrerence the sample.

Return values

ERR_EMTPY

No sample available

Implemented in adtf::streaming::cNullReader, adtf::streaming::cSampleReader, adtf::streaming::flash::cSampleReader, and adtf::streaming::kiwi::cNullReader.

ReadAllAvailableItems()

virtual tResult adtf::streaming::flash::ISampleReader::ReadAllAvailableItems ( )

pure virtual

Reads all available items from the sample stream into internal queues.

Returns

Standard result.

Implemented in adtf::streaming::cNullReader, adtf::streaming::cSampleReader, adtf::streaming::flash::cSampleReader, and adtf::streaming::kiwi::cNullReader.

SetStreamError()

virtual tResult adtf::streaming::flash::ISampleReader::SetStreamError ( tResult oError )

pure virtual

Sets an error on the associated sample stream.

Parameters

[in]

oError

The error.

Returns

Standard result.

Implemented in adtf::streaming::cNullReader, adtf::streaming::cSampleReader, adtf::streaming::flash::cSampleReader, and adtf::streaming::kiwi::cNullReader.

---

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

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