JDATABASE::JDBAPIVersion Struct Reference

Auxiliary data structure for I/O of database API versions. More...

#include <JDBSupportkit.hh>

Inheritance diagram for JDATABASE::JDBAPIVersion:

Public Member Functions
	JDBAPIVersion ()
	Default constructor. More...
	JDBAPIVersion (const int major, const int minor, const int patch)
	Constructor. More...
bool	is_valid () const
	Check validity. 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...

Detailed Description

Auxiliary data structure for I/O of database API versions.

Definition at line 135 of file JDBSupportkit.hh.

Constructor & Destructor Documentation

JDATABASE::JDBAPIVersion::JDBAPIVersion ( )

inline

Default constructor.

Definition at line 142 of file JDBSupportkit.hh.

                    :
      JVersion()
    {}

JDATABASE::JDBAPIVersion::JDBAPIVersion ( const int  major, const int  minor, const int  patch  )

inline

Constructor.

Parameters

major	major version
minor	minor version
patch	patch version

Definition at line 154 of file JDBSupportkit.hh.

                                   :
      JVersion(major, minor, patch)
    {}

Member Function Documentation

bool JDATABASE::JDBAPIVersion::is_valid ( ) const

inline

Check validity.

Returns

true if valid; else false

Definition at line 166 of file JDBSupportkit.hh.

    {
      using namespace std;

      static const set<JVersion> versions{ JVersion(1, 0, 0),
                                           JVersion(2, 0, 0) };
      
      for (set<JVersion>::const_iterator i = versions.cbegin(); i != versions.cend(); ++i) {
        
        if (i->getMajorVersion() == this->getMajorVersion() &&
            i->getMinorVersion() == this->getMinorVersion() &&
            i->getPatchVersion() == this->getPatchVersion()) {
          
          return true;
        } 
      }

      return false;
    }

int JEEP::JVersion::getMajorVersion ( ) const

inlineinherited

Get major version.

Returns

major version.

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

    {
      return majorVersion;
    }

int JEEP::JVersion::getMinorVersion ( ) const

inlineinherited

Get minor version.

Returns

minor version.

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

    {
      return minorVersion;
    }

int JEEP::JVersion::getPatchVersion ( ) const

inlineinherited

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

inlineinherited

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

Member Data Documentation

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

staticinherited

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

unsigned int JEEP::JVersion::majorVersion

protectedinherited

API major version.

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

unsigned int JEEP::JVersion::minorVersion

protectedinherited

API minor version.

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

unsigned int JEEP::JVersion::patchVersion

protectedinherited

API patch version.

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

---

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

• JDBSupportkit.hh