Provides a base class for all streamable objects. More...
#include <objstrm.h>
Public Member Functions | |
| TStreamableBase * | GetObject () const |
Protected Member Functions | |
| TStreamer (TStreamableBase *obj) | |
| virtual LPCSTR | StreamableName () const =0 |
| virtual void * | Read (ipstream &, uint32) const =0 |
| virtual void | Write (opstream &) const =0 |
Friends | |
| class | ipstream |
| class | opstream |
Detailed Description
Provides a base class for all streamable objects.
Constructor & Destructor Documentation
| owl::TStreamer::TStreamer | ( | TStreamableBase * | obj | ) | [inline, protected] |
Constructs the TStreamer object, and initializes the streamable object pointer.
Member Function Documentation
| TStreamableBase* owl::TStreamer::GetObject | ( | ) | const [inline] |
Returns the address of the TStreamableBase component of the streamable object.
| virtual void* owl::TStreamer::Read | ( | ipstream & | , |
| uint32 | |||
| ) | const [protected, pure 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.
| const char * owl::TStreamer::StreamableName | ( | ) | const [protected, pure 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.
| virtual void owl::TStreamer::Write | ( | opstream & | ) | const [protected, pure 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.
The documentation for this class was generated from the following files:
- D:/Work/OWLNext/Subversion/branches/632/include/owl/objstrm.h
- D:/Work/OWLNext/Subversion/branches/632/source/owlcore/objstrm.cpp
