TEventHandler, TStreamableBase, and TGdiBase are important base classes. More...

Classes
class	owl::TResponseTableEntry< T >
	A template class, TResponseTableEntry lets you define a pattern for entries into a response table. More...

class	owl::TEventHandler
	TEventHandler is a base class from which you can derive classes that handle messages. More...

class	owl::TGdiBase
	Root and abstract class for Windows object wrappers. More...

class	owl::TStreamableBase
	Classes that inherit from TStreamableBase are known as streamable classes (their objects can be written to and read from streams). More...

class	owl::TStreamable

class	owl::TStreamer
	Provides a base class for all streamable objects. More...

class	owl::TOldStreamer
	Provides a base class for all streamable objects. More...

class	owl::TNewStreamer

class	owl::TPWrittenObjects

class	owl::TPReadObjects

class	owl::pstream
	Base class for handling streamable objects. More...

class	owl::ipstream
	ipstream, a specialized input stream derivative of pstream, is the base class for reading (extracting) streamable objects. More...

class	owl::opstream
	Base class for writing streamable objects. More...

class	owl::fpbase
	Provides the basic operations common to all object file stream I/O. More...

class	owl::ifpstream
	ifpstream is a simple "mix" of its bases, fpbase and ipstream. More...

class	owl::ofpstream
	Provides the base class for writing (inserting) streamable objects to file streams. More...

Macros
#define	_OBJ_FULLTYPENAME(obj) typeid(*obj).name()

#define	_OBJ_TYPENAME(obj) typeid(*obj).name()

#define	READBASEOBJECT(cls) ReadBaseObject( cls *, ::owl::ipstream& )

#define	WRITEBASEOBJECT(cls) WriteBaseObject( cls *, ::owl::opstream& )

#define	READVIRTUALBASE(cls) ReadVirtualBase( cls *, ::owl::ipstream& )

#define	WRITEVIRTUALBASE(cls) WriteVirtualBase( cls *, ::owl::opstream& )

#define	DECLARE_STREAMERS(cls, ver)

#define	DECLARE_STREAMER(exp, cls, ver)

#define	DECLARE_STREAMER_FROM_BASES(cls, base)

#define	DECLARE_STREAMER_FROM_BASE(exp, cls, base)

#define	DECLARE_ABSTRACT_STREAMERS(cls, ver)

#define	DECLARE_ABSTRACT_STREAMER(exp, cls, ver)

#define	DECLARE_STREAMABLE_OPS(cls)

#define	DECLARE_STREAMABLE_INLINES_I(cls)

#define	DECLARE_STREAMABLE_CTOR(cls)

#define	DECLARE_CASTABLE friend class std::type_info

#define	DECLARE_STREAMABLE(exp, cls, ver) DECLARE_CASTABLE

#define	DECLARE_STREAMABLE_S(cls, ver) DECLARE_CASTABLE

#define	DECLARE_STREAMABLE_FROM_BASE(exp, cls, base) DECLARE_CASTABLE

#define	DECLARE_STREAMABLE_FROM_BASE_S(cls, base) DECLARE_CASTABLE

#define	DECLARE_ABSTRACT_STREAMABLE(exp, cls, ver) DECLARE_CASTABLE

#define	DECLARE_ABSTRACT_STREAMABLE_S(cls, ver) DECLARE_CASTABLE

#define	DECLARE_STREAMABLE_OWL(cls, ver) DECLARE_CASTABLE

#define	DECLARE_STREAMABLE_FROM_BASE_OWL(cls, base) DECLARE_CASTABLE

#define	DECLARE_ABSTRACT_STREAMABLE_OWL(cls, ver) DECLARE_CASTABLE

#define	DECLARE_STREAMABLE_INLINES(cls)

#define	IMPLEMENT_CASTABLE(cls)

#define	IMPLEMENT_CASTABLE1(cls, base1)

#define	IMPLEMENT_CASTABLE2(cls, base1, base2)

#define	IMPLEMENT_CASTABLE3(cls, base1, base2, base3)

#define	IMPLEMENT_CASTABLE4(cls, base1, base2, base3, base4)

#define	IMPLEMENT_CASTABLE5(cls, base1, base2, base3, base4, base5)

#define	IMPLEMENT_STREAMABLE_CLASS(cls)

#define	IMPLEMENT_STREAMABLE_POINTER_IMPL(template_prefix, cls)

#define	IMPLEMENT_STREAMABLE_POINTER(cls)

#define	IMPLEMENT_STREAMER(cls)

#define	IMPLEMENT_STREAMABLE_CTOR(cls)

#define	IMPLEMENT_STREAMABLE_CTOR1_IMPL(template_prefix, cls, constructor, base1)

#define	IMPLEMENT_STREAMABLE_CTOR1(cls, base1)

#define	IMPLEMENT_STREAMABLE_CTOR2(cls, base1, base2)

#define	IMPLEMENT_STREAMABLE_CTOR3(cls, base1, base2, base3)

#define	IMPLEMENT_STREAMABLE_CTOR4(cls, base1, base2, base3, base4)

#define	IMPLEMENT_STREAMABLE_CTOR5(cls, base1, base2, base3, base4, base5)

#define	IMPLEMENT_ABSTRACT_STREAMABLE(cls)

#define	IMPLEMENT_ABSTRACT_STREAMABLE1(cls, base1)

#define	IMPLEMENT_ABSTRACT_STREAMABLE2(cls, base1, base2)

#define	IMPLEMENT_ABSTRACT_STREAMABLE3(cls, base1, base2, base3)

#define	IMPLEMENT_ABSTRACT_STREAMABLE4(cls, base1, base2, base3, base4)

#define	IMPLEMENT_ABSTRACT_STREAMABLE5(cls, base1, base2, base3, base4, base5)

#define	IMPLEMENT_STREAMABLE(cls)

#define	IMPLEMENT_STREAMABLE1(cls, base1)

#define	IMPLEMENT_STREAMABLE2(cls, base1, base2)

#define	IMPLEMENT_STREAMABLE3(cls, base1, base2, base3)

#define	IMPLEMENT_STREAMABLE4(cls, base1, base2, base3, base4)

#define	IMPLEMENT_STREAMABLE5(cls, base1, base2, base3, base4, base5)

#define	IMPLEMENT_STREAMABLE_FROM_BASE(cls, base1)

Typedefs
typedef TResponseTableEntry< TGeneric >	owl::TGenericTableEntry

typedef unsigned	owl::P_id_type

Enumerations
enum	owl::TAutoDelete { owl::NoAutoDelete , owl::AutoDelete }
	Flag for Handle ctors to control Handle deletion in dtor. More...

enum	owl::StreamableInit { owl::streamableInit }

Functions
ipstream &	owl::operator>> (ipstream &is, tstring &str)
	This operator of ipstream extracts (reads) from the ipstream is, to the string str.

opstream &	owl::operator<< (opstream &os, const tstring &str)

ipstream &	owl::operator>> (ipstream &ps, int8 &ch)
	This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

