cVersion

Wrapper class to work with POD type tVersion. More...

#include <versiontype.h>

Public Types
typedef tVersion::value_type	value_type
	Common value type of version numbers.

Public Member Functions
	cVersion (tVersion sVersion)
	Constructor.
cVersion &	SetMajor (value_type i_nMajor)
	Set major number of the version.
cVersion &	SetMinor (value_type i_nMinor)
	Set minor number of the version.
cVersion &	SetPatch (value_type i_nPatch)
	Set patch number of the version.
cVersion &	SetTweak (value_type i_nTweak)
	Set tweak number of the version.
value_type	GetMajor () const
	Get major number of the version.
value_type	GetMinor () const
	Get minor number of the version.
value_type	GetPatch () const
	Get patch number of the version.
value_type	GetTweak () const
	Get tweak number of the version.
const tVersion &	GetVersion () const
	Get entire version info.
tResult	FromString (const cString &i_strVersion)
	Create the version object from a string.
cString	ToString () const
	Create the string representation of the currently held version information.

Private Attributes
tVersion	m_sVersion
	version type to wrap

Detailed Description

Wrapper class to work with POD type tVersion.

Definition at line 29 of file versiontype.h.

Member Typedef Documentation

value_type

typedef tVersion::value_type value_type

Common value type of version numbers.

Definition at line 32 of file versiontype.h.

Constructor & Destructor Documentation

cVersion()

cVersion

(

tVersion

sVersion

)

Constructor.

Parameters

[in]

sVersion

The version information to use this wrapper with.

Referenced by SetMajor(), SetMinor(), SetPatch(), and SetTweak().

Member Function Documentation

FromString()

tResult FromString

(

const cString &

i_strVersion

)

Create the version object from a string.

Parameters

[in]

i_strVersion

String representation of the version. Must have format "major[.minor[.patch[.tweak]]]"

Returns

Standard error type

Return values

ERR_NOERROR	Everything went fine, version information created from string
ERR_UNKNOWN_FORMAT	String representation of the version could not be recognized

GetMajor()

value_type GetMajor

(

)

const

Get major number of the version.

Returns

Major number

GetMinor()

value_type GetMinor

(

)

const

Get minor number of the version.

Returns

Minor number

GetPatch()

value_type GetPatch

(

)

const

Get patch number of the version.

Returns

Patch number

GetTweak()

value_type GetTweak

(

)

const

Get tweak number of the version.

Returns

Tweak number

GetVersion()

const tVersion & GetVersion

(

)

const

Get entire version info.

Returns

Wrapped version object

SetMajor()

cVersion & SetMajor

(

value_type

i_nMajor

)

Set major number of the version.

Parameters

[in]

i_nMajor

The major number

Returns

*this

References cVersion().

SetMinor()

cVersion & SetMinor

(

value_type

i_nMinor

)

Set minor number of the version.

Parameters

[in]

i_nMinor

The minor number

Returns

*this

References cVersion().

SetPatch()

cVersion & SetPatch

(

value_type

i_nPatch

)

Set patch number of the version.

Parameters

[in]

i_nPatch

The patch number

Returns

*this

References cVersion().

SetTweak()

cVersion & SetTweak

(

value_type

i_nTweak

)

Set tweak number of the version.

Parameters

[in]

i_nTweak

The tweak number

Returns

*this

References cVersion().

ToString()

cString ToString

(

)

const

Create the string representation of the currently held version information.

Returns

String representation of the version in format "major.minor.patch.tweak"

Member Data Documentation

m_sVersion

tVersion m_sVersion

private

version type to wrap

Definition at line 116 of file versiontype.h.