adtf::ucom::ant::IStream Class Reference

#include <stream_intf.h>

Inherits adtf::ucom::ant::IInputStream, and adtf::ucom::ant::IOutputStream.

Public Types
enum	tSeekOrigin : uint8_t { SO_Begin = 0 , SO_Current = 1 , SO_End = 2 }
	Stream seek origin. More...
enum	tStreamFlags { SF_NONE = 0x00 }
	Stream flags. More...

Public Member Functions
	ADTF_IID (IStream, "stream.ant.ucom.adtf.iid")
virtual tResult	Seek (tFilePos nPos, tSeekOrigin eOrigin, tFilePos *pNewPos=nullptr) const =0
virtual tResult	Reset ()=0
virtual tResult	Flush ()=0
Public Member Functions inherited from adtf::ucom::ant::IInputStream
	ADTF_IID (IInputStream, "input_stream.ant.ucom.adtf.iid")
virtual tResult	Read (void *pvBuffer, size_t nBufferSize, size_t *pnBytesRead=nullptr) const =0
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
Public Member Functions inherited from adtf::ucom::ant::IOutputStream
	ADTF_IID (IOutputStream, "output_stream.ant.ucom.adtf.iid")
virtual tResult	Write (const void *pvBuffer, size_t nBufferSize, size_t *pnBytesWritten=nullptr)=0

Static Public Attributes
static const uint8_t	m_ui8PlatformByteOrder

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

Detailed Description

The IStream interface provides defines methods for streaming data.

Member Enumeration Documentation

tSeekOrigin

enum adtf::ucom::ant::IStream::tSeekOrigin : uint8_t

Stream seek origin.

Enumerator
SO_Begin	The position origin is the beginning of the stream.
SO_Current	The position is relative to the current stream position.
SO_End	The position is relative to end of the stream.

tStreamFlags

enum adtf::ucom::ant::IStream::tStreamFlags

Stream flags.

Enumerator
SF_NONE	no flags set.

Member Function Documentation

ADTF_IID()

adtf::ucom::ant::IStream::ADTF_IID	(	IStream	,
		"stream.ant.ucom.adtf.iid"	)

Marks the IStream to be castable with the ucom_cast<>

See also

ADTF_IID(_interface, _striid)

Flush()

virtual tResult adtf::ucom::ant::IStream::Flush ( )

pure virtual

Flush stream data. The Flush method flushes all current stream data.

Returns

Returns a standard result code.

Reset()

virtual tResult adtf::ucom::ant::IStream::Reset ( )

pure virtual

Reset stream. The Reset method resets the stream.

Returns

Returns a standard result code.

Seek()

virtual tResult adtf::ucom::ant::IStream::Seek ( tFilePos nPos, tSeekOrigin eOrigin, tFilePos * pNewPos = nullptr ) const

pure virtual

Set stream position. The Seek method sets the current stream position.

Parameters

nPos	[in] Position the stream should be set to.
eOrigin	[in] Origin reference of the position value.
pNewPos	[in,out] Pointer to a variable that receives the new stream position value.

Returns

Returns a standard result code.

---

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

• src/libraries/ucom3/include/adtfucom3/interfaces/stream_intf.h