torc::architecture::Versions Class Reference

Encapsulation of database version information. More...

#include <Versions.hpp>

Inheritance diagram for torc::architecture::Versions:

Collaboration diagram for torc::architecture::Versions:

Public Member Functions
const DottedVersion &	getFormat (void) const
	Returns the database format version. More...
uint32_t	getBuild (void) const
	Returns the database build number. More...
const DottedVersion &	getVendor (void) const
	Returns the vendor data version. More...
const string &	getVendorString (void) const
	Returns the database format version string. More...

Protected Types
typedef std::string	string
	Imported type name. More...
typedef boost::uint8_t	uint8_t
	Imported type name. More...
typedef boost::uint16_t	uint16_t
	Imported type name. More...
typedef boost::uint32_t	uint32_t
	Imported type name. More...
typedef torc::common::DottedVersion	DottedVersion
	Imported type name. More...

Protected Member Functions
size_t	readVersions (DigestStream &inStream, bool inShowVersion=false)
	Read the version information. More...
	Versions (void)
	Protected constructor. More...

Protected Attributes
DottedVersion	mFormat
	The database format version. More...
uint32_t	mBuild
	The database build number. More...
DottedVersion	mVendor
	The vendor data version. More...
string	mVendorString
	The vendor data version string. More...

Private Types
typedef std::basic_istream< char >	istream
	Internal typedef of istream;. More...
typedef std::basic_ostream< char >	ostream
	Internal typedef of ostream;. More...

Private Member Functions
istream &	mIn (void)
	Returns the database console input stream. More...
ostream &	mOut (void)
	Returns the database console output stream. More...
ostream &	mErr (void)
	Returns the database console error stream. More...
ostream &	mLog (void)
	Returns the database console log stream. More...
istream &	getConsoleIn (void)
	Returns the database console input stream. More...
ostream &	getConsoleOut (void)
	Returns the database console output stream. More...
ostream &	getConsoleErr (void)
	Returns the database console error stream. More...
ostream &	getConsoleLog (void)
	Returns the database console log stream. More...
void	setConsoleIn (istream &inStream)
	Sets the database console input stream. More...
void	setConsoleOut (ostream &inStream)
	Sets the database console output stream. More...
void	setConsoleErr (ostream &inStream)
	Sets the database console error stream. More...
void	setConsoleLog (ostream &inStream)
	Sets the database console log stream. More...
virtual void	setConsoleStreams (istream &inIn, ostream &inOut, ostream &inErr, ostream &inLog)
	Sets all of the database console streams. More...

Private Attributes
istream *	mInPtr
	Pointer to the database console input stream. More...
ostream *	mOutPtr
ostream *	mErrPtr
ostream *	mLogPtr

Static Private Attributes
static DDBConsoleStreams	sDefaultConsoleStreams
static DDBConsoleStreams	sNullConsoleStreams

Friends
class	DDB
	The database has access to our protected functions. More...
class	torc::architecture::architecture::DigestStreamUnitTest
	The DigestStream unit test has access to our protected functions. More...

Detailed Description

Encapsulation of database version information.

The format version information determines if and how DDB should read the database. The vendor vesion information indicates the version of the vendor tools that the database was generated from.

Definition at line 37 of file Versions.hpp.

Member Typedef Documentation

typedef torc::common::DottedVersion torc::architecture::Versions::DottedVersion

protected

Imported type name.

Definition at line 49 of file Versions.hpp.

typedef std::basic_istream<char> torc::architecture::DDBConsoleStreams::istream

inherited

Internal typedef of istream;.

Definition at line 41 of file DDBConsoleStreams.hpp.

typedef std::basic_ostream<char> torc::architecture::DDBConsoleStreams::ostream

inherited

Internal typedef of ostream;.

Definition at line 43 of file DDBConsoleStreams.hpp.

typedef std::string torc::architecture::Versions::string

protected

Imported type name.

Definition at line 45 of file Versions.hpp.

typedef boost::uint16_t torc::architecture::Versions::uint16_t

protected

Imported type name.

Definition at line 47 of file Versions.hpp.

typedef boost::uint32_t torc::architecture::Versions::uint32_t

protected

Imported type name.

Definition at line 48 of file Versions.hpp.

typedef boost::uint8_t torc::architecture::Versions::uint8_t

protected

Imported type name.

Definition at line 46 of file Versions.hpp.

Constructor & Destructor Documentation

torc::architecture::Versions::Versions ( void  )

inlineprotected

Protected constructor.

Definition at line 66 of file Versions.hpp.

