OpenStudio:utilities
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
openstudio::VersionString Class Reference

#include <Compare.hpp>

Public Member Functions

std::string buildString () const
 build version can be any string, e.g. returns 'build2' for '3.1.0-rc1+build2' More...
 
bool isNextVersion (const VersionString &nextVersionCandidate) const
 Returns true if it is plausible for nextVersionCandidate to be the next version after this one. More...
 
int major () const
 major verion must be a positve integer, e.g. returns 3 for '3.1.0-rc1' More...
 
int minor () const
 minor version must be a positive integer, e.g. returns 1 for '3.1.0-rc1' More...
 
bool operator!= (const VersionString &other) const
 
bool operator< (const VersionString &other) const
 deprecated will always return empty More...
 
bool operator<= (const VersionString &other) const
 
bool operator== (const VersionString &other) const
 
bool operator> (const VersionString &other) const
 
bool operator>= (const VersionString &other) const
 
boost::optional< intpatch () const
 returns the integer portion of patch version, e.g. returns 0 for '3.1.0-rc1' More...
 
std::string patchString () const
 returns the string portion of patch version, e.g. returns 'rc1' for '3.1.0-rc1' More...
 
std::string str () const
 
 VersionString (const std::string &version)
 
 VersionString ()
 
 VersionString (int major, int minor)
 
 VersionString (int major, int minor, int patch)
 
 VersionString (int major, int minor, int patch, const std::string &patchString)
 
 VersionString (int major, int minor, int patch, const std::string &patchString, const std::string &buildString)
 

Constructor & Destructor Documentation

openstudio::VersionString::VersionString ( const std::string &  version)
explicit
openstudio::VersionString::VersionString ( )
openstudio::VersionString::VersionString ( int  major,
int  minor 
)
openstudio::VersionString::VersionString ( int  major,
int  minor,
int  patch 
)
openstudio::VersionString::VersionString ( int  major,
int  minor,
int  patch,
const std::string &  patchString 
)
openstudio::VersionString::VersionString ( int  major,
int  minor,
int  patch,
const std::string &  patchString,
const std::string &  buildString 
)

Member Function Documentation

std::string openstudio::VersionString::buildString ( ) const

build version can be any string, e.g. returns 'build2' for '3.1.0-rc1+build2'

bool openstudio::VersionString::isNextVersion ( const VersionString nextVersionCandidate) const

Returns true if it is plausible for nextVersionCandidate to be the next version after this one.

int openstudio::VersionString::major ( ) const

major verion must be a positve integer, e.g. returns 3 for '3.1.0-rc1'

int openstudio::VersionString::minor ( ) const

minor version must be a positive integer, e.g. returns 1 for '3.1.0-rc1'

bool openstudio::VersionString::operator!= ( const VersionString other) const
bool openstudio::VersionString::operator< ( const VersionString other) const

deprecated will always return empty

bool openstudio::VersionString::operator<= ( const VersionString other) const
bool openstudio::VersionString::operator== ( const VersionString other) const
bool openstudio::VersionString::operator> ( const VersionString other) const
bool openstudio::VersionString::operator>= ( const VersionString other) const
boost::optional<int> openstudio::VersionString::patch ( ) const

returns the integer portion of patch version, e.g. returns 0 for '3.1.0-rc1'

std::string openstudio::VersionString::patchString ( ) const

returns the string portion of patch version, e.g. returns 'rc1' for '3.1.0-rc1'

std::string openstudio::VersionString::str ( ) const