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

VersionString() [1/6]

openstudio::VersionString::VersionString ( const std::string & version )

explicit

VersionString() [2/6]

openstudio::VersionString::VersionString

(

)

VersionString() [3/6]

openstudio::VersionString::VersionString	(	int	major,
		int	minor )

VersionString() [4/6]

openstudio::VersionString::VersionString	(	int	major,
		int	minor,
		int	patch )

VersionString() [5/6]

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

VersionString() [6/6]

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

Member Function Documentation

buildString()

std::string openstudio::VersionString::buildString

(

)

const

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

isNextVersion()

bool openstudio::VersionString::isNextVersion

(

const VersionString &

nextVersionCandidate

)

const

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

major()

int openstudio::VersionString::major

(

)

const

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

minor()

int openstudio::VersionString::minor

(

)

const

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

operator!=()

bool openstudio::VersionString::operator!=

(

const VersionString &

other

)

const

operator<()

bool openstudio::VersionString::operator<

(

const VersionString &

other

)

const

deprecated will always return empty

operator<=()

bool openstudio::VersionString::operator<=

(

const VersionString &

other

)

const

operator==()

bool openstudio::VersionString::operator==

(

const VersionString &

other

)

const

operator>()

bool openstudio::VersionString::operator>

(

const VersionString &

other

)

const

operator>=()

bool openstudio::VersionString::operator>=

(

const VersionString &

other

)

const

patch()

boost::optional< int > openstudio::VersionString::patch

(

)

const

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

patchString()

std::string openstudio::VersionString::patchString

(

)

const

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

str()

std::string openstudio::VersionString::str

(

)

const