dtUtil::DataStream Class Reference

#include <datastream.h>

List of all members.

Public Member Functions
	DataStream ()
	DataStream (char *buffer, unsigned int bufferSize, bool autoFree=true)
	Constructs the datastream using an existing byte buffer.
	DataStream (const DataStream &rhs)
DataStream &	operator= (const DataStream &rhs)
virtual	~DataStream ()
DataStream &	operator>> (bool &value)
DataStream &	operator<< (bool value)
DataStream &	operator>> (unsigned char &value)
DataStream &	operator<< (unsigned char value)
DataStream &	operator>> (char &value)
DataStream &	operator<< (char value)
DataStream &	operator>> (short &value)
DataStream &	operator<< (short value)
DataStream &	operator>> (unsigned short &value)
DataStream &	operator<< (unsigned short value)
DataStream &	operator>> (int &value)
DataStream &	operator<< (int value)
DataStream &	operator>> (unsigned &value)
DataStream &	operator<< (unsigned value)
DataStream &	operator>> (long &value)
DataStream &	operator<< (long value)
DataStream &	operator>> (unsigned long &value)
DataStream &	operator<< (unsigned long value)
DataStream &	operator>> (float &value)
DataStream &	operator<< (float value)
DataStream &	operator>> (double &value)
DataStream &	operator<< (double value)
DataStream &	operator>> (std::string &value)
DataStream &	operator<< (const std::string &value)
DataStream &	operator>> (osg::Vec2f &value)
DataStream &	operator<< (const osg::Vec2f &value)
DataStream &	operator>> (osg::Vec2d &value)
DataStream &	operator<< (const osg::Vec2d &value)
DataStream &	operator>> (osg::Vec3f &value)
DataStream &	operator<< (const osg::Vec3f &value)
DataStream &	operator>> (osg::Vec3d &value)
DataStream &	operator<< (const osg::Vec3d &value)
DataStream &	operator>> (osg::Vec4f &value)
DataStream &	operator<< (const osg::Vec4f &value)
DataStream &	operator>> (osg::Vec4d &value)
DataStream &	operator<< (const osg::Vec4d &value)
void	Read (bool &c)
void	Write (bool c)
void	Read (unsigned char &c)
void	Write (unsigned char c)
void	Read (char &c)
void	Write (char c)
void	Read (short &s)
void	Write (short s)
void	Read (unsigned short &s)
void	Write (unsigned short s)
void	Read (int &i)
void	Write (int i)
void	Read (unsigned &i)
void	Write (unsigned i)
void	Read (long &i)
void	Write (long i)
void	Read (unsigned long &i)
void	Write (unsigned long i)
void	Read (float &f)
void	Write (float f)
void	Read (double &d)
void	Write (double d)
void	Read (std::string &string)
void	Write (const std::string &string)
void	Read (osg::Vec2f &vector)
void	Write (const osg::Vec2f &vector)
void	Read (osg::Vec2d &vector)
void	Write (const osg::Vec2d &vector)
void	Read (osg::Vec3f &vector)
void	Write (const osg::Vec3f &vector)
void	Read (osg::Vec3d &vector)
void	Write (const osg::Vec3d &vector)
void	Read (osg::Vec4f &vector)
void	Write (const osg::Vec4f &vector)
void	Read (osg::Vec4d &vector)
void	Write (const osg::Vec4d &vector)
unsigned int	ReadBinary (char *pBuffer, const unsigned int isize)
unsigned int	WriteBinary (const char *pBuffer, const unsigned int isize)
void	WriteBytes (unsigned char c, size_t count)
unsigned int	GetBufferCapacity () const
unsigned int	GetBufferSize () const
void	Rewind ()
void	Seekp (unsigned int offset, const SeekTypeEnum &type)
void	Seekg (unsigned int offset, const SeekTypeEnum &type)
const char *	GetBuffer () const
bool	IsLittleEndian () const
	Gets the endian'ness of the current platform.
void	SetForceLittleEndian (bool force)
	Forces the stream to interpret its data contents as little endian.
unsigned int	SetBufferSize (unsigned int size)
unsigned int	IncreaseBufferSize (const unsigned int size=0)
unsigned int	GetRemainingReadSize ()
unsigned int	ClearBuffer ()
unsigned int	AppendDataStream (const DataStream &dataStream)
Classes
class	SeekTypeEnum

---

Constructor & Destructor Documentation

