wns::module::Version Class Reference

Class to manage version information. More...

#include <module/Version.hpp>

Collaboration diagram for wns::module::Version:

List of all members.

Public Member Functions

std::string getBuildFlags () const

Return the build flags.

std::string getBuildHost () const

Return the build host.

Release getBuildRelease () const

Return the build release.

DateTime getBuildTime () const

Return the build time.

std::string getBuildUser () const

Return the build user.

DateTime getModificationTime () const

Return the project's modification time.

std::string getModifiedFile () const

Return the file name the modification time was taken from.

std::string getNiceString (bool verbose, std::string offset) const

Get version as a human readable string.

std::string getString () const

Get version as one string.

bool operator!= (const Version b) const

Inequality operator.

bool operator< (const Version b) const

Less operator.

bool operator<= (const Version b) const

Less than or equal to operator.

bool operator== (const Version b) const

Equality operator.

bool operator> (const Version b) const

Greater operator.

bool operator>= (const Version b) const

Greater than or equal to operator.

void setBuildFlags (const std::string bFlags)

Set the build flags.

void setBuildHost (const std::string bHost)

Set the build host.

void setBuildRelease (const Release bRelease)

Set the build release.

void setBuildTime (const DateTime bTime)

Set the build time.

void setBuildUser (const std::string bUser)

Set the build user.

void setModificationTime (const DateTime mTime)

Set the project's modification time.

void setModifiedFile (const std::string mFile)

Set the file name the modification time was taken from.

Version (const std::string s)

Single string constructor.

Version (const Release bRelease, const DateTime bTime=DateTime(), const std::string bUser="", const std::string bHost="", const std::string bFlags="", const DateTime mTime=DateTime(), const std::string mFile="")

Component constructor.

Static Private Member Functions

static std::string cutAt (const std::string s, const std::string pattern, const int n)

static bool stringEqualOrEmpty (const std::string s1, const std::string s2)

Private Attributes

std::string buildFlags

std::string buildHost

Release buildRelease

DateTime buildTime

std::string buildUser

DateTime modificationTime

std::string modifiedFile

Classes

class Syntax

contains methods to extract specific parts of a version string More...

Detailed Description

Author:: Swen K�hnlein <swen@comnets.rwth-aachen.de>

Definition at line 39 of file Version.hpp.

Constructor & Destructor Documentation

wns::module::Version::Version	(	const Release	bRelease,
		const DateTime	bTime = `DateTime()`,
		const std::string	bUser = `""`,
		const std::string	bHost = `""`,
		const std::string	bFlags = `""`,
		const DateTime	mTime = `DateTime()`,
		const std::string	mFile = `""`
	)

This constructor creates a Version instance initialized by the component values given as its parameters.

Parameters:

	bRelease	The release.
	bTime	The build time.
	bUser	The build user.
	bHost	The build host.
	bFlags	The compiler build flags.
	mTime	The project's modification time.
	mFile	The file that mTime was taken from.

wns::module::Version::Version ( const std::string s )

This constructor creates a Version instance initialized by a single string that must be in the same format as returned by getString().

Parameters:

s

initialization string.

See also:: std::string Version::getString()

Member Function Documentation

static std::string wns::module::Version::cutAt	(	const std::string	s,
		const std::string	pattern,
		const int	n
	)			`[static, private]`

string Version::getBuildFlags ( ) const

Definition at line 132 of file Version.cpp.

string Version::getBuildHost ( ) const

Definition at line 121 of file Version.cpp.

wns::module::Release Version::getBuildRelease ( ) const

Definition at line 127 of file Version.cpp.

wns::module::DateTime Version::getBuildTime ( ) const

Definition at line 111 of file Version.cpp.

string Version::getBuildUser ( ) const

Definition at line 116 of file Version.cpp.

wns::module::DateTime Version::getModificationTime ( ) const

Definition at line 138 of file Version.cpp.

string Version::getModifiedFile ( ) const

Definition at line 143 of file Version.cpp.

std::string wns::module::Version::getNiceString	(	bool	verbose,
		std::string	offset
	)			const

Note:: The returned string may contain newlines!

Returns:: eye candied string

string Version::getString ( ) const

Return Version as a string that can be passed as a parameter to the single string constructor. The format of the string is: release "," buildTime "," buildUser "," buildHost "," modificationTime "," modifiedFile Example: msg@comnets.rwth-aachen.de--central/sgoose--nibbler-dev--1.0--patch-123,2004-05-06 12:34,someone,somehost,1091013526,file.cpp

