DtObjectDB Class Reference

Contains DtObjectDB. More...

Inheritance diagram for DtObjectDB:

Public Types
enum	CreateFile { DoNotCreate, Create }
	Flags. More...
enum	EraseExisting { DoNotErase, Erase }
typedef boost::shared_ptr < DtObjectDB >	Ptr
typedef DtU64	Offset

Public Member Functions
virtual	~DtObjectDB ()
	Virtual destructor.
virtual const DtFilename &	filename () const
	Access filename of db.
virtual std::auto_ptr< Cursor >	makeCursor (CreateFile, EraseExisting)
	Make cursor for reading/writing database.
virtual	~Cursor ()
	Virtual destructor.
virtual Offset	currentOffset () const
	Return current offset into the db.
virtual void	setCurrentOffset (Offset offset)
	Sets the current offset.
virtual bool	eof () const
	Check for end of file.
virtual bool	error () const
	Check for error.
virtual void	flush ()
	Flush written data to disk.
virtual bool	readBool ()
	Read data from database at current offset.
virtual DtInt32	readInt32 ()
virtual DtU32	readUInt32 ()
virtual DtU64	readUInt64 ()
virtual DtFloat64	readFloat64 ()
virtual DtString	readString ()
virtual DtVector	readVector ()
virtual void	writeBool (bool)
	Write data into database at current offset.
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)
	Factory function.

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

Detailed Description

Contains DtObjectDB.

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

Member Typedef Documentation

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

typedef DtU64 DtObjectDB::Offset

Member Enumeration Documentation

enum DtObjectDB::CreateFile

Flags.

Enumerator:

DoNotCreate
Create

enum DtObjectDB::EraseExisting

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

erase

Destroys 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

virtual DtU32 DtObjectDB::readUInt32 ( )

virtual

virtual DtU64 DtObjectDB::readUInt64 ( )

virtual

virtual DtFloat64 DtObjectDB::readFloat64 ( )

virtual

virtual DtString DtObjectDB::readString ( )

virtual

virtual DtVector DtObjectDB::readVector ( )

virtual

virtual void DtObjectDB::writeBool ( bool  )

virtual

Write data into database at current offset.

virtual void DtObjectDB::writeInt32 ( DtInt32  )

virtual

virtual void DtObjectDB::writeUInt32 ( DtU32  )

virtual

virtual void DtObjectDB::writeUInt64 ( DtU64  )

virtual

virtual void DtObjectDB::writeFloat64 ( DtFloat64  )

virtual

virtual void DtObjectDB::writeString ( const DtString &  )

virtual

virtual void DtObjectDB::writeVector ( const DtVector &  )

virtual

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/objectDB.h