dtUtil::DataStream::DataStream

(

)

dtUtil::DataStream::DataStream	(	char *	buffer,
		unsigned int	bufferSize,
		bool	autoFree = true
	)

Constructs the datastream using an existing byte buffer.

Parameters:

	buffer	The existing valid buffer.
	bufferSize	The size in bytes of the buffer.
	reverseByteSwapping	If this flag is true, the buffer will treat its contents as little endian by default instead of big endian. This is useful if working with file data where the file is always in little endian format.
	autoFree	If true, the buffer's memory is freed when the DataStream instance gets destructed. If false, the caller is responsible for freeing the associated buffer memory.

dtUtil::DataStream::DataStream

(

const DataStream &

rhs

)

dtUtil::DataStream::~DataStream

(

)

[virtual]

---

Member Function Documentation

DataStream & dtUtil::DataStream::operator=

(

const DataStream &

rhs

)

DataStream& dtUtil::DataStream::operator>>

(

bool &

value

)

[inline]

DataStream& dtUtil::DataStream::operator<<

(

bool

value

)

[inline]

DataStream& dtUtil::DataStream::operator>>

(

unsigned char &

value

)

[inline]

DataStream& dtUtil::DataStream::operator<<

(

unsigned char

value

)

[inline]

DataStream& dtUtil::DataStream::operator>>

(

char &

value

)

[inline]

DataStream& dtUtil::DataStream::operator<<

(

char

value

)

[inline]

DataStream& dtUtil::DataStream::operator>>

(

short &

value

)

[inline]

DataStream& dtUtil::DataStream::operator<<

(

short

value

)

[inline]

DataStream& dtUtil::DataStream::operator>>

(

unsigned short &

value

)

[inline]

DataStream& dtUtil::DataStream::operator<<

(

unsigned short

value

)

[inline]

DataStream& dtUtil::DataStream::operator>>

(

int &

value

)

[inline]

DataStream& dtUtil::DataStream::operator<<

(

int

value

)

[inline]

DataStream& dtUtil::DataStream::operator>>

(

unsigned &

value

)

[inline]

DataStream& dtUtil::DataStream::operator<<

(

unsigned

value

)

[inline]

DataStream& dtUtil::DataStream::operator>>

(

long &

value

)

[inline]

DataStream& dtUtil::DataStream::operator<<

(

long

value

)

[inline]

DataStream& dtUtil::DataStream::operator>>

(

unsigned long &

value

)

[inline]

DataStream& dtUtil::DataStream::operator<<

(

unsigned long

value

)

[inline]

DataStream& dtUtil::DataStream::operator>>

(

float &

value

)

[inline]

DataStream& dtUtil::DataStream::operator<<

(

float

value

)

[inline]

DataStream& dtUtil::DataStream::operator>>

(

double &

value

)

[inline]

DataStream& dtUtil::DataStream::operator<<

(

double

value

)

[inline]

DataStream& dtUtil::DataStream::operator>>

(

std::string &

value

)

[inline]

DataStream& dtUtil::DataStream::operator<<

(

const std::string &

value

)

[inline]

DataStream& dtUtil::DataStream::operator>>

(

osg::Vec2f &

value

)

[inline]

DataStream& dtUtil::DataStream::operator<<

(

const osg::Vec2f &

value

)

[inline]

DataStream& dtUtil::DataStream::operator>>

(

osg::Vec2d &

value

)

[inline]

DataStream& dtUtil::DataStream::operator<<

(

const osg::Vec2d &

value

)

[inline]

DataStream& dtUtil::DataStream::operator>>

(

osg::Vec3f &

value

)

[inline]

DataStream& dtUtil::DataStream::operator<<

(

const osg::Vec3f &

value

)

[inline]

DataStream& dtUtil::DataStream::operator>>

(

osg::Vec3d &

value

)

[inline]

DataStream& dtUtil::DataStream::operator<<

(

const osg::Vec3d &

value

)

[inline]

DataStream& dtUtil::DataStream::operator>>

(

osg::Vec4f &

value

)

[inline]

DataStream& dtUtil::DataStream::operator<<

(

const osg::Vec4f &

value

)

[inline]

DataStream& dtUtil::DataStream::operator>>

(

osg::Vec4d &

value

)

[inline]

DataStream& dtUtil::DataStream::operator<<

(

const osg::Vec4d &

value

)

[inline]

void dtUtil::DataStream::Read

