Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

VersionInfo Class Reference

#include <VersionInfo.h>

List of all members.

Detailed Description

Class for holding version information on a library. (Members capitalized because g++ has issues with members named major and minor.)


Public Member Functions

 VersionInfo (unsigned int maj, unsigned int min, unsigned int rel, std::string ext="")
 Constructor for VersionInfo.

std::string GetString () const
 Get std::string representing version number.

bool operator< (const VersionInfo &rhs) const
 Less than operator overload for comparing VersionInfo.

bool operator== (const VersionInfo &rhs) const
 Equals to operator overload for comparing VersionInfo.

bool operator> (const VersionInfo &rhs) const
 Greater than operator overload for comparing VersionInfo.


Public Attributes

unsigned int Major
 Major version number.

unsigned int Minor
 Minor version number, changes upon signifigant releases. (Often upon compatibility breaks.).

unsigned int Release
 Version release number, changes on every release.

std::string Extra
 String Description of release. (Often blank.).

Constructor & Destructor Documentation

VersionInfo::VersionInfo (  unsigned int  maj,
unsigned int  min,
unsigned int  rel,
std::string  ext = ""
) 
 

Simple constructor for version info, with a parameter for each member.

Parameters:
maj Major version number.
min Minor version number.
rel Version release number.
ext Extra info std::string, optional (defaults to empty std::string).

Member Function Documentation

std::string VersionInfo::GetString (   )  const
 

Get dotted version number major.minor.release [extra].

Returns:
Formatted version std::string.

bool VersionInfo::operator< (  const VersionInfo &  rhs  )  const
 

Overload of the less than (<) operator for two VersionInfos.

Parameters:
rhs Right hand side of comparison.
Returns:
true if less than, false if greater than or equal to.

bool VersionInfo::operator== (  const VersionInfo &  rhs  )  const
 

Overload of the equals to (==) operator for two VersionInfos.

Parameters:
rhs Right hand side of comparison.
Returns:
true if equal to, false if not equals to.

bool VersionInfo::operator> (  const VersionInfo &  rhs  )  const
 

Overload of the greater than (>) operator for two VersionInfos.

Parameters:
rhs Right hand side of comparison.
Returns:
true if greater than, false if less than or equal to.

The documentation for this class was generated from the following files:
Generated on Sun Oct 5 19:34:45 2003 for ZEngine by doxygen1.3