JEEP::JVersion Struct Reference

Auxiliary data structure for general purpose version number. More...

#include <JVersion.hh>

Inheritance diagram for JEEP::JVersion:

Public Types
typedef unsigned int	version_type
	Type definition of [sub-]versions. More...

Public Member Functions
	JVersion ()
	Default constructor. More...
	JVersion (const version_type major, const version_type minor, const version_type patch)
	Constructor. More...
	JVersion (const std::string &version)
	Constructor. More...
version_type	getMajorVersion () const
	Get major version. More...
version_type	getMinorVersion () const
	Get minor version. More...
version_type	getPatchVersion () const
	Get patch version. More...
bool	less (const JVersion &version) const
	Compare version. More...
std::string	toString () const
	Convert version to string. More...

Static Public Attributes
static const char	SEPARATOR = '.'
	Separator between [sub-]versions. More...

Protected Attributes
version_type	majorVersion
	major version More...
version_type	minorVersion
	minor version More...
version_type	patchVersion
	patch version More...

Friends
std::istream &	operator>> (std::istream &in, JVersion &object)
	Read version from input stream. More...
std::ostream &	operator<< (std::ostream &out, const JVersion &object)
	Write version to output stream. More...

Detailed Description

Auxiliary data structure for general purpose version number.

A version consists of a major, minor and patch number.
The I/O format is <major>.<minor>.<patch>.

Definition at line 28 of file Jeep/JVersion.hh.

Member Typedef Documentation

version_type

typedef unsigned int JEEP::JVersion::version_type

Type definition of [sub-]versions.

Definition at line 34 of file Jeep/JVersion.hh.

Constructor & Destructor Documentation

JVersion() [1/3]

JEEP::JVersion::JVersion ( )

inline

Default constructor.

Definition at line 46 of file Jeep/JVersion.hh.

               :
      majorVersion(0),
      minorVersion(0),
      patchVersion(0)
    {}

JVersion() [2/3]

JEEP::JVersion::JVersion ( const version_type  major, const version_type  minor, const version_type  patch  )

inline

Constructor.

Parameters

major	major version
minor	minor version
patch	patch version

Definition at line 60 of file Jeep/JVersion.hh.

                                       :
      majorVersion(major),
      minorVersion(minor),
      patchVersion(patch)
    {}

JVersion() [3/3]

JEEP::JVersion::JVersion ( const std::string &  version )

inline

Constructor.

Parameters

version

version

Definition at line 74 of file Jeep/JVersion.hh.

                                       :
      majorVersion(0),
      minorVersion(0),
      patchVersion(0)
    {
      std::istringstream is(version);
 
      is >> *this;
    }

Member Function Documentation

getMajorVersion()

version_type JEEP::JVersion::getMajorVersion ( ) const

inline

Get major version.

Returns

major version.

Definition at line 90 of file Jeep/JVersion.hh.

    {
      return majorVersion;
    }

getMinorVersion()

version_type JEEP::JVersion::getMinorVersion ( ) const

inline

Get minor version.

Returns

minor version.

Definition at line 101 of file Jeep/JVersion.hh.

    {
      return minorVersion;
    }

getPatchVersion()

version_type JEEP::JVersion::getPatchVersion ( ) const

inline

Get patch version.

Returns

patch version.

Definition at line 112 of file Jeep/JVersion.hh.

    {
      return patchVersion;
    }

less()

bool JEEP::JVersion::less ( const JVersion &  version ) const

inline

Compare version.

Parameters

version

version

Returns

true if this version is less than given version; else false

Definition at line 124 of file Jeep/JVersion.hh.

    {
      if (this->majorVersion == version.majorVersion) {
 
        if (this->minorVersion == version.minorVersion) {
 
          return this->patchVersion < version.patchVersion;
          
        } else {
 
          return this->minorVersion < version.minorVersion;
        }
        
      } else {
        
        return this->majorVersion < version.majorVersion;
      }
    }

toString()

std::string JEEP::JVersion::toString ( ) const

inline

Convert version to string.

Returns

string

Definition at line 149 of file Jeep/JVersion.hh.

    {
      std::ostringstream os;
 
      os << *this;
 
      return os.str();
    }

Friends And Related Function Documentation

operator>>

std::istream& operator>> ( std::istream &  in, JVersion &  object  )

friend

Read version from input stream.

Parameters

in	input stream
object	version

Returns

input stream

Definition at line 166 of file Jeep/JVersion.hh.

    {
      using namespace std;
 
      version_type version;
 
      if (in >> version) {
        object.majorVersion = version;
      } else {
        in.setstate(ios::failbit);
      }
 
      if ((in.peek() == (int) JVersion::SEPARATOR) && (in.ignore() && in >> version)) {
        object.minorVersion = version;
      } else {
        in.setstate(ios::failbit);
      }
 
      if ((in.peek() == (int) JVersion::SEPARATOR) && (in.ignore() && in >> version)) {
        object.patchVersion = version;
      } else {
        in.setstate(ios::failbit);
      }
 
      return in;
    }

operator<<

std::ostream& operator<< ( std::ostream &  out, const JVersion &  object  )

friend

Write version to output stream.

Parameters

out	output stream
object	version

Returns

output stream

Definition at line 201 of file Jeep/JVersion.hh.

    {
      return out <<
        object.majorVersion << JVersion::SEPARATOR <<
        object.minorVersion << JVersion::SEPARATOR <<
        object.patchVersion;
    }

Member Data Documentation

SEPARATOR

const char JEEP::JVersion::SEPARATOR = '.'

static

Separator between [sub-]versions.

Definition at line 40 of file Jeep/JVersion.hh.

majorVersion

version_type JEEP::JVersion::majorVersion

protected

major version

Definition at line 211 of file Jeep/JVersion.hh.

minorVersion

version_type JEEP::JVersion::minorVersion

protected

minor version

Definition at line 212 of file Jeep/JVersion.hh.

patchVersion

version_type JEEP::JVersion::patchVersion

protected

patch version

Definition at line 213 of file Jeep/JVersion.hh.

---

The documentation for this struct was generated from the following file:

• Jeep/JVersion.hh