ipstream &	owl::operator>> (ipstream &ps, uint8 &ch)
	This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

ipstream &	owl::operator>> (ipstream &ps, char &ch)
	This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

ipstream &	owl::operator>> (ipstream &ps, signed short &sh)
	This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

ipstream &	owl::operator>> (ipstream &ps, unsigned short &sh)
	This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

ipstream &	owl::operator>> (ipstream &ps, signed int &i)
	This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

ipstream &	owl::operator>> (ipstream &ps, unsigned int &i)
	This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

ipstream &	owl::operator>> (ipstream &ps, bool &b)
	This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

ipstream &	owl::operator>> (ipstream &ps, signed long &l)
	This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

ipstream &	owl::operator>> (ipstream &ps, unsigned long &l)
	This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

ipstream &	owl::operator>> (ipstream &, int64 &)

ipstream &	owl::operator>> (ipstream &, uint64 &)

ipstream &	owl::operator>> (ipstream &ps, float &f)
	This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

ipstream &	owl::operator>> (ipstream &ps, double &d)
	This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

ipstream &	owl::operator>> (ipstream &ps, long double &l)
	This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

opstream &	owl::operator<< (opstream &, int8)
	opstream, a specialized derivative of pstream, is the base class for writing (inserting) streamable objects.

opstream &	owl::operator<< (opstream &ps, uint8 ch)
	This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

opstream &	owl::operator<< (opstream &ps, char ch)
	This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

opstream &	owl::operator<< (opstream &ps, signed short sh)
	This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

opstream &	owl::operator<< (opstream &ps, unsigned short sh)
	This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

opstream &	owl::operator<< (opstream &ps, signed int i)
	This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

opstream &	owl::operator<< (opstream &ps, unsigned int i)
	This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

opstream &	owl::operator<< (opstream &ps, bool b)
	This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

opstream &	owl::operator<< (opstream &ps, signed long l)
	This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

opstream &	owl::operator<< (opstream &ps, unsigned long l)
	This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

opstream &	owl::operator<< (opstream &, int64)

opstream &	owl::operator<< (opstream &, uint64)

opstream &	owl::operator<< (opstream &ps, float f)
	This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

opstream &	owl::operator<< (opstream &ps, double d)
	This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

opstream &	owl::operator<< (opstream &ps, long double l)
	This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

template<class Base >
void	owl::WriteBaseObject (Base *base, opstream &out)

template<class Base >
void	owl::ReadBaseObject (Base *base, ipstream &in)

template<class Base >
void	owl::WriteVirtualBase (Base *base, opstream &out)

template<class Base >
void	owl::ReadVirtualBase (Base *base, ipstream &in)

	owl::pstream::pstream (std::streambuf *)
	Creates a buffered pstream with the given buffer. The state is set to 0.

int	owl::pstream::rdstate () const
	Returns the current state value.

int	owl::pstream::eof () const
	Returns nonzero on end of stream.

int	owl::pstream::fail () const
	Returns nonzero if a previous stream operation failed.

int	owl::pstream::bad () const
	Returns nonzero if an error occurs.

int	owl::pstream::good () const
	Returns nonzero if no error states have been recorded for the stream (that is, no errors have occurred).

void	owl::pstream::clear (int=0)
	Sets the stream state to the given value (defaults to 0).

	owl::pstream::operator void * () const
	Converts to a void pointer.

int	owl::pstream::operator! () const
	Overloads the NOT operator.

std::streambuf *	owl::pstream::rdbuf () const
	Returns the pb pointer to the buffer assigned to the stream.

	owl::pstream::pstream ()
	Creates a pstream without initializing the buffer pointer bp or state.

void	owl::pstream::init (std::streambuf *)
	The init member function initializes the stream and sets state to 0 and bp to sbp.

void	owl::pstream::setstate (int)
	Updates the state data member with state \|= (b & 0xFF).

	owl::ipstream::ipstream (std::streambuf *)
	Creates a buffered ipstream with the given buffer. The state is set to 0.

	owl::ipstream::ipstream ()
	Creates a buffered ipstream without initializing the buffer pointer, bp.

TStreamableBase *	owl::ipstream::find (P_id_type)
	Returns a pointer to the object corresponding to Id.

void	owl::ipstream::registerObject (TStreamableBase *adr)
	Registers the object pointed to by adr.

uint32	owl::ipstream::getVersion () const
	Returns the object version number.

virtual	owl::opstream::~opstream ()

void	owl::opstream::writeWord (uint32)
	Writes the 32-bit word us to the stream.

void	owl::opstream::writeSuffix (const TStreamableBase *)
	Writes the class name suffix to the stream.

P_id_type	owl::opstream::findObject (TStreamableBase *adr)
	Returns the type ID for the object pointed to by adr.

void	owl::opstream::registerObject (TStreamableBase *adr)
	Registers the class of the object pointed to by adr.

P_id_type	owl::opstream::findVB (TStreamableBase *adr)
	Returns a pointer to the virtual base.

void	owl::opstream::registerVB (TStreamableBase *adr)
	Registers a virtual base class.

	owl::fpbase::fpbase ()
	Creates a buffered fpbase object.

	owl::fpbase::fpbase (LPCSTR, int, int=openprot)
	Creates a buffered fpbase object.

	owl::fpbase::fpbase (LPCWSTR, int, int=openprot)
	Creates a buffered fpbase object.

std::filebuf *	owl::fpbase::rdbuf ()
	Returns a pointer to the current file buffer.

	owl::ifpstream::ifpstream ()
	Creates a buffered ifpstream object using a default buffer.

	owl::ifpstream::ifpstream (LPCSTR, int=std::ios::in, int=fpbase::openprot)
	Creates a buffered ifpstream object.

	owl::ifpstream::ifpstream (LPCWSTR, int=std::ios::in, int=fpbase::openprot)
	Creates a buffered ifpstream object.

std::filebuf *	owl::ifpstream::rdbuf ()
	Returns a pointer to the current file buffer.

void	owl::ifpstream::open (LPCSTR, int=std::ios::in, int=fpbase::openprot)
	It opens the named file in the given mode (app, ate, in, out, binary, trunc, nocreate, or noreplace) and protection.

void	owl::ifpstream::open (LPCWSTR, int=std::ios::in, int=fpbase::openprot)
	It opens the named file in the given mode (app, ate, in, out, binary, trunc, nocreate, or noreplace) and protection.

	owl::ofpstream::ofpstream ()
	Creates a buffered ofpstream object using a default buffer.

	owl::ofpstream::ofpstream (LPCSTR, int=std::ios::out, int=fpbase::openprot)
	Creates a buffered ofpstream object.

	owl::ofpstream::ofpstream (LPCWSTR, int=std::ios::out, int=fpbase::openprot)
	Creates a buffered ofpstream object.

std::filebuf *	owl::ofpstream::rdbuf ()

void	owl::ofpstream::open (LPCSTR, int=std::ios::out, int=fpbase::openprot)
	Opens the named file in the given mode (app, ate, in, out, binary, trunc, nocreate, or noreplace) and protection.

