ADTF  3.14.3
ISampleStreamerabstract

Base interface for sample readers and writers. More...

Inheritance diagram for ISampleStreamer:
[legend]

Public Member Functions

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

Base interface for sample readers and writers.

Definition at line 129 of file samplestreamer_intf.h.

Member Function Documentation

◆ BeginStreaming()

virtual tResult BeginStreaming ( ant::ISampleStream pStream)
pure virtual

Begin streaming on the given sample stream.

Parameters
[in]pStreamthe sample stream.
Returns
Standard result.

Implemented in writer_with_request_broker< BaseWriter >, writer_with_request_broker< adtf::streaming::cSampleWriter >, cSampleWriter, cSampleReader, and cNullReader.

◆ EndStreaming()

virtual tResult EndStreaming ( )
pure virtual

◆ GetName()

virtual tResult GetName ( base::ant::IString &&  strName)
pure virtual

Retrieves the name of the streamer.

Parameters
[out]strNameThis will be updated with the name.
Returns
Standard result.

Implemented in cSampleWriter, cNullReader, and cSampleReader.

◆ GetType()

virtual tResult GetType ( ucom::ant::iobject_ptr< const ant::IStreamType > &  pStreamType) const
pure virtual

Returns the initial stream type of the streamer.

Parameters
[out]pStreamTypeThis will reference the initial stream type.
Returns
Standard result.

Implemented in cSampleWriter, cNullReader, and cSampleReader.

◆ SetName()

virtual void SetName ( const char *  strName)
pure virtual

Sets the name of the streamer.

This will be used when creating pins.

Parameters
[in]strNameThe name

Implemented in cSampleWriter, cNullReader, and cSampleReader.

◆ SetStreamerPin()

virtual tResult SetStreamerPin ( const ucom::ant::iobject_ptr< flash::IStreamerPin > &  pStreamerPin)
pure virtual

Sets the pin that the streamer is associated with.

Parameters
[in]pStreamerPinThe pin.
Returns
Standard result.

Implemented in cSampleWriter, cSampleReader, and cNullReader.

◆ SetType()

virtual tResult SetType ( const ucom::ant::iobject_ptr< const ant::IStreamType > &  pStreamType)
pure virtual

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