Class SBCContainerVersionNumber

ClassList > SBCContainerVersionNumber

This class describes a version number. More...

• #include <SBCContainerVersionNumber.hpp>

Public Functions

Type	Name
	SBCContainerVersionNumber () noexcept Constructs the 0.0.0 version number.
	SBCContainerVersionNumber (const std::string & versionNumberString) Constructs a version number from a versionNumberString .
	SBCContainerVersionNumber (const SBCContainerVersionNumber & versionNumber) Constructs a version number from a versionNumber .
	SBCContainerVersionNumber (unsigned int majorVersionNumber, unsigned int minorVersionNumber, unsigned int patchVersionNumber) noexcept Constructs a version number majorVersionNumber .minorVersionNumber .patchVersionNumber .
unsigned int	getMajorVersionNumber () noexcept const Returns the major version number.
unsigned int	getMinorVersionNumber () noexcept const Returns the minor version number.
unsigned int	getPatchVersionNumber () noexcept const Returns the patch version number.
bool	isValid () const Returns true if and only if the version number is valid.
bool	operator!= (const SBCContainerVersionNumber & versionNumber) const Non-equality operator.
std::string	operator() () const Returns the version number as a string.
bool	operator< (const SBCContainerVersionNumber & versionNumber) const Comparison with another version.
bool	operator<= (const SBCContainerVersionNumber & versionNumber) const Comparison with another version.
SBCContainerVersionNumber &	operator= (const SBCContainerVersionNumber & versionNumber) Assignment operator.
bool	operator== (const SBCContainerVersionNumber & versionNumber) const Equality operator.
bool	operator> (const SBCContainerVersionNumber & versionNumber) const Comparison with another version.
bool	operator>= (const SBCContainerVersionNumber & versionNumber) const Comparison with another version.
void	setMajorVersionNumber (unsigned int majorVersionNumber) Sets the major version number.
void	setMinorVersionNumber (unsigned int minorVersionNumber) Sets the minor version number.
void	setPatchVersionNumber (unsigned int patchVersionNumber) Sets the patch version number.
virtual	~SBCContainerVersionNumber () Destructs the version number.

Public Static Functions

Type	Name
bool	getCompatibilityStatus (const SBCContainerVersionNumber & sdkVersionNumber, const SBCContainerVersionNumber & coreVersionNumber) Returns whether a sdkVersionNumber is compatible with acoreVersionNumber .

Detailed Description

This class describes a version number in SAMSON, composed of three non-negative integers:

• a major version number
• a minor version number
• a patch version number

Because SAMSON Extensions depend on the version of the SDK with which they are developed, SAMSON has a strict versioning policy. Please refer to the chapter about Versioning for more information.

Short name: SBVersionNumber

Public Functions Documentation

function SBCContainerVersionNumber [1/4]

Constructs the 0.0.0 version number.

SBCContainerVersionNumber::SBCContainerVersionNumber () noexcept

---

function SBCContainerVersionNumber [2/4]

Constructs a version number from a versionNumberString .

SBCContainerVersionNumber::SBCContainerVersionNumber (
    const std::string & versionNumberString
) 

---

function SBCContainerVersionNumber [3/4]

Constructs a version number from a versionNumber .

SBCContainerVersionNumber::SBCContainerVersionNumber (
    const SBCContainerVersionNumber & versionNumber
) 

---

function SBCContainerVersionNumber [4/4]

Constructs a version number majorVersionNumber .minorVersionNumber .patchVersionNumber .

SBCContainerVersionNumber::SBCContainerVersionNumber (
    unsigned int majorVersionNumber,
    unsigned int minorVersionNumber,
    unsigned int patchVersionNumber
) noexcept

---

function getMajorVersionNumber

Returns the major version number.

unsigned int SBCContainerVersionNumber::getMajorVersionNumber () noexcept const

---

function getMinorVersionNumber

Returns the minor version number.

unsigned int SBCContainerVersionNumber::getMinorVersionNumber () noexcept const

---

function getPatchVersionNumber

Returns the patch version number.

unsigned int SBCContainerVersionNumber::getPatchVersionNumber () noexcept const

---

function isValid

Returns true if and only if the version number is valid.

bool SBCContainerVersionNumber::isValid () const

---

function operator!=

Non-equality operator.

bool SBCContainerVersionNumber::operator!= (
    const SBCContainerVersionNumber & versionNumber
) const

---

function operator()

Returns the version number as a string.

std::string SBCContainerVersionNumber::operator() () const

---

function operator<

Comparison with another version.

bool SBCContainerVersionNumber::operator< (
    const SBCContainerVersionNumber & versionNumber
) const

---

function operator<=

Comparison with another version.

bool SBCContainerVersionNumber::operator<= (
    const SBCContainerVersionNumber & versionNumber
) const

---

function operator=

Assignment operator.

SBCContainerVersionNumber & SBCContainerVersionNumber::operator= (
    const SBCContainerVersionNumber & versionNumber
) 

---

function operator==

Equality operator.

bool SBCContainerVersionNumber::operator== (
    const SBCContainerVersionNumber & versionNumber
) const

---

function operator>

Comparison with another version.

bool SBCContainerVersionNumber::operator> (
    const SBCContainerVersionNumber & versionNumber
) const

---

function operator>=

Comparison with another version.

bool SBCContainerVersionNumber::operator>= (
    const SBCContainerVersionNumber & versionNumber
) const

---

function setMajorVersionNumber

Sets the major version number.

void SBCContainerVersionNumber::setMajorVersionNumber (
    unsigned int majorVersionNumber
) 

---

function setMinorVersionNumber

Sets the minor version number.

void SBCContainerVersionNumber::setMinorVersionNumber (
    unsigned int minorVersionNumber
) 

---

function setPatchVersionNumber

Sets the patch version number.

void SBCContainerVersionNumber::setPatchVersionNumber (
    unsigned int patchVersionNumber
) 

---

function ~SBCContainerVersionNumber

Destructs the version number.

virtual SBCContainerVersionNumber::~SBCContainerVersionNumber () 

---

Public Static Functions Documentation

function getCompatibilityStatus

Returns whether a sdkVersionNumber is compatible with acoreVersionNumber .

static bool SBCContainerVersionNumber::getCompatibilityStatus (
    const SBCContainerVersionNumber & sdkVersionNumber,
    const SBCContainerVersionNumber & coreVersionNumber
) 

---