void	owl::ofpstream::open (LPCWSTR, int=std::ios::out, int=fpbase::openprot)
	Returns a pointer to the current file buffer.

Variables
class _RTTI	owl::TStreamable

Detailed Description

TEventHandler, TStreamableBase, and TGdiBase are important base classes.

All ObjectWindows classes are derived from one or more of these classes. Classes that inherit from TEventHandler are able to respond to window messages. Classes that inherit from TStreamableBase support streaming; that is, their objects can write to and read from streams. Almost all of the ObjectWindows classes are derived from TStreamableBase. You can use multiple inheritance to derive a class from both TEventHandler and TStreamableBase. Classes that inherit from TGDIBase, a private base class, support GDI drawing objects such as pens, brushes, fonts, and bitmaps.

TEventHandler sends messages to the appropriate message handler.
TStreamableBase provides support for C++ streaming and persistence.
TGdiBase is the root class for all derived GDI classes that support Windows' GDI library.

Macro Definition Documentation

◆ _OBJ_FULLTYPENAME

#define _OBJ_FULLTYPENAME ( obj ) typeid(*obj).name()

Definition at line 78 of file objstrm.h.

◆ _OBJ_TYPENAME

#define _OBJ_TYPENAME ( obj ) typeid(*obj).name()

Definition at line 86 of file objstrm.h.

◆ DECLARE_ABSTRACT_STREAMABLE

#define DECLARE_ABSTRACT_STREAMABLE	(	exp,
		cls,
		ver ) DECLARE_CASTABLE

Definition at line 1523 of file objstrm.h.

◆ DECLARE_ABSTRACT_STREAMABLE_OWL

#define DECLARE_ABSTRACT_STREAMABLE_OWL	(		cls,
			ver ) DECLARE_CASTABLE

Definition at line 1535 of file objstrm.h.

◆ DECLARE_ABSTRACT_STREAMABLE_S

#define DECLARE_ABSTRACT_STREAMABLE_S	(		cls,
			ver ) DECLARE_CASTABLE

Definition at line 1526 of file objstrm.h.

◆ DECLARE_ABSTRACT_STREAMER

#define DECLARE_ABSTRACT_STREAMER	(	exp,
		cls,
		ver )

Value:

public:                                                             \
    class exp Streamer : public ::owl::TNewStreamer                        \
        {                                                           \
        public:                                                     \
                                                                    \
        Streamer( ::owl::TStreamableBase *obj );                           \
                                                                    \
        virtual ::owl::uint32 ClassVersion() const                         \
            { return ver; }                                         \
                                                                    \
        virtual void Write( ::owl::opstream& ) const;                      \
        virtual void *Read( ::owl::ipstream&, ::owl::uint32 ) const;              \
                                                                    \
        cls *GetObject() const                                      \
            {                                                       \
            return object;                                          \
            }                                                       \
                                                                    \
        private:                                                    \
            cls *object;                                            \
                                                                    \
        };                                                          \
    friend class exp Streamer;                                      \
    friend void ::owl:: READBASEOBJECT( cls ); \
    friend void ::owl:: WRITEBASEOBJECT( cls );\
    friend void ::owl:: READVIRTUALBASE( cls );\
    friend void ::owl:: WRITEVIRTUALBASE( cls )

Definition at line 1386 of file objstrm.h.

◆ DECLARE_ABSTRACT_STREAMERS

#define DECLARE_ABSTRACT_STREAMERS	(		cls,
			ver )

Value:

public:                                                             \
    class Streamer : public ::owl::TNewStreamer                            \
        {                                                           \
        public:                                                     \
                                                                    \
        Streamer( ::owl::TStreamableBase *obj );                           \
                                                                    \
        virtual ::owl::uint32 ClassVersion() const                         \
            { return ver; }                                         \
                                                                    \
        virtual void Write( ::owl::opstream& ) const;                      \
        virtual void *Read( ::owl::ipstream&, ::owl::uint32 ) const;              \
                                                                    \
        cls *GetObject() const                                      \
            {                                                       \
            return object;                                          \
            }                                                       \
                                                                    \
        private:                                                    \
            cls *object;                                            \
                                                                    \
        };                                                          \
    friend class Streamer;                                          \
    friend void ::owl:: READBASEOBJECT( cls ); \
    friend void ::owl:: WRITEBASEOBJECT( cls );\
    friend void ::owl:: READVIRTUALBASE( cls );\
    friend void ::owl:: WRITEVIRTUALBASE( cls )

Definition at line 1357 of file objstrm.h.

◆ DECLARE_CASTABLE

#define DECLARE_CASTABLE friend class std::type_info

Definition at line 1440 of file objstrm.h.

◆ DECLARE_STREAMABLE

#define DECLARE_STREAMABLE	(	exp,
		cls,
		ver ) DECLARE_CASTABLE

Definition at line 1511 of file objstrm.h.

◆ DECLARE_STREAMABLE_CTOR

#define DECLARE_STREAMABLE_CTOR ( cls )

Value:

public: \

cls ( ::owl::StreamableInit )

owl::StreamableInit

StreamableInit

Definition objstrm.h:98

Definition at line 1433 of file objstrm.h.

◆ DECLARE_STREAMABLE_FROM_BASE

#define DECLARE_STREAMABLE_FROM_BASE	(	exp,
		cls,
		base ) DECLARE_CASTABLE

Definition at line 1517 of file objstrm.h.

◆ DECLARE_STREAMABLE_FROM_BASE_OWL

#define DECLARE_STREAMABLE_FROM_BASE_OWL	(		cls,
			base ) DECLARE_CASTABLE

Definition at line 1532 of file objstrm.h.

◆ DECLARE_STREAMABLE_FROM_BASE_S

#define DECLARE_STREAMABLE_FROM_BASE_S	(		cls,
			base ) DECLARE_CASTABLE

Definition at line 1520 of file objstrm.h.

◆ DECLARE_STREAMABLE_INLINES

#define DECLARE_STREAMABLE_INLINES ( cls )

Definition at line 1538 of file objstrm.h.

◆ DECLARE_STREAMABLE_INLINES_I

#define DECLARE_STREAMABLE_INLINES_I ( cls )

Definition at line 1430 of file objstrm.h.

◆ DECLARE_STREAMABLE_OPS

#define DECLARE_STREAMABLE_OPS ( cls )

Value:

static ::owl::ipstream& readRef( ::owl::ipstream& is, cls& cl );                  \
friend inline ::owl::ipstream& operator >> ( ::owl::ipstream& is, cls& cl )       \
    { return cls::readRef( is, cl ); }                              \
static ::owl::ipstream& readPtr( ::owl::ipstream& is, cls*& cl );                 \
friend inline ::owl::ipstream& operator >> ( ::owl::ipstream& is, cls*& cl )      \
    { return cls::readPtr( is, cl ); }                              \
static ::owl::opstream& writeRef( ::owl::opstream& is, const cls& cl );           \
friend inline ::owl::opstream& operator << ( ::owl::opstream& os, const cls& cl ) \
    { return cls::writeRef( os, cl ); }                             \
