wns::module::VersionInformation Class Reference

Class to manage version and dependency information. More...

#include <module/VersionInformation.hpp>

Collaboration diagram for wns::module::VersionInformation:

[legend]

List of all members.

Public Member Functions
DepList	getDependencies () const
	Return the dependencies.
std::string	getNiceString () const
	Return version information as human readable string.
std::string	getString () const
	Return version information as string.
Version	getVersion () const
	Return the version.
void	setDependencies (const DepList deps)
	Set the dependencies.
void	setVersion (const Version ver)
	Set the version.
	VersionInformation (const std::string &s)
	String constructor.
	VersionInformation (const Release bRelease, const DepList deps=DepList(), 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.
	VersionInformation (const Version ver, const DepList deps=DepList())
	Version and DepList constructor.
Private Attributes
DepList	dependencies
Version	version
Classes
class	Syntax
	Syntax to extract stuff from VersionInformation. More...

---

Detailed Description

Author:

Swen Kühnlein <swen@comnets.rwth-aachen.de>

Definition at line 38 of file VersionInformation.hpp.

---

Constructor & Destructor Documentation

wns::module::VersionInformation::VersionInformation	(	const Version	ver,
		const DepList	deps = DepList()
	)			[inline, explicit]

Instantiate a VersionInformation object initialized by a Version object and a dependency list.

Parameters:

	ver	the version.
	deps	the dependencies.

Definition at line 51 of file VersionInformation.hpp.

wns::module::VersionInformation::VersionInformation	(	const Release	bRelease,
		const DepList	deps = DepList(),
		const DateTime	bTime = DateTime(),
		const std::string	bUser = "",
		const std::string	bHost = "",
		const std::string	bFlags = "",
		const DateTime	mTime = DateTime(),
		const std::string	mFile = ""
	)			[inline, explicit]

Create a VersionInformation object and initialize with release, dependency list, time, user and host. All parameters except bRelease default to be empty if omitted.

Parameters:

	bRelease	the release.
	deps	the dependencies, defaults to no dependencies (empty list).
	bTime	the build time, default to empty DateTime.
	bUser	the build user, defaults to empty string.
	bHost	the build host, defaults to empty host.
	bFlags	the compiler build flags.
	mTime	the project's modification time.
	mFile	the file that mTime was taken from.

Definition at line 72 of file VersionInformation.hpp.

wns::module::VersionInformation::VersionInformation

(

const std::string &

s

)

[inline, explicit]

Create a VersionInformation object initialized by the content of the given string. The string must be Version "::" DepList.

Parameters:

s

initialization string.

See also:

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

DepList::DepList(const std::string s)

Definition at line 94 of file VersionInformation.hpp.

---

Member Function Documentation

DepList wns::module::VersionInformation::getDependencies

(

)

const [inline]

Definition at line 110 of file VersionInformation.hpp.

string VersionInformation::getNiceString

(

)

const

Note:

May contain newlines!

Definition at line 43 of file VersionInformation.cpp.

string VersionInformation::getString

(

)

const

Definition at line 37 of file VersionInformation.cpp.

Version wns::module::VersionInformation::getVersion

(

)

const [inline]

Definition at line 102 of file VersionInformation.hpp.

void wns::module::VersionInformation::setDependencies

(

const DepList

deps

)

[inline]

Definition at line 126 of file VersionInformation.hpp.

void wns::module::VersionInformation::setVersion

(

const Version

ver

)

[inline]

Definition at line 118 of file VersionInformation.hpp.

---

Member Data Documentation

DepList wns::module::VersionInformation::dependencies [private]

Definition at line 154 of file VersionInformation.hpp.

Version wns::module::VersionInformation::version [private]

Definition at line 153 of file VersionInformation.hpp.

---

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

• framework/library/src/module/VersionInformation.hpp
• framework/library/src/module/VersionInformation.cpp