: mFormat(), mBuild(0), mVendor(), mVendorString() {}

Member Function Documentation

uint32_t torc::architecture::Versions::getBuild ( void  ) const

inline

Returns the database build number.

Definition at line 72 of file Versions.hpp.

{ return mBuild; }

ostream& torc::architecture::DDBConsoleStreams::getConsoleErr ( void  )

inlineinherited

Returns the database console error stream.

Definition at line 69 of file DDBConsoleStreams.hpp.

{ return mErr(); }

Here is the call graph for this function:

istream& torc::architecture::DDBConsoleStreams::getConsoleIn ( void  )

inlineinherited

Returns the database console input stream.

Definition at line 65 of file DDBConsoleStreams.hpp.

{ return mIn(); }

Here is the call graph for this function:

ostream& torc::architecture::DDBConsoleStreams::getConsoleLog ( void  )

inlineinherited

Returns the database console log stream.

Definition at line 71 of file DDBConsoleStreams.hpp.

{ return mLog(); }

Here is the call graph for this function:

ostream& torc::architecture::DDBConsoleStreams::getConsoleOut ( void  )

inlineinherited

Returns the database console output stream.

Definition at line 67 of file DDBConsoleStreams.hpp.

{ return mOut(); }

Here is the call graph for this function:

const DottedVersion& torc::architecture::Versions::getFormat ( void  ) const

inline

Returns the database format version.

Definition at line 70 of file Versions.hpp.

{ return mFormat; }

Here is the caller graph for this function:

const DottedVersion& torc::architecture::Versions::getVendor ( void  ) const

inline

Returns the vendor data version.

Definition at line 74 of file Versions.hpp.

{ return mVendor; }

const string& torc::architecture::Versions::getVendorString ( void  ) const

inline

Returns the database format version string.

Definition at line 76 of file Versions.hpp.

{ return mVendorString; }

ostream& torc::architecture::DDBConsoleStreams::mErr ( void  )

inlineinherited

Returns the database console error stream.

Definition at line 61 of file DDBConsoleStreams.hpp.

{ return *mErrPtr; }

Here is the caller graph for this function:

istream& torc::architecture::DDBConsoleStreams::mIn ( void  )

inlineinherited

Returns the database console input stream.

Definition at line 57 of file DDBConsoleStreams.hpp.

{ return *mInPtr; }

Here is the caller graph for this function:

ostream& torc::architecture::DDBConsoleStreams::mLog ( void  )

inlineinherited

Returns the database console log stream.

Definition at line 63 of file DDBConsoleStreams.hpp.

{ return *mLogPtr; }

Here is the caller graph for this function:

ostream& torc::architecture::DDBConsoleStreams::mOut ( void  )

inlineinherited

Returns the database console output stream.

Definition at line 59 of file DDBConsoleStreams.hpp.

{ return *mOutPtr; }

Here is the caller graph for this function:

size_t torc::architecture::Versions::readVersions ( DigestStream &  inStream, bool  inShowVersion = false  )

protected

Read the version information.

Todo:

Throw a proper exception.

Todo:

Throw a proper exception.