static ::owl::opstream& writePtr( ::owl::opstream& is, const cls* cl );           \
friend inline ::owl::opstream& operator << ( ::owl::opstream& os, const cls* cl ) \
    { return cls::writePtr( os, cl ); }

Definition at line 1416 of file objstrm.h.

◆ DECLARE_STREAMABLE_OWL

#define DECLARE_STREAMABLE_OWL	(		cls,
			ver ) DECLARE_CASTABLE

Definition at line 1529 of file objstrm.h.

◆ DECLARE_STREAMABLE_S

#define DECLARE_STREAMABLE_S	(		cls,
			ver ) DECLARE_CASTABLE

Definition at line 1514 of file objstrm.h.

◆ DECLARE_STREAMER

#define DECLARE_STREAMER	(	exp,
		cls,
		ver )

Definition at line 1265 of file objstrm.h.

◆ DECLARE_STREAMER_FROM_BASE

#define DECLARE_STREAMER_FROM_BASE	(	exp,
		cls,
		base )

Value:

public:                                                             \
    class exp Streamer : public base::Streamer                      \
        {                                                           \
        public:                                                     \
                                                                    \
        Streamer( ::owl::TStreamableBase *obj ) : base::Streamer(obj){}    \
                                                                    \
        cls *GetObject() const                                      \
            {                                                       \
            return object;                                          \
            }                                                       \
                                                                    \
        static ::owl::TStreamer *Build( ::owl::TStreamableBase *obj )             \
            {                                                       \
            return new Streamer( obj ? obj : new cls(::owl::streamableInit) ); \
            }                                                       \
                                                                    \
        private:                                                    \
            cls *object;                                            \
                                                                    \
        };                                                          \
    friend class exp Streamer;                                      \
    friend void ::owl:: READBASEOBJECT( cls ); \
    friend void ::owl:: WRITEBASEOBJECT( cls );\
    friend void ::owl:: READVIRTUALBASE( cls );\
    friend void ::owl:: WRITEVIRTUALBASE( cls )

Definition at line 1329 of file objstrm.h.

◆ DECLARE_STREAMER_FROM_BASES

#define DECLARE_STREAMER_FROM_BASES	(		cls,
			base )

Value:

public:                                                             \
    class Streamer : public base::Streamer                          \
        {                                                           \
        public:                                                     \
                                                                    \
        Streamer( ::owl::TStreamableBase *obj ) : base::Streamer(obj){} \
                                                                    \
        cls *GetObject() const                                      \
            {                                                       \
            return object;                                          \
            }                                                       \
                                                                    \
        static ::owl::TStreamer *Build( ::owl::TStreamableBase *obj ) \
            {                                                       \
            return new Streamer( obj ? obj : new cls(::owl::streamableInit) ); \
            }                                                       \
                                                                    \
        private:                                                    \
            cls *object;                                            \
                                                                    \
        };                                                          \
    friend class Streamer;                                                \
    friend void ::owl:: READBASEOBJECT( cls );   \
    friend void ::owl:: WRITEBASEOBJECT( cls );  \
    friend void ::owl:: READVIRTUALBASE( cls );  \
    friend void ::owl:: WRITEVIRTUALBASE( cls )

Definition at line 1300 of file objstrm.h.

◆ DECLARE_STREAMERS

#define DECLARE_STREAMERS	(		cls,
			ver )

Definition at line 1230 of file objstrm.h.

◆ IMPLEMENT_ABSTRACT_STREAMABLE

#define IMPLEMENT_ABSTRACT_STREAMABLE ( cls )

Definition at line 1718 of file objstrm.h.

◆ IMPLEMENT_ABSTRACT_STREAMABLE1

#define IMPLEMENT_ABSTRACT_STREAMABLE1	(		cls,
			base1 )

Definition at line 1719 of file objstrm.h.

◆ IMPLEMENT_ABSTRACT_STREAMABLE2

#define IMPLEMENT_ABSTRACT_STREAMABLE2	(	cls,
		base1,
		base2 )

Definition at line 1720 of file objstrm.h.

◆ IMPLEMENT_ABSTRACT_STREAMABLE3

#define IMPLEMENT_ABSTRACT_STREAMABLE3	(	cls,
		base1,
		base2,
		base3 )

Definition at line 1721 of file objstrm.h.

◆ IMPLEMENT_ABSTRACT_STREAMABLE4

#define IMPLEMENT_ABSTRACT_STREAMABLE4	(	cls,
		base1,
		base2,
		base3,
		base4 )

Definition at line 1722 of file objstrm.h.

◆ IMPLEMENT_ABSTRACT_STREAMABLE5

#define IMPLEMENT_ABSTRACT_STREAMABLE5	(	cls,
		base1,
		base2,
		base3,
		base4,
		base5 )

Definition at line 1723 of file objstrm.h.

◆ IMPLEMENT_CASTABLE

#define IMPLEMENT_CASTABLE ( cls )

Definition at line 1547 of file objstrm.h.

◆ IMPLEMENT_CASTABLE1

#define IMPLEMENT_CASTABLE1	(		cls,
			base1 )

Definition at line 1548 of file objstrm.h.

◆ IMPLEMENT_CASTABLE2

#define IMPLEMENT_CASTABLE2	(	cls,
		base1,
		base2 )

Definition at line 1549 of file objstrm.h.

◆ IMPLEMENT_CASTABLE3

#define IMPLEMENT_CASTABLE3	(	cls,
		base1,
		base2,
		base3 )

Definition at line 1550 of file objstrm.h.

◆ IMPLEMENT_CASTABLE4

#define IMPLEMENT_CASTABLE4	(	cls,
		base1,
		base2,
		base3,
		base4 )

Definition at line 1551 of file objstrm.h.

◆ IMPLEMENT_CASTABLE5

#define IMPLEMENT_CASTABLE5	(	cls,
		base1,
		base2,
		base3,
		base4,
		base5 )

Definition at line 1552 of file objstrm.h.

◆ IMPLEMENT_STREAMABLE

#define IMPLEMENT_STREAMABLE ( cls )

Definition at line 1724 of file objstrm.h.

◆ IMPLEMENT_STREAMABLE1

#define IMPLEMENT_STREAMABLE1	(		cls,
			base1 )

Definition at line 1725 of file objstrm.h.

◆ IMPLEMENT_STREAMABLE2

#define IMPLEMENT_STREAMABLE2	(	cls,
		base1,
		base2 )

Definition at line 1726 of file objstrm.h.

◆ IMPLEMENT_STREAMABLE3

#define IMPLEMENT_STREAMABLE3	(	cls,
		base1,
		base2,
		base3 )

Definition at line 1727 of file objstrm.h.

◆ IMPLEMENT_STREAMABLE4

#define IMPLEMENT_STREAMABLE4	(	cls,
		base1,
		base2,
		base3,
		base4 )

Definition at line 1728 of file objstrm.h.

