adtf::streaming::ISampleOutStream Class Reference

brings latest ant::ISampleOutStream to the users scope More...

#include <sampleoutstream_intf.h>

Inherits adtf::ucom::ant::IObject.

Public Types
template<typename T>
using	iobject_ptr = adtf::ucom::ant::iobject_ptr < T >
	used type iobject_ptr

Public Member Functions
	ADTF_IID (ISampleOutStream, "sampleoutstream.ant.streaming.adtf.iid")
	Definition of interface id.
virtual ISampleStreamAccess::tMode	GetMode () const=0
virtual tResult	Flush ()=0
virtual tResult	Write (const iobject_ptr< const ISample > &pSample)=0
virtual tResult	Write (const iobject_ptr< const IStreamType > &pStreamType)=0
virtual tResult	SetStreamError (const tResult &oError)=0
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Member Functions
	~ISampleOutStream ()=default
	not destructable
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

brings latest ant::ISampleOutStream to the users scope

The ISampleOutStream interface is return by the ISampleStream::Open call which allows to write into a corresponding writers queue of the opened ISampleStream instance.

For common understanding: ONE ISampleOutStream == ONE writer queue. (but depends on the ISampleStream implementation). The default implementation provided (cSampleStream) will open one writers queue per ISampleOutStream.

See also

ISampleStream.

Member Function Documentation

Flush()

virtual tResult adtf::streaming::ant::ISampleOutStream::Flush ( )

pure virtual

Flushes the writers queue within the ISampleStream. This call is necessary to end all transmit call made by Write ! Only after this call the written ISample and const IStreamType will forwarded to the ISampleStreamReader.

See also

ISampleStream for some more information.

Warning

If no Flush is called the queue will grow until a Flush call is obtained or (depending on the ISampleStream implementation and mode) the queue will drop content!

Returns

Standard Result Code.

GetMode()

virtual ISampleStreamAccess::tMode adtf::streaming::ant::ISampleOutStream::GetMode ( ) const

pure virtual

Returns the writing mode of ISampleStream.

Returns

see ISampleStreamAccess::tMode.

SetStreamError()

virtual tResult adtf::streaming::ant::ISampleOutStream::SetStreamError ( const tResult & oError )

pure virtual

Forward an error to the corresponding stream.

Parameters

oError

[in] The error passed to the queue and the SampleStream

Returns

Standard Result Code.

Write() [1/2]

virtual tResult adtf::streaming::ant::ISampleOutStream::Write ( const iobject_ptr< const ISample > & pSample )

pure virtual

Write a sample refernce to a writers queue of the ISampleStream.

Parameters

[in]

pSample

the sample to write.

Remarks

A reference is written to the stream, no content or copy of it!

Returns

Standard Result Code

Return values

ERR_DEVICE_IN_USE

The Sample were not written to queue

Write() [2/2]

virtual tResult adtf::streaming::ant::ISampleOutStream::Write ( const iobject_ptr< const IStreamType > & pStreamType )

pure virtual

Write an stream type reference to the write queue of the ISampleStream

Parameters

[in]

pStreamType

the type to write.

Remarks

A reference is written to the stream, no content or copy of it!

Returns

Standard Result Code

Return values

ERR_DEVICE_IN_USE

The type is not written to queue

---

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

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