JDATABASE::JDBAPIVersion Struct Reference

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

#include <JDBSupportkit.hh>

Inheritance diagram for JDATABASE::JDBAPIVersion:

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

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...
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...

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...

Detailed Description

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

Definition at line 134 of file JDBSupportkit.hh.

Member Typedef Documentation

typedef unsigned int JEEP::JVersion::version_type

inherited

Type definition of [sub-]versions.

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

Constructor & Destructor Documentation

JDATABASE::JDBAPIVersion::JDBAPIVersion ( )

inline

Default constructor.

Definition at line 141 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 153 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 165 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;
    }

version_type JEEP::JVersion::getMajorVersion ( ) const

inlineinherited

Get major version.

Returns

major version.

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

    {
      return majorVersion;
    }

version_type JEEP::JVersion::getMinorVersion ( ) const

inlineinherited

Get minor version.

Returns

minor version.

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

    {
      return minorVersion;
    }

version_type JEEP::JVersion::getPatchVersion ( ) const

inlineinherited

Get patch version.

Returns

patch version.

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

    {
      return patchVersion;
    }

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

inlineinherited

Compare version.

Parameters

version

version

Returns

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

Definition at line 107 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;
      }
    }

Member Data Documentation

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

staticinherited

Separator between [sub-]versions.

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

version_type JEEP::JVersion::majorVersion

protectedinherited

major version

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

version_type JEEP::JVersion::minorVersion

protectedinherited

minor version

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

version_type JEEP::JVersion::patchVersion

protectedinherited

patch version

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

---

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

• JDBSupportkit.hh