◆ IMPLEMENT_STREAMABLE5

#define IMPLEMENT_STREAMABLE5	(	cls,
		base1,
		base2,
		base3,
		base4,
		base5 )

Definition at line 1729 of file objstrm.h.

◆ IMPLEMENT_STREAMABLE_CLASS

#define IMPLEMENT_STREAMABLE_CLASS ( cls )

Definition at line 1573 of file objstrm.h.

◆ IMPLEMENT_STREAMABLE_CTOR

#define IMPLEMENT_STREAMABLE_CTOR ( cls )

Definition at line 1642 of file objstrm.h.

◆ IMPLEMENT_STREAMABLE_CTOR1

#define IMPLEMENT_STREAMABLE_CTOR1	(		cls,
			base1 )

Definition at line 1644 of file objstrm.h.

◆ IMPLEMENT_STREAMABLE_CTOR1_IMPL

#define IMPLEMENT_STREAMABLE_CTOR1_IMPL	(	template_prefix,
		cls,
		constructor,
		base1 )

Definition at line 1643 of file objstrm.h.

◆ IMPLEMENT_STREAMABLE_CTOR2

#define IMPLEMENT_STREAMABLE_CTOR2	(	cls,
		base1,
		base2 )

Definition at line 1645 of file objstrm.h.

◆ IMPLEMENT_STREAMABLE_CTOR3

#define IMPLEMENT_STREAMABLE_CTOR3	(	cls,
		base1,
		base2,
		base3 )

Definition at line 1646 of file objstrm.h.

◆ IMPLEMENT_STREAMABLE_CTOR4

#define IMPLEMENT_STREAMABLE_CTOR4	(	cls,
		base1,
		base2,
		base3,
		base4 )

Definition at line 1647 of file objstrm.h.

◆ IMPLEMENT_STREAMABLE_CTOR5

#define IMPLEMENT_STREAMABLE_CTOR5	(	cls,
		base1,
		base2,
		base3,
		base4,
		base5 )

Definition at line 1648 of file objstrm.h.

◆ IMPLEMENT_STREAMABLE_FROM_BASE

#define IMPLEMENT_STREAMABLE_FROM_BASE	(		cls,
			base1 )

Definition at line 1730 of file objstrm.h.

◆ IMPLEMENT_STREAMABLE_POINTER

#define IMPLEMENT_STREAMABLE_POINTER ( cls )

Definition at line 1596 of file objstrm.h.

◆ IMPLEMENT_STREAMABLE_POINTER_IMPL

#define IMPLEMENT_STREAMABLE_POINTER_IMPL	(		template_prefix,
			cls )

Definition at line 1595 of file objstrm.h.

◆ IMPLEMENT_STREAMER

#define IMPLEMENT_STREAMER ( cls )

Definition at line 1641 of file objstrm.h.

◆ READBASEOBJECT

#define READBASEOBJECT ( cls ) ReadBaseObject( cls *, ::owl::ipstream& )

Definition at line 1222 of file objstrm.h.

◆ READVIRTUALBASE

#define READVIRTUALBASE ( cls ) ReadVirtualBase( cls *, ::owl::ipstream& )

Definition at line 1224 of file objstrm.h.

◆ WRITEBASEOBJECT

#define WRITEBASEOBJECT ( cls ) WriteBaseObject( cls *, ::owl::opstream& )

Definition at line 1223 of file objstrm.h.

◆ WRITEVIRTUALBASE

#define WRITEVIRTUALBASE ( cls ) WriteVirtualBase( cls *, ::owl::opstream& )

Definition at line 1225 of file objstrm.h.

Typedef Documentation

◆ P_id_type

typedef unsigned owl::P_id_type

Definition at line 54 of file objstrm.h.

◆ TGenericTableEntry

typedef TResponseTableEntry<TGeneric> owl::TGenericTableEntry

Definition at line 144 of file eventhan.h.

Enumeration Type Documentation

◆ StreamableInit

enum owl::StreamableInit

\ class TStreamable

This is the base class from which all streamable objects must be

derived.

Enumerator
streamableInit

Definition at line 98 of file objstrm.h.

◆ TAutoDelete

enum owl::TAutoDelete

Flag for Handle ctors to control Handle deletion in dtor.

Enumerator
NoAutoDelete
AutoDelete

Definition at line 70 of file gdibase.h.

Function Documentation

◆ fpbase() [1/3]

owl::fpbase::fpbase ( )

inline

Creates a buffered fpbase object.

Definition at line 772 of file objstrm.h.

References owl::pstream::init().

◆ fpbase() [2/3]

owl::fpbase::fpbase	(	LPCSTR	name,
		int	omode,
		int	prot = openprot )

inline

Creates a buffered fpbase object.

It opens the file specified by name, using the mode omode and protection prot; and attaches this file to the stream.

Definition at line 778 of file objstrm.h.

References owl::pstream::init(), and owl::fpbase::open().

◆ fpbase() [3/3]

owl::fpbase::fpbase	(	LPCWSTR	name,
		int	omode,
		int	prot = openprot )

inline

Creates a buffered fpbase object.

It opens the file specified by name, using the mode omode and protection prot; and attaches this file to the stream.

Definition at line 785 of file objstrm.h.

References owl::pstream::init(), and owl::fpbase::open().

◆ ifpstream() [1/3]

owl::ifpstream::ifpstream ( )

inline

Creates a buffered ifpstream object using a default buffer.

Definition at line 796 of file objstrm.h.

◆ ifpstream() [2/3]

owl::ifpstream::ifpstream	(	LPCSTR	name,
		int	omode = std::ios::in,
		int	prot = fpbase::openprot )

inline

Creates a buffered ifpstream object.

It opens the file specified by name using the mode mode and protection prot; and attaches this file to the stream.

Definition at line 801 of file objstrm.h.

◆ ifpstream() [3/3]

owl::ifpstream::ifpstream	(	LPCWSTR	name,
		int	omode = std::ios::in,
		int	prot = fpbase::openprot )

inline

Creates a buffered ifpstream object.

It opens the file specified by name using the mode mode and protection prot; and attaches this file to the stream.

Definition at line 809 of file objstrm.h.

◆ ipstream() [1/2]

owl::ipstream::ipstream ( )

inlineprotected

Creates a buffered ipstream without initializing the buffer pointer, bp.

Use psteam::init to set the buffer and state.

Definition at line 716 of file objstrm.h.

References owl::pstream::bp, and owl::ipstream::readVersion().

◆ ipstream() [2/2]

owl::ipstream::ipstream ( std::streambuf * sb )

inline

Creates a buffered ipstream with the given buffer. The state is set to 0.

Definition at line 709 of file objstrm.h.

References owl::pstream::init(), and owl::ipstream::readVersion().

◆ ofpstream() [1/3]

owl::ofpstream::ofpstream ( )

inline

Creates a buffered ofpstream object using a default buffer.

Definition at line 845 of file objstrm.h.

◆ ofpstream() [2/3]

