---

GAUGE3D::GRawOStream Class Reference

A destination for data. More...

#include <gauge3d/files/ostream.h>

Inherits GAUGE3D::GObject.

List of all members.

Public Types
enum	tSeekType { BEGINNING, CURRENT, END }
	Position to seek relative to. More...
Public Methods
virtual	~GRawOStream ()
virtual void	Seek (int pos,int seekType)
	Seek the stream position. More...
virtual int	TellPos ()
	Get the distance in bytes between the beginning of the stream and the current position.
virtual int	Write (const void *buffer,int size)=0
	Attempts to write the contents of buffer and returns the amount actually written.

---

Detailed Description

A destination for data.

\ingoup files

GRawOStream is the actual destination of data written using a GOStream. GOStream itself provides buffering and other services for writing the data more easily. Often, however, it is desireable to write the raw data directory, especially when layering streams (you don't want double buffering).

GRawOStream is the class that should be inherited when creating new destinations for stream data. When inheriting from GRawOStream, you do not have to write implementations of all of the functions. If your stream does not support seeking, you do not have to write Seek() or TellPos().

---

Member Enumeration Documentation

enum GAUGE3D::GRawOStream::tSeekType

Position to seek relative to. Enumeration values: BEGINNING   Seek relative to the start of the stream. CURRENT   Seek relative to the current position. END   Seek relative to the end of the stream.

---

Member Function Documentation

void GAUGE3D::GRawOStream::Seek ( int pos, int seekType ) [virtual]

Seek the stream position. Parameters: pos   Position to seek to, in bytes. seekType   Point in the stream that pos is relative to.

---

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

• gauge3d/files/ostream.h

---