JEEP::JVersion Struct Reference

Auxiliary data structure for I/O of version number. More...

#include <JVersion.hh>

Inheritance diagram for JEEP::JVersion:

Public Member Functions
	JVersion ()
	Default constructor. More...
	JVersion (const int major, const int minor, const int patch)
	Constructor. More...
int	getMajorVersion () const
	Get major version. More...
int	getMinorVersion () const
	Get minor version. More...
int	getPatchVersion () const
	Get patch version. More...
bool	less (const JVersion &object) const
	Compare database API version. More...

Static Public Attributes
static const char	SEPARATOR = '.'

Protected Attributes
unsigned int	majorVersion
	API major version. More...
unsigned int	minorVersion
	API minor version. More...
unsigned int	patchVersion
	API patch version. More...

Friends
std::istream &	operator>> (std::istream &in, JVersion &object)
	Read in 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 I/O of version number.

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

Constructor & Destructor Documentation

JEEP::JVersion::JVersion ( )

inline

Default constructor.

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

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

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

inline

Constructor.

Parameters

major	major version
minor	minor version
patch	patch version

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

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

Member Function Documentation

int JEEP::JVersion::getMajorVersion ( ) const

inline

Get major version.

Returns

major version.

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

    {
      return majorVersion;
    }

int JEEP::JVersion::getMinorVersion ( ) const

inline

Get minor version.

Returns

minor version.

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

    {
      return minorVersion;
    }

int JEEP::JVersion::getPatchVersion ( ) const

inline

Get patch version.

Returns

patch version.

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

    {
      return patchVersion;
    }

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

inline

Compare database API version.

Parameters

object

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

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

    {
      if (this->majorVersion == object.majorVersion) {

        if (this->minorVersion == object.minorVersion) {

          return this->patchVersion < object.patchVersion;
          
        } else {

          return this->minorVersion < object.minorVersion;
        }
        
      } else {
        
        return this->majorVersion < object.majorVersion;
      }
    }

Friends And Related Function Documentation

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

friend

Read in version from input stream.

Parameters

in	input stream
object	database API version

Returns

input stream

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

    {
      using namespace std;

      unsigned int 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;
    }

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

friend

Write version to output stream.

Parameters

out	output stream
object	database API version

Returns

output stream

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

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

Member Data Documentation

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

static

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

unsigned int JEEP::JVersion::majorVersion

protected

API major version.

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

unsigned int JEEP::JVersion::minorVersion

protected

API minor version.

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

unsigned int JEEP::JVersion::patchVersion

protected

API patch version.

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

---

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

• Jeep/JVersion.hh