owl::ofpstream::ofpstream	(	LPCSTR	name,
		int	omode = std::ios::out,
		int	prot = fpbase::openprot )

inline

Creates a buffered ofpstream object.

It opens the file specified by name, using the mode mode, and protection prot; and attaches this file to the stream

Definition at line 851 of file objstrm.h.

◆ ofpstream() [3/3]

owl::ofpstream::ofpstream	(	LPCWSTR	name,
		int	omode = std::ios::out,
		int	prot = fpbase::openprot )

inline

Creates a buffered ofpstream object.

It opens the file specified by name, using the mode mode, and protection prot; and attaches this file to the stream

Definition at line 860 of file objstrm.h.

◆ pstream() [1/2]

owl::pstream::pstream ( )

inlineprotected

Creates a pstream without initializing the buffer pointer bp or state.

Use init to set the buffer and setstate to set the state.

Definition at line 693 of file objstrm.h.

◆ pstream() [2/2]

owl::pstream::pstream ( std::streambuf * sb )

inline

Creates a buffered pstream with the given buffer. The state is set to 0.

Definition at line 640 of file objstrm.h.

References owl::pstream::init().

◆ ~opstream()

owl::opstream::~opstream ( )

inlinevirtual

Definition at line 735 of file objstrm.h.

◆ bad()

int owl::pstream::bad ( ) const

inline

Returns nonzero if an error occurs.

Definition at line 660 of file objstrm.h.

References owl::pstream::state.

◆ clear()

void owl::pstream::clear ( int i = 0 )

inline

Sets the stream state to the given value (defaults to 0).

Definition at line 671 of file objstrm.h.

References owl::pstream::state.

◆ eof()

int owl::pstream::eof ( ) const

inline

Returns nonzero on end of stream.

Definition at line 650 of file objstrm.h.

References owl::pstream::state.

◆ fail()

int owl::pstream::fail ( ) const

inline

Returns nonzero if a previous stream operation failed.

Definition at line 655 of file objstrm.h.

References owl::pstream::state.

◆ find()

TStreamableBase * owl::ipstream::find ( P_id_type id )

inline

Returns a pointer to the object corresponding to Id.

Definition at line 722 of file objstrm.h.

◆ findObject()

P_id_type owl::opstream::findObject ( TStreamableBase * adr )

inline

Returns the type ID for the object pointed to by adr.

Definition at line 752 of file objstrm.h.

◆ findVB()

P_id_type owl::opstream::findVB ( TStreamableBase * adr )

inline

Returns a pointer to the virtual base.

Definition at line 762 of file objstrm.h.

◆ getVersion()

uint32 owl::ipstream::getVersion ( ) const

inline

Returns the object version number.

Definition at line 732 of file objstrm.h.

◆ good()

int owl::pstream::good ( ) const

inline

Returns nonzero if no error states have been recorded for the stream (that is, no errors have occurred).

Definition at line 666 of file objstrm.h.

References owl::pstream::state.

◆ init()

void owl::pstream::init ( std::streambuf * sbp )

inlineprotected

The init member function initializes the stream and sets state to 0 and bp to sbp.

Definition at line 698 of file objstrm.h.

References owl::pstream::bp, and owl::pstream::state.

◆ open() [1/4]

void owl::ifpstream::open	(	LPCSTR	name,
		int	omode = std::ios::in,
		int	prot = fpbase::openprot )

inline

It opens the named file in the given mode (app, ate, in, out, binary, trunc, nocreate, or noreplace) and protection.

The default mode for ifpstream is ios::in (input) with openprot protection. The opened file is attached to this stream.

Definition at line 824 of file objstrm.h.

References owl::fpbase::open(), and owl::ipstream::readVersion().

◆ open() [2/4]

void owl::ofpstream::open	(	LPCSTR	name,
		int	omode = std::ios::out,
		int	prot = fpbase::openprot )

inline

Opens the named file in the given mode (app, ate, in, out, binary, trunc, nocreate, or noreplace) and protection.

The default mode for ofpstream is ios::out (output) with openprot protection. The opened file is attached to this stream.

Definition at line 874 of file objstrm.h.

References owl::fpbase::open(), and owl::opstream::writeVersion().

◆ open() [3/4]

void owl::ifpstream::open	(	LPCWSTR	name,
		int	omode = std::ios::in,
		int	prot = fpbase::openprot )

inline

It opens the named file in the given mode (app, ate, in, out, binary, trunc, nocreate, or noreplace) and protection.

The default mode for ifpstream is ios::in (input) with openprot protection. The opened file is attached to this stream.

Definition at line 836 of file objstrm.h.

References owl::fpbase::open(), and owl::ipstream::readVersion().

◆ open() [4/4]

void owl::ofpstream::open	(	LPCWSTR	name,
		int	omode = std::ios::out,
		int	prot = fpbase::openprot )

inline

Returns a pointer to the current file buffer.

Definition at line 883 of file objstrm.h.

References owl::fpbase::open(), and owl::opstream::writeVersion().

◆ operator void *()

owl::pstream::operator void * ( ) const

inline

Converts to a void pointer.

Definition at line 676 of file objstrm.h.

◆ operator!()

int owl::pstream::operator! ( ) const

inline

Overloads the NOT operator.

Returns 0 if the operation has failed (that is, if pstream::fail returned nonzero); otherwise, returns nonzero.

Definition at line 682 of file objstrm.h.

References owl::pstream::fail().

◆ operator<<() [1/16]

opstream & owl::operator<<	(	opstream &	ps,
		int64	v )

inline

Definition at line 1106 of file objstrm.h.

◆ operator<<() [2/16]

opstream & owl::operator<<	(	opstream &	ps,
		int8	ch )

inline

opstream, a specialized derivative of pstream, is the base class for writing (inserting) streamable objects.

This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

The data type of the argument determines the form of write operation employed.

Definition at line 1037 of file objstrm.h.

◆ operator<<() [3/16]

opstream & owl::operator<<	(	opstream &	ps,
		uint64	v )

inline

Definition at line 1112 of file objstrm.h.

◆ operator<<() [4/16]

opstream & owl::operator<<	(	opstream &	os,
		const tstring &	str )

Definition at line 954 of file objstrm.cpp.

References _USES_CONVERSION, and _W2A.

◆ operator<<() [5/16]

opstream & owl::operator<<	(	opstream &	ps,
		bool	b )

inline

This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

The data type of the argument determines the form of write operation employed.

Definition at line 1145 of file objstrm.h.

◆ operator<<() [6/16]

opstream & owl::operator<<	(	opstream &	ps,
		char	ch )

inline

This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

The data type of the argument determines the form of write operation employed.

Definition at line 1053 of file objstrm.h.

◆ operator<<() [7/16]

opstream & owl::operator<<	(	opstream &	ps,
		double	d )

inline

This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

The data type of the argument determines the form of write operation employed.

Definition at line 1129 of file objstrm.h.

◆ operator<<() [8/16]

opstream & owl::operator<<	(	opstream &	ps,
		float	f )

inline

This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

The data type of the argument determines the form of write operation employed.

