PLCore::Version Class Reference

Version class. More...

#include <Version.h>

List of all members.

Public Member Functions
PLCORE_API	Version ()
	Constructor.
PLCORE_API	Version (const String &sName, const String &sCodename, uint16 nMajor, uint16 nMinor, uint16 nPatch, const String &sRelease)
	Constructor.
	~Version ()
	Destructor.
String	GetName () const
	Get project name.
void	SetName (const String &sName)
	Set project name.
String	GetCodename () const
	Get codename.
void	SetCodename (const String &sCodename)
	Set codename.
uint16	GetMajor () const
	Get major version number.
void	SetMajor (uint16 nMajor)
	Set major version number.
uint16	GetMinor () const
	Get minor version number.
void	SetMinor (uint16 nMinor)
	Set minor version number.
uint16	GetPatch () const
	Get patch number.
void	SetPatch (uint16 nPatch)
	Set patch number.
String	GetRelease () const
	Get release name.
void	SetRelease (const String &sRelease)
	Set release name.
PLCORE_API String	ToString () const
	Returns a string representation of the version.
PLCORE_API bool	operator== (const Version &cVersion) const
PLCORE_API bool	operator!= (const Version &cVersion) const
PLCORE_API bool	operator< (const Version &cVersion) const
PLCORE_API bool	operator> (const Version &cVersion) const
PLCORE_API bool	operator<= (const Version &cVersion) const
PLCORE_API bool	operator>= (const Version &cVersion) const

---

Detailed Description

Version class.

---

Constructor & Destructor Documentation

PLCORE_API PLCore::Version::Version

(

)

Constructor.

PLCORE_API PLCore::Version::Version	(	const String &	sName,
		const String &	sCodename,
		uint16	nMajor,
		uint16	nMinor,
		uint16	nPatch,
		const String &	sRelease
	)

Constructor.

Parameters:

[in]	sName	Project name
[in]	sCodename	Code name for this release
[in]	nMajor	Major version number
[in]	nMinor	Minor version number
[in]	nPatch	Patch number
[in]	sRelease	Release name (e.g. "r1" for release #1, "rc1" for release candidate #1, "nightly-date" for a nightly build etc.)

PLCore::Version::~Version

(

)

[inline]

Destructor.

---

Member Function Documentation

String PLCore::Version::GetName

(

)

const [inline]

Get project name.

Returns:

Name of the project

void PLCore::Version::SetName

(

const String &

sName

)

[inline]

Set project name.

Parameters:

[in]

sName

Name of the project

String PLCore::Version::GetCodename

(

)

const [inline]

Get codename.

Returns:

Codename of the release

void PLCore::Version::SetCodename

(

const String &

sCodename

)

[inline]

Set codename.

Parameters:

[in]

sCodename

Codename of the release

uint16 PLCore::Version::GetMajor

(

)

const [inline]

Get major version number.

Returns:

Major version

void PLCore::Version::SetMajor

(

uint16

nMajor

)

[inline]

Set major version number.

Parameters:

[in]

nMajor

Major version

uint16 PLCore::Version::GetMinor

(

)

const [inline]

Get minor version number.

Returns:

Minor version

void PLCore::Version::SetMinor

(

uint16

nMinor

)

[inline]

Set minor version number.

Parameters:

[in]

nMinor

Minor version

uint16 PLCore::Version::GetPatch

(

)

const [inline]

Get patch number.

Returns:

Patch number

void PLCore::Version::SetPatch

(

uint16

nPatch

)

[inline]

Set patch number.

Parameters:

[in]

nPatch

Patch number

String PLCore::Version::GetRelease

(

)

const [inline]

Get release name.

Returns:

Release name

void PLCore::Version::SetRelease

(

const String &

sRelease

)

[inline]

Set release name.

Parameters:

[in]

sRelease

Release name

PLCORE_API String PLCore::Version::ToString

(

)

const

Returns a string representation of the version.

Returns:

String representation (for example: FooBar 1.0.1-rc5 - Bulky Bug)

PLCORE_API bool PLCore::Version::operator==

(

const Version &

cVersion

)

const

PLCORE_API bool PLCore::Version::operator!=

(

const Version &

cVersion

)

const

PLCORE_API bool PLCore::Version::operator<

(

const Version &

cVersion

)

const

PLCORE_API bool PLCore::Version::operator>

(

const Version &

cVersion

)

const

PLCORE_API bool PLCore::Version::operator<=

(

const Version &

cVersion

)

const

PLCORE_API bool PLCore::Version::operator>=

(

const Version &

cVersion

)

const

---

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

• Version.h
• Version.inl