owl::TStreamer Class Reference

Provides a base class for all streamable objects. More...

#include <owl/objstrm.h>

Inheritance diagram for owl::TStreamer:

Public Member Functions
virtual	~TStreamer ()
TStreamableBase *	GetObject () const
	Returns the address of the TStreamableBase component of the streamable object.

Protected Member Functions
	TStreamer (TStreamableBase *obj)
	Constructs the TStreamer object, and initializes the streamable object pointer.
virtual LPCSTR	StreamableName () const =0
	This pure virtual member function must be redefined for every streamable class.
virtual void *	Read (ipstream &, uint32) const =0
	This pure virtual member function must be redefined for every streamable class.
virtual void	Write (opstream &) const =0
	This pure virtual function must be redefined for every streamable class.

Friends
class	ipstream
class	opstream

Detailed Description

Provides a base class for all streamable objects.

Definition at line 130 of file objstrm.h.

Constructor & Destructor Documentation

~TStreamer()

virtual owl::TStreamer::~TStreamer ( )

inlinevirtual

Definition at line 137 of file objstrm.h.

TStreamer()

owl::TStreamer::TStreamer ( TStreamableBase * obj )

inlineprotected

Constructs the TStreamer object, and initializes the streamable object pointer.

Definition at line 145 of file objstrm.h.

Member Function Documentation

GetObject()

TStreamableBase * owl::TStreamer::GetObject ( ) const

inline

Returns the address of the TStreamableBase component of the streamable object.

Definition at line 140 of file objstrm.h.

Read()

virtual void * owl::TStreamer::Read ( ipstream & , uint32  ) const

protectedpure virtual

This pure virtual member function must be redefined for every streamable class.

It must read the necessary data members for the streamable class from the supplied ipstream.

Implemented in owl::TOldStreamer.

StreamableName()

const char * owl::TStreamer::StreamableName ( ) const

protectedpure virtual

This pure virtual member function must be redefined for every streamable class.

It returns the name of the streamable class, which is used by the stream manager to register the streamable class. The name returned must be a zero-terminated string.

Implemented in owl::TOldStreamer, and owl::TNewStreamer.

Definition at line 152 of file objstrm.cpp.

Write()

virtual void owl::TStreamer::Write ( opstream & ) const

protectedpure virtual

This pure virtual function must be redefined for every streamable class.

It must write the necessary streamable class data members to the supplied opstream object. Write is usually implemented by calling the Write member function (if available) of a base class, and then inserting any additional data members for the derived class.

Implemented in owl::TOldStreamer.

Friends And Related Symbol Documentation

ipstream

friend class ipstream

friend

Definition at line 132 of file objstrm.h.

opstream

friend class opstream

friend

Definition at line 133 of file objstrm.h.

---

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

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