Definition at line 1121 of file objstrm.h.

◆ operator<<() [9/16]

opstream & owl::operator<<	(	opstream &	ps,
		long double	l )

inline

This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

The data type of the argument determines the form of write operation employed.

Definition at line 1137 of file objstrm.h.

◆ operator<<() [10/16]

opstream & owl::operator<<	(	opstream &	ps,
		signed int	i )

inline

This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

The data type of the argument determines the form of write operation employed.

Definition at line 1077 of file objstrm.h.

◆ operator<<() [11/16]

opstream & owl::operator<<	(	opstream &	ps,
		signed long	l )

inline

This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

The data type of the argument determines the form of write operation employed.

Definition at line 1093 of file objstrm.h.

◆ operator<<() [12/16]

opstream & owl::operator<<	(	opstream &	ps,
		signed short	sh )

inline

This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

The data type of the argument determines the form of write operation employed.

Definition at line 1061 of file objstrm.h.

◆ operator<<() [13/16]

opstream & owl::operator<<	(	opstream &	ps,
		uint8	ch )

inline

This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

The data type of the argument determines the form of write operation employed.

Definition at line 1045 of file objstrm.h.

◆ operator<<() [14/16]

opstream & owl::operator<<	(	opstream &	ps,
		unsigned int	i )

inline

This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

The data type of the argument determines the form of write operation employed.

Definition at line 1085 of file objstrm.h.

◆ operator<<() [15/16]

opstream & owl::operator<<	(	opstream &	ps,
		unsigned long	l )

inline

This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

The data type of the argument determines the form of write operation employed.

Definition at line 1101 of file objstrm.h.

◆ operator<<() [16/16]

opstream & owl::operator<<	(	opstream &	ps,
		unsigned short	sh )

inline

This friend operator of opstream inserts (writes) the given argument to the given ipstream object.

The data type of the argument determines the form of write operation employed.

Definition at line 1069 of file objstrm.h.

◆ operator>>() [1/16]

ipstream & owl::operator>>	(	ipstream &	ps,
		int64 &	v )

inline

Definition at line 982 of file objstrm.h.

◆ operator>>() [2/16]

ipstream & owl::operator>>	(	ipstream &	ps,
		uint64 &	v )

inline

Definition at line 988 of file objstrm.h.

◆ operator>>() [3/16]

ipstream & owl::operator>>	(	ipstream &	is,
		tstring &	str )

This operator of ipstream extracts (reads) from the ipstream is, to the string str.

It returns a reference to the stream that lets you chain >> operations in the usual way.

Definition at line 964 of file objstrm.cpp.

◆ operator>>() [4/16]

ipstream & owl::operator>>	(	ipstream &	ps,
		bool &	b )

inline

This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

It returns a reference to the stream that lets you chain >> operations in the usual way. The data type of the argument determines how the read is performed. For example, reading a signed char is implemented using readByte.

Definition at line 1029 of file objstrm.h.

◆ operator>>() [5/16]

ipstream & owl::operator>>	(	ipstream &	ps,
		char &	ch )

inline

This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

It returns a reference to the stream that lets you chain >> operations in the usual way. The data type of the argument determines how the read is performed. For example, reading a signed char is implemented using readByte.

Definition at line 917 of file objstrm.h.

◆ operator>>() [6/16]

ipstream & owl::operator>>	(	ipstream &	ps,
		double &	d )

inline

This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

It returns a reference to the stream that lets you chain >> operations in the usual way. The data type of the argument determines how the read is performed. For example, reading a signed char is implemented using readByte.

Definition at line 1009 of file objstrm.h.

◆ operator>>() [7/16]

ipstream & owl::operator>>	(	ipstream &	ps,
		float &	f )

inline

This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

It returns a reference to the stream that lets you chain >> operations in the usual way. The data type of the argument determines how the read is performed. For example, reading a signed char is implemented using readByte.

Definition at line 999 of file objstrm.h.

◆ operator>>() [8/16]

ipstream & owl::operator>>	(	ipstream &	ps,
		int8 &	ch )

inline

This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

Base class for reading streamable objects

It returns a reference to the stream that lets you chain >> operations in the usual way. The data type of the argument determines how the read is performed. For example, reading a signed char is implemented using readByte.

Definition at line 896 of file objstrm.h.

◆ operator>>() [9/16]

ipstream & owl::operator>>	(	ipstream &	ps,
		long double &	l )

inline

This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

It returns a reference to the stream that lets you chain >> operations in the usual way. The data type of the argument determines how the read is performed. For example, reading a signed char is implemented using readByte.

Definition at line 1019 of file objstrm.h.

◆ operator>>() [10/16]

ipstream & owl::operator>>	(	ipstream &	ps,
		signed int &	i )

inline

This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

It returns a reference to the stream that lets you chain >> operations in the usual way. The data type of the argument determines how the read is performed. For example, reading a signed char is implemented using readByte.

Definition at line 947 of file objstrm.h.

◆ operator>>() [11/16]

ipstream & owl::operator>>	(	ipstream &	ps,
		signed long &	l )

inline

This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

It returns a reference to the stream that lets you chain >> operations in the usual way. The data type of the argument determines how the read is performed. For example, reading a signed char is implemented using readByte.

Definition at line 967 of file objstrm.h.

◆ operator>>() [12/16]

ipstream & owl::operator>>	(	ipstream &	ps,
		signed short &	sh )

inline

This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

It returns a reference to the stream that lets you chain >> operations in the usual way. The data type of the argument determines how the read is performed. For example, reading a signed char is implemented using readByte.

Definition at line 927 of file objstrm.h.

◆ operator>>() [13/16]

ipstream & owl::operator>>	(	ipstream &	ps,
		uint8 &	ch )

inline

This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

It returns a reference to the stream that lets you chain >> operations in the usual way. The data type of the argument determines how the read is performed. For example, reading a signed char is implemented using readByte.

Definition at line 907 of file objstrm.h.

◆ operator>>() [14/16]

ipstream & owl::operator>>	(	ipstream &	ps,
		unsigned int &	i )

inline

This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

It returns a reference to the stream that lets you chain >> operations in the usual way. The data type of the argument determines how the read is performed. For example, reading a signed char is implemented using readByte.

Definition at line 957 of file objstrm.h.

◆ operator>>() [15/16]

ipstream & owl::operator>>	(	ipstream &	ps,
		unsigned long &	l )

inline

This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

It returns a reference to the stream that lets you chain >> operations in the usual way. The data type of the argument determines how the read is performed. For example, reading a signed char is implemented using readByte.

Definition at line 977 of file objstrm.h.

◆ operator>>() [16/16]

ipstream & owl::operator>>	(	ipstream &	ps,
		unsigned short &	sh )

inline

This friend operator of ipstream extracts (reads) from the ipstream ps, to the given argument.

It returns a reference to the stream that lets you chain >> operations in the usual way. The data type of the argument determines how the read is performed. For example, reading a signed char is implemented using readByte.

Definition at line 937 of file objstrm.h.

