System::Archive Class Reference

A byte order neutral archive of data.

#include <Archive.hpp>

Inheritance diagram for System::Archive:

List of all members.

Public Types
enum	E_ByteOrder { BO_LITTLE_ENDIAN, BO_BIG_ENDIAN }
	The order of storage of bytes representing a value. More...
Public Member Functions
virtual VOID	Serialize (CONST BYTE *Data, DWORD Length)
virtual VOID	Seek (DWORD Position)
virtual DWORD	Tell ()
virtual DWORD	Size ()
virtual VOID	Flush ()
virtual BOOL	Error ()
virtual BOOL	End ()
virtual BOOL	Close ()
VOID	SerializeOrdered (CONST BYTE *Data, DWORD Length)
VOID	SerializeOrdered (CONST BYTE *Data, DWORD Length, E_ByteOrder Order)
Archive &	operator<< (BYTE &Value)
Archive &	operator<< (WORD &Value)
Archive &	operator<< (DWORD &Value)
Archive &	operator<< (QWORD &Value)
Archive &	operator<< (FLOAT &Value)
Public Attributes
E_ByteOrder	ByteOrder

---

Member Enumeration Documentation

enum System::Archive::E_ByteOrder

Enumerator:

BO_LITTLE_ENDIAN	Little endian byte ordering.
BO_BIG_ENDIAN	Big endian byte ordering.

---

Member Function Documentation

virtual VOID System::Archive::Serialize	(	CONST BYTE *	Data,
		DWORD	Length
	)			[inline, virtual]

Serialize a set of data.

Reimplemented in System::ArchiveVoid, System::Buffer, and System::StaticBuffer.

virtual VOID System::Archive::Seek

(

DWORD

Position

)

[inline, virtual]

Seek to the specified position.

Reimplemented in System::StaticBuffer.

virtual DWORD System::Archive::Tell

(

)

[inline, virtual]

Return the current position.

virtual DWORD System::Archive::Size

(

)

[inline, virtual]

Return the size of the archive.

virtual VOID System::Archive::Flush

(

)

[inline, virtual]

Flush serialized data.

virtual BOOL System::Archive::Error

(

)

[inline, virtual]

Returns whether or not the archive is in an erroneous state.

virtual BOOL System::Archive::End

(

)

[inline, virtual]

Returns whether or not the end of the archive has been reached.

virtual BOOL System::Archive::Close

(

)

[inline, virtual]

Closes the archive.

VOID System::Archive::SerializeOrdered	(	CONST BYTE *	Data,
		DWORD	Length
	)			[inline]

Serialize a set of data in an order neutral way.

VOID System::Archive::SerializeOrdered	(	CONST BYTE *	Data,
		DWORD	Length,
		E_ByteOrder	Order
	)			[inline]

Serialize a set of data with a certain order, in an order neutral way.

Archive& System::Archive::operator<<

(

BYTE &

Value

)

[inline]

Archive a byte of data.

Archive& System::Archive::operator<<

(

WORD &

Value

)

[inline]

Archive a word of data.

Archive& System::Archive::operator<<

(

DWORD &

Value

)

[inline]

Archive a double word of data.

Archive& System::Archive::operator<<

(

QWORD &

Value

)

[inline]

Archive a quadruple word of data.

Archive& System::Archive::operator<<

(

FLOAT &

Value

)

[inline]

Archive a floating point number.

---

Member Data Documentation

E_ByteOrder System::Archive::ByteOrder

The byte order of the archive.

---

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

• Archive.hpp

---