(

bool &

c

)

void dtUtil::DataStream::Write

(

bool

c

)

void dtUtil::DataStream::Read

(

unsigned char &

c

)

void dtUtil::DataStream::Write

(

unsigned char

c

)

void dtUtil::DataStream::Read

(

char &

c

)

void dtUtil::DataStream::Write

(

char

c

)

void dtUtil::DataStream::Read

(

short &

s

)

void dtUtil::DataStream::Write

(

short

s

)

void dtUtil::DataStream::Read

(

unsigned short &

s

)

void dtUtil::DataStream::Write

(

unsigned short

s

)

void dtUtil::DataStream::Read

(

int &

i

)

void dtUtil::DataStream::Write

(

int

i

)

void dtUtil::DataStream::Read

(

unsigned &

i

)

void dtUtil::DataStream::Write

(

unsigned

i

)

void dtUtil::DataStream::Read

(

long &

i

)

void dtUtil::DataStream::Write

(

long

i

)

void dtUtil::DataStream::Read

(

unsigned long &

i

)

void dtUtil::DataStream::Write

(

unsigned long

i

)

void dtUtil::DataStream::Read

(

float &

f

)

void dtUtil::DataStream::Write

(

float

f

)

void dtUtil::DataStream::Read

(

double &

d

)

void dtUtil::DataStream::Write

(

double

d

)

void dtUtil::DataStream::Read

(

std::string &

string

)

void dtUtil::DataStream::Write

(

const std::string &

string

)

void dtUtil::DataStream::Read

(

osg::Vec2f &

vector

)

void dtUtil::DataStream::Write

(

const osg::Vec2f &

vector

)

void dtUtil::DataStream::Read

(

osg::Vec2d &

vector

)

void dtUtil::DataStream::Write

(

const osg::Vec2d &

vector

)

void dtUtil::DataStream::Read

(

osg::Vec3f &

vector

)

void dtUtil::DataStream::Write

(

const osg::Vec3f &

vector

)

void dtUtil::DataStream::Read

(

osg::Vec3d &

vector

)

void dtUtil::DataStream::Write

(

const osg::Vec3d &

vector

)

void dtUtil::DataStream::Read

(

osg::Vec4f &

vector

)

void dtUtil::DataStream::Write

(

const osg::Vec4f &

vector

)

void dtUtil::DataStream::Read

(

osg::Vec4d &

vector

)

void dtUtil::DataStream::Write

(

const osg::Vec4d &

vector

)

unsigned int dtUtil::DataStream::ReadBinary	(	char *	pBuffer,
		const unsigned int	isize
	)

unsigned int dtUtil::DataStream::WriteBinary	(	const char *	pBuffer,
		const unsigned int	isize
	)

void dtUtil::DataStream::WriteBytes	(	unsigned char	c,
		size_t	count
	)

unsigned int dtUtil::DataStream::GetBufferCapacity

(

)

const [inline]

unsigned int dtUtil::DataStream::GetBufferSize

(

)

const [inline]

void dtUtil::DataStream::Rewind

(

)

[inline]

void dtUtil::DataStream::Seekp	(	unsigned int	offset,
		const SeekTypeEnum &	type
	)

void dtUtil::DataStream::Seekg	(	unsigned int	offset,
		const SeekTypeEnum &	type
	)

const char* dtUtil::DataStream::GetBuffer

(

)

const [inline]

bool dtUtil::DataStream::IsLittleEndian

(

)

const [inline]

Gets the endian'ness of the current platform.

Returns:

True if little endian, false if big endian.

void dtUtil::DataStream::SetForceLittleEndian

(

bool

force

)

[inline]

Forces the stream to interpret its data contents as little endian.

Parameters:

force

True if the stream should interpret its contents as little endian.

Note:

This is useful when working with binary files that are gaurenteed to be little endian. The particular file loading code can therefore, read the file contents into the data stream and on big endian machines, byte swapping will occur automatically.

unsigned int dtUtil::DataStream::SetBufferSize

(

unsigned int

size

)

[inline]

unsigned int dtUtil::DataStream::IncreaseBufferSize

(

const unsigned int

size = 0

)

unsigned int dtUtil::DataStream::GetRemainingReadSize

(

)

unsigned int dtUtil::DataStream::ClearBuffer

(

)

unsigned int dtUtil::DataStream::AppendDataStream

(

const DataStream &

dataStream

)

---