ADTF  3.14.3
ISampleReaderabstract

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

Inheritance diagram for ISampleReader:
[legend]

Public Member Functions

virtual tResult GetNextSample (ucom::ant::iobject_ptr< const ant::ISample > &pSample)=0
 Reads the next available sample from the associated sample stream. More...
 
virtual tResult GetLastSample (ucom::ant::iobject_ptr< const ant::ISample > &pSample)=0
 Reads the last available sample from the associated sample stream. More...
 
virtual tResult GetLastType (ucom::ant::iobject_ptr< const IStreamType > &pType)=0
 Returns the last stream type that was read from the sample stream. More...
 
virtual tResult SetStreamError (tResult oError)=0
 Sets an error on the associated sample stream. More...
 
virtual tResult ReadAllAvailableItems ()=0
 Reads all available items from the sample stream into internal queues. More...
 
- Public Member Functions inherited from ISampleStreamer
virtual void SetName (const char *strName)=0
 Sets the name of the streamer. More...
 
virtual tResult GetName (base::ant::IString &&strName)=0
 Retrieves the name of the streamer. More...
 
virtual tResult SetType (const ucom::ant::iobject_ptr< const ant::IStreamType > &pStreamType)=0
 Sets the initial stream type of a streamer. More...
 
virtual tResult GetType (ucom::ant::iobject_ptr< const ant::IStreamType > &pStreamType) const =0
 Returns the initial stream type of the streamer. More...
 
virtual tResult BeginStreaming (ant::ISampleStream &pStream)=0
 Begin streaming on the given sample stream. More...
 
virtual tResult EndStreaming ()=0
 End streaming. More...
 
virtual tResult SetStreamerPin (const ucom::ant::iobject_ptr< flash::IStreamerPin > &pStreamerPin)=0
 Sets the pin that the streamer is associated with. More...
 

Detailed Description

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

Definition at line 187 of file samplestreamer_intf.h.

Member Function Documentation

◆ GetLastSample()

virtual tResult GetLastSample ( ucom::ant::iobject_ptr< const ant::ISample > &  pSample)
pure virtual

Reads the last available sample from the associated sample stream.

If no new sample was available the last one will be returned.

Parameters
[out]pSampleThis will refrerence the sample.
Return values
ERR_EMTPYNo sample available

Implemented in cNullReader, and cSampleReader.

◆ GetLastType()

virtual tResult GetLastType ( ucom::ant::iobject_ptr< const IStreamType > &  pType)
pure virtual

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

Parameters
[out]pTypeThis will reference the last stream type
Returns

Implemented in cNullReader, and cSampleReader.

◆ GetNextSample()

virtual tResult GetNextSample ( ucom::ant::iobject_ptr< const ant::ISample > &  pSample)
pure virtual

Reads the next available sample from the associated sample stream.

Parameters
[out]pSampleThis will refrerence the sample.
Return values
ERR_EMTPYNo sample available

Implemented in cNullReader, and cSampleReader.

◆ ReadAllAvailableItems()

virtual tResult ReadAllAvailableItems ( )
pure virtual

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

Returns
Standard result.

Implemented in cNullReader, and cSampleReader.

◆ SetStreamError()

virtual tResult SetStreamError ( tResult  oError)
pure virtual

Sets an error on the associated sample stream.

Parameters
[in]oErrorThe error.
Returns
Standard result.

Implemented in cNullReader, and cSampleReader.


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