VR-Forces 5.0.3 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends
DtObjectDB Class Reference

Contains DtObjectDB. Binary archive which can store objects with shared references to each other.

Inheritance diagram for DtObjectDB:
Inheritance graph
[legend]

Public Types

enum  CreateFile { DoNotCreate, Create }
 
enum  EraseExisting { DoNotErase, Erase }
 
typedef boost::shared_ptr
< DtObjectDB
Ptr
 
typedef DtU64 Offset
 

Public Member Functions

virtual ~DtObjectDB ()
 
virtual const DtFilename & filename () const
 
virtual std::auto_ptr< CursormakeCursor (CreateFile, EraseExisting)
 
virtual ~Cursor ()
 
virtual Offset currentOffset () const
 
virtual void setCurrentOffset (Offset offset)
 
virtual bool eof () const
 
virtual bool error () const
 
virtual void flush ()
 
virtual bool readBool ()
 
virtual DtInt32 readInt32 ()
 
virtual DtU32 readUInt32 ()
 
virtual DtU64 readUInt64 ()
 
virtual DtFloat64 readFloat64 ()
 
virtual DtString readString ()
 
virtual DtVector readVector ()
 
virtual void writeBool (bool)
 
virtual void writeInt32 (DtInt32)
 
virtual void writeUInt32 (DtU32)
 
virtual void writeUInt64 (DtU64)
 
virtual void writeFloat64 (DtFloat64)
 
virtual void writeString (const DtString &)
 
virtual void writeVector (const DtVector &)
 

Static Public Member Functions

static Ptr Make (const DtFilename &filename)
 

Protected Member Functions

 DtObjectDB (const DtFilename &filename)
 
 Cursor (const DtObjectDB::Ptr &db, CreateFile, EraseExisting)
 

Protected Attributes

const DtFilename myFilename
 
DtObjectDB::Ptr myDB
 
FILE * myFile
 

Friends

class DtObjectDB
 

Member Typedef Documentation

typedef boost::shared_ptr<DtObjectDB> DtObjectDB::Ptr
typedef DtU64 DtObjectDB::Offset

Member Enumeration Documentation

Flags.

Enumerator
DoNotCreate 
Create 
Enumerator
DoNotErase 
Erase 

Constructor & Destructor Documentation

virtual DtObjectDB::~DtObjectDB ( )
virtual

Virtual destructor.

DtObjectDB::DtObjectDB ( const DtFilename &  filename)
explicitprotected
virtual DtObjectDB::~Cursor ( )
virtual

Virtual destructor.

Member Function Documentation

static Ptr DtObjectDB::Make ( const DtFilename &  filename)
static

Factory function.

virtual const DtFilename& DtObjectDB::filename ( ) const
virtual

Access filename of db.

virtual std::auto_ptr<Cursor> DtObjectDB::makeCursor ( CreateFile  ,
EraseExisting   
)
virtual

Make cursor for reading/writing database.

Parameters
eraseDestroys contents of file if it exists.
virtual Offset DtObjectDB::currentOffset ( ) const
virtual

Return current offset into the db. This can be used to later reposition a reader to read the object. Note this is the offset of the next object that will be written.

virtual void DtObjectDB::setCurrentOffset ( Offset  offset)
virtual

Sets the current offset. The next object written will be written at this offset.

virtual bool DtObjectDB::eof ( ) const
virtual

Check for end of file.

virtual bool DtObjectDB::error ( ) const
virtual

Check for error.

virtual void DtObjectDB::flush ( )
virtual

Flush written data to disk.

virtual bool DtObjectDB::readBool ( )
virtual

Read data from database at current offset.

virtual DtInt32 DtObjectDB::readInt32 ( )
virtual

Read data from database at current offset.

virtual DtU32 DtObjectDB::readUInt32 ( )
virtual

Read data from database at current offset.

virtual DtU64 DtObjectDB::readUInt64 ( )
virtual

Read data from database at current offset.

virtual DtFloat64 DtObjectDB::readFloat64 ( )
virtual

Read data from database at current offset.

virtual DtString DtObjectDB::readString ( )
virtual

Read data from database at current offset.

virtual DtVector DtObjectDB::readVector ( )
virtual

Read data from database at current offset.

virtual void DtObjectDB::writeBool ( bool  )
virtual

Write data into database at current offset.

virtual void DtObjectDB::writeInt32 ( DtInt32  )
virtual

Write data into database at current offset.

virtual void DtObjectDB::writeUInt32 ( DtU32  )
virtual

Write data into database at current offset.

virtual void DtObjectDB::writeUInt64 ( DtU64  )
virtual

Write data into database at current offset.

virtual void DtObjectDB::writeFloat64 ( DtFloat64  )
virtual

Write data into database at current offset.

virtual void DtObjectDB::writeString ( const DtString )
virtual

Write data into database at current offset.

virtual void DtObjectDB::writeVector ( const DtVector )
virtual

Write data into database at current offset.

DtObjectDB::Cursor ( const DtObjectDB::Ptr db,
CreateFile  ,
EraseExisting   
)
explicitprotected

Friends And Related Function Documentation

friend class DtObjectDB
friend

Member Data Documentation

const DtFilename DtObjectDB::myFilename
protected
DtObjectDB::Ptr DtObjectDB::myDB
protected
FILE* DtObjectDB::myFile
protected

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

Document ID: Generated on Thu Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)