Returns:: Version a a single string.

See also:: Version::Version(std::string s)
DateTime::DateTime(std::string t)

Definition at line 186 of file Version.cpp.

bool Version::operator!= ( const Version b ) const

Definition at line 71 of file Version.cpp.

bool Version::operator< ( const Version b ) const

Definition at line 77 of file Version.cpp.

bool Version::operator<= ( const Version b ) const

Definition at line 96 of file Version.cpp.

bool Version::operator== ( const Version b ) const

Note:: If buildUser or buildHost of this instance or the b instance is empty, they are considered equal. This way people can specify that they don't care about who built it and where. Just leave the fields empty.

Definition at line 63 of file Version.cpp.

bool Version::operator> ( const Version b ) const

Definition at line 90 of file Version.cpp.

bool Version::operator>= ( const Version b ) const

Definition at line 102 of file Version.cpp.

void wns::module::Version::setBuildFlags ( const std::string bFlags )

void wns::module::Version::setBuildHost ( const std::string bHost )

void Version::setBuildRelease ( const Release bRelease )

Definition at line 163 of file Version.cpp.

void Version::setBuildTime ( const DateTime bTime )

Definition at line 148 of file Version.cpp.

void wns::module::Version::setBuildUser ( const std::string bUser )

void Version::setModificationTime ( const DateTime mTime )

Definition at line 173 of file Version.cpp.

void wns::module::Version::setModifiedFile ( const std::string mFile )

static bool wns::module::Version::stringEqualOrEmpty	(	const std::string	s1,
		const std::string	s2
	)			`[inline, static, private]`

Definition at line 192 of file Version.hpp.

Member Data Documentation

std::string wns::module::Version::buildFlags [private]

Definition at line 187 of file Version.hpp.

std::string wns::module::Version::buildHost [private]

Definition at line 186 of file Version.hpp.

Release wns::module::Version::buildRelease [private]

Definition at line 188 of file Version.hpp.

DateTime wns::module::Version::buildTime [private]

Definition at line 184 of file Version.hpp.

std::string wns::module::Version::buildUser [private]

Definition at line 185 of file Version.hpp.

DateTime wns::module::Version::modificationTime [private]

Definition at line 189 of file Version.hpp.

std::string wns::module::Version::modifiedFile [private]

Definition at line 190 of file Version.hpp.

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

framework/library/src/module/Version.hpp
framework/library/src/module/Version.cpp


Public Member Functions
std::string	getBuildFlags () const
	Return the build flags.
std::string	getBuildHost () const
	Return the build host.
Release	getBuildRelease () const
	Return the build release.
DateTime	getBuildTime () const
	Return the build time.
std::string	getBuildUser () const
	Return the build user.
DateTime	getModificationTime () const
	Return the project's modification time.
std::string	getModifiedFile () const
	Return the file name the modification time was taken from.
std::string	getNiceString (bool verbose, std::string offset) const
	Get version as a human readable string.
std::string	getString () const
	Get version as one string.
bool	operator!= (const Version b) const
	Inequality operator.
bool	operator< (const Version b) const
	Less operator.
bool	operator<= (const Version b) const
	Less than or equal to operator.
bool	operator== (const Version b) const
	Equality operator.
bool	operator> (const Version b) const
	Greater operator.
bool	operator>= (const Version b) const
	Greater than or equal to operator.
void	setBuildFlags (const std::string bFlags)
	Set the build flags.
void	setBuildHost (const std::string bHost)
	Set the build host.
void	setBuildRelease (const Release bRelease)
	Set the build release.
void	setBuildTime (const DateTime bTime)
	Set the build time.
void	setBuildUser (const std::string bUser)
	Set the build user.
void	setModificationTime (const DateTime mTime)
	Set the project's modification time.
void	setModifiedFile (const std::string mFile)
	Set the file name the modification time was taken from.
	Version (const std::string s)
	Single string constructor.
	Version (const Release bRelease, const DateTime bTime=DateTime(), const std::string bUser="", const std::string bHost="", const std::string bFlags="", const DateTime mTime=DateTime(), const std::string mFile="")
	Component constructor.
Static Private Member Functions
static std::string	cutAt (const std::string s, const std::string pattern, const int n)
static bool	stringEqualOrEmpty (const std::string s1, const std::string s2)
Private Attributes
std::string	buildFlags
std::string	buildHost
Release	buildRelease
DateTime	buildTime
std::string	buildUser
DateTime	modificationTime
std::string	modifiedFile
Classes
class	Syntax
	contains methods to extract specific parts of a version string More...