MCore::Stream Class Reference

#include <Stream.h>

Inherited by MCore::File.

Public Member Functions
	Stream ()
virtual	~Stream ()
virtual uint32	GetType () const =0
virtual size_t	Read (void *data, size_t length)
virtual size_t	Write (const void *data, size_t length)
virtual Stream &	operator<< (bool b)
virtual Stream &	operator<< (char ch)
virtual Stream &	operator<< (uint8 ch)
virtual Stream &	operator<< (int16 number)
virtual Stream &	operator<< (uint16 number)
virtual Stream &	operator<< (int32 number)
virtual Stream &	operator<< (uint32 number)
virtual Stream &	operator<< (uint64 number)
virtual Stream &	operator<< (int64 number)
virtual Stream &	operator<< (float number)
virtual Stream &	operator<< (double number)
virtual Stream &	operator<< (AZStd::string &text)
virtual Stream &	operator<< (const char *text)
virtual Stream &	operator>> (bool &b)
virtual Stream &	operator>> (char &ch)
virtual Stream &	operator>> (uint8 &ch)
virtual Stream &	operator>> (int16 &number)
virtual Stream &	operator>> (uint16 &number)
virtual Stream &	operator>> (int32 &number)
virtual Stream &	operator>> (uint32 &number)
virtual Stream &	operator>> (int64 &number)
virtual Stream &	operator>> (uint64 &number)
virtual Stream &	operator>> (float &number)
virtual Stream &	operator>> (double &number)
virtual Stream &	operator>> (AZStd::string &text)

Detailed Description

The stream abstract base class. A stream is a source from which can be read and to which can be written. This could be a file, a TCP/IP stream, or anything else you can imagine.

Constructor & Destructor Documentation

Stream()

MCore::Stream::Stream ( )

inline

The constructor.

~Stream()

virtual MCore::Stream::~Stream ( )

inlinevirtual

The destructor.

Member Function Documentation

GetType()

virtual uint32 MCore::Stream::GetType ( ) const

pure virtual

Get the unique type ID.

Returns

The type identification number.

Implemented in MCore::MemoryFile, and MCore::DiskFile.

Read()

virtual size_t MCore::Stream::Read ( void *  data, size_t  length  )

inlinevirtual

Read a given amount of data from the stream.

Parameters

data	The pointer where to store the read data.
length	The size in bytes of the data to read.

Returns

Returns the number of bytes read.

Reimplemented in MCore::File, MCore::MemoryFile, and MCore::DiskFile.

Write()

virtual size_t MCore::Stream::Write ( const void *  data, size_t  length  )

inlinevirtual

Writes a given amount of data to the stream.

Parameters

data	The pointer to the data to write.
length	The size in bytes of the data to write.

Returns

Returns the number of written bytes.

Reimplemented in MCore::File, MCore::MemoryFile, and MCore::DiskFile.

---

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

• Gems/EMotionFX/Code/MCore/Source/Stream.h