torc::architecture::Versions Class Reference

Encapsulation of database version information. More...

#include <Versions.hpp>

Collaboration diagram for torc::architecture::Versions:

[legend]

List of all members.

Public Member Functions
const DottedVersion &	getFormat (void) const
	Returns the database format version.
uint32_t	getBuild (void) const
	Returns the database build number.
const DottedVersion &	getVendor (void) const
	Returns the vendor data version.
const string &	getVendorString (void) const
	Returns the database format version string.
Protected Types
typedef std::string	string
	Imported type name.
typedef boost::uint8_t	uint8_t
	Imported type name.
typedef boost::uint16_t	uint16_t
	Imported type name.
typedef boost::uint32_t	uint32_t
	Imported type name.
typedef torc::common::DottedVersion	DottedVersion
	Imported type name.
Protected Member Functions
size_t	readVersions (DigestStream &inStream, bool inShowVersion=false)
	Read the version information.
	Versions (void)
	Protected constructor.
Protected Attributes
DottedVersion	mFormat
	The database format version.
uint32_t	mBuild
	The database build number.
DottedVersion	mVendor
	The vendor data version.
string	mVendorString
	The vendor data version string.
Friends
class	DDB
	The database has access to our protected functions.
class	torc::architecture::architecture::DigestStreamUnitTest
	The DigestStream unit test has access to our protected functions.

---

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 36 of file Versions.hpp.

---

Member Typedef Documentation

typedef std::string torc::architecture::Versions::string [protected]

Imported type name.

Definition at line 44 of file Versions.hpp.

typedef boost::uint8_t torc::architecture::Versions::uint8_t [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 46 of file Versions.hpp.

typedef boost::uint32_t torc::architecture::Versions::uint32_t [protected]

Imported type name.

Definition at line 47 of file Versions.hpp.

typedef torc::common::DottedVersion torc::architecture::Versions::DottedVersion [protected]

Imported type name.

Definition at line 48 of file Versions.hpp.

---

Constructor & Destructor Documentation

torc::architecture::Versions::Versions

(

void

)

[inline, protected]

Protected constructor.

Definition at line 65 of file Versions.hpp.

---

Member Function Documentation

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.

const DottedVersion& torc::architecture::Versions::getFormat

(

void

)

const [inline]

Returns the database format version.

Definition at line 69 of file Versions.hpp.

uint32_t torc::architecture::Versions::getBuild

(

void

)

const [inline]

Returns the database build number.

Definition at line 71 of file Versions.hpp.

const DottedVersion& torc::architecture::Versions::getVendor

(

void

)

const [inline]

Returns the vendor data version.

Definition at line 73 of file Versions.hpp.

const string& torc::architecture::Versions::getVendorString

(

void

)

const [inline]

Returns the database format version string.

Definition at line 75 of file Versions.hpp.

---

Friends And Related Function Documentation

friend class DDB [friend]

The database has access to our protected functions.

Definition at line 39 of file Versions.hpp.

friend class torc::architecture::architecture::DigestStreamUnitTest [friend]

The DigestStream unit test has access to our protected functions.

Definition at line 41 of file Versions.hpp.

---

Member Data Documentation

DottedVersion torc::architecture::Versions::mFormat [protected]

The database format version.

Definition at line 53 of file Versions.hpp.

uint32_t torc::architecture::Versions::mBuild [protected]

The database build number.

Definition at line 55 of file Versions.hpp.

DottedVersion torc::architecture::Versions::mVendor [protected]

The vendor data version.

Definition at line 57 of file Versions.hpp.

string torc::architecture::Versions::mVendorString [protected]

The vendor data version string.

Definition at line 59 of file Versions.hpp.

---

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

• torc/architecture/Versions.hpp
• torc/architecture/Versions.cpp