Definition at line 25 of file Versions.cpp.

                                                                            {
        // prepare to read from the stream
        size_t bytesReadOffset = inStream.getBytesRead();
        char scratch[1 << 10];          // scratch read buffer
        uint16_t nameLength = 0;        // length of tile type name

        // read the "TORC" magic
        std::string torc("TORC");
        inStream.read(scratch, 4);
        scratch[4] = 0;
        if(!(torc == scratch)) {
            mErr() << "This is not a valid Torc database.  Magic \"" << scratch 
                << "\" does not match expected \"" << torc << "\"." << std::endl;
            return 0;
        }

        // read the database Versions information
        inStream.read(mFormat.mMajor);
        inStream.read(mFormat.mMinor);
        inStream.read(mFormat.mRevision);
        inStream.read(mFormat.mReserved);
        // read the database build number
        inStream.read(mBuild);

        // if the database version we just read isn't one that we support, we should throw an 
        // exception and/or return now

        // read the section header
        std::string versionHeader;
        inStream.readSectionHeader(versionHeader);
        /// \todo Throw a proper exception.
        if(versionHeader != ">>>>Version >>>>") throw -1;

        // read the vendor Versions information
        inStream.read(mVendor.mMajor);
        inStream.read(mVendor.mMinor);
        inStream.read(mVendor.mRevision);
        inStream.read(mVendor.mReserved);
        // read the vendor Versions string
        inStream.read(nameLength);
        /// \todo Throw a proper exception.
        if(nameLength > sizeof(scratch)) throw -1;
        inStream.read(scratch, nameLength);
        scratch[nameLength] = 0;
        mVendorString = scratch;
        
        if(inShowVersion) mOut() << "\tDatabase " << static_cast<uint32_t>(mFormat.mMajor) 
            << "." << static_cast<uint32_t>(mFormat.mMinor) << "." 
            << static_cast<uint32_t>(mFormat.mRevision) << " build " << mBuild << ", Vendor "
            //<< static_cast<uint32_t>(mVendor.mMajor) << "." 
            //<< static_cast<uint32_t>(mVendor.mMinor) << "." 
            //<< static_cast<uint32_t>(mVendor.mRevision) 
            << '"' << mVendorString << '"' << std::endl;

        // return the number of bytes read
        return inStream.getBytesRead() - bytesReadOffset;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void torc::architecture::DDBConsoleStreams::setConsoleErr ( ostream &  inStream )

inlineinherited

Sets the database console error stream.

Definition at line 77 of file DDBConsoleStreams.hpp.

{ mErrPtr = &inStream; }

Here is the caller graph for this function:

void torc::architecture::DDBConsoleStreams::setConsoleIn ( istream &  inStream )

inlineinherited

Sets the database console input stream.

Definition at line 73 of file DDBConsoleStreams.hpp.

{ mInPtr = &inStream; }

Here is the caller graph for this function:

void torc::architecture::DDBConsoleStreams::setConsoleLog ( ostream &  inStream )

inlineinherited

Sets the database console log stream.

Definition at line 79 of file DDBConsoleStreams.hpp.

{ mLogPtr = &inStream; }

Here is the caller graph for this function:

void torc::architecture::DDBConsoleStreams::setConsoleOut ( ostream &  inStream )

inlineinherited

Sets the database console output stream.

Definition at line 75 of file DDBConsoleStreams.hpp.

{ mOutPtr = &inStream; }

Here is the caller graph for this function:

virtual void torc::architecture::DDBConsoleStreams::setConsoleStreams ( istream &  inIn, ostream &  inOut, ostream &  inErr, ostream &  inLog  )

inlinevirtualinherited

Sets all of the database console streams.

Parameters

inIn	The console input stream.
inOut	The console output stream.
inErr	The console error stream.
inLog	The console log stream.

Reimplemented in torc::architecture::DDB.

Definition at line 85 of file DDBConsoleStreams.hpp.

                            { 
            setConsoleIn(inIn);
            setConsoleOut(inOut);
            setConsoleErr(inErr); 
            setConsoleLog(inLog);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

friend class DDB

friend

The database has access to our protected functions.

Definition at line 40 of file Versions.hpp.

friend class torc::architecture::architecture::DigestStreamUnitTest

friend

The DigestStream unit test has access to our protected functions.

Definition at line 42 of file Versions.hpp.

Field Documentation

uint32_t torc::architecture::Versions::mBuild

protected

The database build number.

Definition at line 56 of file Versions.hpp.

ostream* torc::architecture::DDBConsoleStreams::mErrPtr

protectedinherited

Definition at line 96 of file DDBConsoleStreams.hpp.

DottedVersion torc::architecture::Versions::mFormat

protected

The database format version.

Definition at line 54 of file Versions.hpp.

istream* torc::architecture::DDBConsoleStreams::mInPtr

protectedinherited

Pointer to the database console input stream.

Definition at line 94 of file DDBConsoleStreams.hpp.

ostream* torc::architecture::DDBConsoleStreams::mLogPtr

protectedinherited

Definition at line 97 of file DDBConsoleStreams.hpp.

ostream* torc::architecture::DDBConsoleStreams::mOutPtr

protectedinherited

Definition at line 95 of file DDBConsoleStreams.hpp.

DottedVersion torc::architecture::Versions::mVendor

protected

The vendor data version.

Definition at line 58 of file Versions.hpp.

string torc::architecture::Versions::mVendorString

protected

The vendor data version string.

Definition at line 60 of file Versions.hpp.

DDBConsoleStreams torc::architecture::DDBConsoleStreams::sDefaultConsoleStreams

staticinherited

Definition at line 45 of file DDBConsoleStreams.hpp.

DDBConsoleStreams torc::architecture::DDBConsoleStreams::sNullConsoleStreams

staticinherited

Definition at line 46 of file DDBConsoleStreams.hpp.

---

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

• Versions.hpp
• Versions.cpp