◆ rdbuf() [1/4]

std::filebuf * owl::fpbase::rdbuf ( )

inline

Returns a pointer to the current file buffer.

Definition at line 791 of file objstrm.h.

◆ rdbuf() [2/4]

std::filebuf * owl::ifpstream::rdbuf ( )

inline

Returns a pointer to the current file buffer.

Definition at line 816 of file objstrm.h.

References owl::fpbase::rdbuf().

◆ rdbuf() [3/4]

std::filebuf * owl::ofpstream::rdbuf ( )

inline

Definition at line 866 of file objstrm.h.

References owl::fpbase::rdbuf().

◆ rdbuf() [4/4]

std::streambuf * owl::pstream::rdbuf ( ) const

inline

Returns the pb pointer to the buffer assigned to the stream.

Definition at line 687 of file objstrm.h.

References owl::pstream::bp.

◆ rdstate()

int owl::pstream::rdstate ( ) const

inline

Returns the current state value.

Definition at line 645 of file objstrm.h.

References owl::pstream::state.

◆ ReadBaseObject()

template<class Base >

void owl::ReadBaseObject	(	Base *	base,
		ipstream &	in )

Definition at line 1159 of file objstrm.h.

◆ ReadVirtualBase()

template<class Base >

void owl::ReadVirtualBase	(	Base *	base,
		ipstream &	in )

Definition at line 1190 of file objstrm.h.

References owl::pstream::ptIndexed, and owl::pstream::ptObject.

◆ registerObject() [1/2]

void owl::ipstream::registerObject ( TStreamableBase * adr )

inline

Registers the object pointed to by adr.

Definition at line 727 of file objstrm.h.

◆ registerObject() [2/2]

void owl::opstream::registerObject ( TStreamableBase * adr )

inline

Registers the class of the object pointed to by adr.

Definition at line 757 of file objstrm.h.

◆ registerVB()

void owl::opstream::registerVB ( TStreamableBase * adr )

inline

Registers a virtual base class.

Definition at line 767 of file objstrm.h.

◆ setstate()

void owl::pstream::setstate ( int b )

inlineprotected

Updates the state data member with state |= (b & 0xFF).

Definition at line 704 of file objstrm.h.

References owl::pstream::state.

◆ WriteBaseObject()

template<class Base >

void owl::WriteBaseObject	(	Base *	base,
		opstream &	out )

Definition at line 1150 of file objstrm.h.

◆ writeSuffix()

void owl::opstream::writeSuffix ( const TStreamableBase * )

inlineprotected

Writes the class name suffix to the stream.

The << operator uses this function to write a prefix and suffix around the data written with writeData. The prefix/suffix is used to ensure type-safe stream I/O.

Definition at line 747 of file objstrm.h.

References owl::opstream::writeByte().

◆ WriteVirtualBase()

template<class Base >

void owl::WriteVirtualBase	(	Base *	base,
		opstream &	out )

Definition at line 1169 of file objstrm.h.

References owl::pstream::ptIndexed, and owl::pstream::ptObject.

◆ writeWord()

void owl::opstream::writeWord ( uint32 word32 )

inline

Writes the 32-bit word us to the stream.

Definition at line 740 of file objstrm.h.

References owl::opstream::writeWord32().

Variable Documentation

◆ TStreamable

class _RTTI owl::TStreamable

Definition at line 56 of file objstrm.h.

Classes

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ _OBJ_FULLTYPENAME

◆ _OBJ_TYPENAME

◆ DECLARE_ABSTRACT_STREAMABLE

◆ DECLARE_ABSTRACT_STREAMABLE_OWL

◆ DECLARE_ABSTRACT_STREAMABLE_S

◆ DECLARE_ABSTRACT_STREAMER

◆ DECLARE_ABSTRACT_STREAMERS

◆ DECLARE_CASTABLE

◆ DECLARE_STREAMABLE

◆ DECLARE_STREAMABLE_CTOR

◆ DECLARE_STREAMABLE_FROM_BASE

◆ DECLARE_STREAMABLE_FROM_BASE_OWL

◆ DECLARE_STREAMABLE_FROM_BASE_S

◆ DECLARE_STREAMABLE_INLINES

◆ DECLARE_STREAMABLE_INLINES_I

◆ DECLARE_STREAMABLE_OPS

◆ DECLARE_STREAMABLE_OWL

◆ DECLARE_STREAMABLE_S

◆ DECLARE_STREAMER

◆ DECLARE_STREAMER_FROM_BASE

◆ DECLARE_STREAMER_FROM_BASES

◆ DECLARE_STREAMERS

◆ IMPLEMENT_ABSTRACT_STREAMABLE

◆ IMPLEMENT_ABSTRACT_STREAMABLE1

◆ IMPLEMENT_ABSTRACT_STREAMABLE2

◆ IMPLEMENT_ABSTRACT_STREAMABLE3

◆ IMPLEMENT_ABSTRACT_STREAMABLE4

◆ IMPLEMENT_ABSTRACT_STREAMABLE5

◆ IMPLEMENT_CASTABLE

◆ IMPLEMENT_CASTABLE1

◆ IMPLEMENT_CASTABLE2

◆ IMPLEMENT_CASTABLE3

◆ IMPLEMENT_CASTABLE4

◆ IMPLEMENT_CASTABLE5

◆ IMPLEMENT_STREAMABLE

◆ IMPLEMENT_STREAMABLE1

◆ IMPLEMENT_STREAMABLE2

◆ IMPLEMENT_STREAMABLE3

◆ IMPLEMENT_STREAMABLE4

◆ IMPLEMENT_STREAMABLE5

◆ IMPLEMENT_STREAMABLE_CLASS

◆ IMPLEMENT_STREAMABLE_CTOR

◆ IMPLEMENT_STREAMABLE_CTOR1

◆ IMPLEMENT_STREAMABLE_CTOR1_IMPL

◆ IMPLEMENT_STREAMABLE_CTOR2

◆ IMPLEMENT_STREAMABLE_CTOR3

◆ IMPLEMENT_STREAMABLE_CTOR4

◆ IMPLEMENT_STREAMABLE_CTOR5

◆ IMPLEMENT_STREAMABLE_FROM_BASE

◆ IMPLEMENT_STREAMABLE_POINTER

◆ IMPLEMENT_STREAMABLE_POINTER_IMPL

◆ IMPLEMENT_STREAMER

◆ READBASEOBJECT

◆ READVIRTUALBASE

◆ WRITEBASEOBJECT

◆ WRITEVIRTUALBASE

Typedef Documentation

◆ P_id_type

◆ TGenericTableEntry

Enumeration Type Documentation

◆ StreamableInit

◆ TAutoDelete

Function Documentation

◆ fpbase() [1/3]

◆ fpbase() [2/3]

◆ fpbase() [3/3]

◆ ifpstream() [1/3]

◆ ifpstream() [2/3]

◆ ifpstream() [3/3]

◆ ipstream() [1/2]

◆ ipstream() [2/2]

◆ ofpstream() [1/3]