owl::pstream Class Reference

Base class for handling streamable objects. More...

#include <owl/objstrm.h>

Inheritance diagram for owl::pstream:

Public Types
enum	PointerTypes { ptNull , ptIndexed , ptObject }
	Enumerates object pointer types. More...

Public Member Functions
	pstream (std::streambuf *)
	Creates a buffered pstream with the given buffer. The state is set to 0.
virtual	~pstream ()
int	rdstate () const
	Returns the current state value.
int	eof () const
	Returns nonzero on end of stream.
int	fail () const
	Returns nonzero if a previous stream operation failed.
int	bad () const
	Returns nonzero if an error occurs.
int	good () const
	Returns nonzero if no error states have been recorded for the stream (that is, no errors have occurred).
void	clear (int=0)
	Sets the stream state to the given value (defaults to 0).
	operator void * () const
	Converts to a void pointer.
int	operator! () const
	Overloads the NOT operator.
std::streambuf *	rdbuf () const
	Returns the pb pointer to the buffer assigned to the stream.

Protected Member Functions
	pstream ()
	Creates a pstream without initializing the buffer pointer bp or state.
void	init (std::streambuf *)
	The init member function initializes the stream and sets state to 0 and bp to sbp.
void	setstate (int)
	Updates the state data member with state |= (b & 0xFF).

Protected Attributes
std::streambuf *	bp
int	state

Friends
class	TStreamableTypes
class	TStreamableClass

Detailed Description

Base class for handling streamable objects.

Definition at line 330 of file objstrm.h.

Member Enumeration Documentation

PointerTypes

enum owl::pstream::PointerTypes

Enumerates object pointer types.

Enumerator
ptNull
ptIndexed
ptObject

Definition at line 336 of file objstrm.h.

Constructor & Destructor Documentation

~pstream()

owl::pstream::~pstream ( )

virtual

Definition at line 316 of file objstrm.cpp.

Friends And Related Symbol Documentation

TStreamableClass

friend class TStreamableClass

friend

Definition at line 332 of file objstrm.h.

References TStreamableClass.

TStreamableTypes

friend class TStreamableTypes

friend

Definition at line 331 of file objstrm.h.

References TStreamableTypes.

Member Data Documentation

bp

std::streambuf* owl::pstream::bp

protected

Definition at line 356 of file objstrm.h.

state

int owl::pstream::state

protected

Definition at line 357 of file objstrm.h.

---

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

• include/owl/objstrm.h
• source/owlcore/objstrm.cpp