Medical Imaging Interaction Toolkit  2018.4.99-f51274ea
Medical Imaging Interaction Toolkit
us::ModuleVersion Class Reference

#include <usModuleVersion.h>

Public Member Functions

 ModuleVersion (unsigned int majorVersion, unsigned int minorVersion, unsigned int microVersion)
 
 ModuleVersion (unsigned int majorVersion, unsigned int minorVersion, unsigned int microVersion, const std::string &qualifier)
 
 ModuleVersion (const std::string &version)
 
 ModuleVersion (const ModuleVersion &version)
 
bool IsUndefined () const
 
unsigned int GetMajor () const
 
unsigned int GetMinor () const
 
unsigned int GetMicro () const
 
std::string GetQualifier () const
 
std::string ToString () const
 
bool operator== (const ModuleVersion &object) const
 
int Compare (const ModuleVersion &object) const
 

Static Public Member Functions

static ModuleVersion EmptyVersion ()
 
static ModuleVersion UndefinedVersion ()
 
static ModuleVersion ParseVersion (const std::string &version)
 

Detailed Description

Version identifier for CppMicroServices modules.

Version identifiers have four components.

  1. Major version. A non-negative integer.
  2. Minor version. A non-negative integer.
  3. Micro version. A non-negative integer.
  4. Qualifier. A text string. See ModuleVersion(const std::string&) for the format of the qualifier string.

ModuleVersion objects are immutable.

Definition at line 49 of file usModuleVersion.h.

Constructor & Destructor Documentation

◆ ModuleVersion() [1/4]

us::ModuleVersion::ModuleVersion ( unsigned int  majorVersion,
unsigned int  minorVersion,
unsigned int  microVersion 
)

Creates a version identifier from the specified numerical components.

The qualifier is set to the empty string.

Parameters
majorVersionMajor component of the version identifier.
minorVersionMinor component of the version identifier.
microVersionMicro component of the version identifier.

Definition at line 75 of file usModuleVersion.cpp.

◆ ModuleVersion() [2/4]

us::ModuleVersion::ModuleVersion ( unsigned int  majorVersion,
unsigned int  minorVersion,
unsigned int  microVersion,
const std::string &  qualifier 
)

Creates a version identifier from the specified components.

Parameters
majorVersionMajor component of the version identifier.
minorVersionMinor component of the version identifier.
microVersionMicro component of the version identifier.
qualifierQualifier component of the version identifier.

Definition at line 82 of file usModuleVersion.cpp.

◆ ModuleVersion() [3/4]

us::ModuleVersion::ModuleVersion ( const std::string &  version)

Created a version identifier from the specified string.

Here is the grammar for version strings.

version ::= majorVersion('.'minorVersion('.'microVersion('.'qualifier)?)?)?
majorVersion ::= digit+
minorVersion ::= digit+
microVersion ::= digit+
qualifier ::= (alpha|digit|'_'|'-')+
digit ::= [0..9]
alpha ::= [a..zA..Z]

There must be no whitespace in version.

Parameters
versionstring representation of the version identifier.

Definition at line 89 of file usModuleVersion.cpp.

References min().

◆ ModuleVersion() [4/4]

us::ModuleVersion::ModuleVersion ( const ModuleVersion version)

Create a version identifier from another.

Parameters
versionAnother version identifier

Definition at line 145 of file usModuleVersion.cpp.

Member Function Documentation

◆ Compare()

int us::ModuleVersion::Compare ( const ModuleVersion object) const

Compares this ModuleVersion object to another object.

A version is considered to be less than another version if its majorVersion component is less than the other version's majorVersion component, or the majorVersion components are equal and its minorVersion component is less than the other version's minorVersion component, or the majorVersion and minorVersion components are equal and its microVersion component is less than the other version's microVersion component, or the majorVersion, minorVersion and microVersion components are equal and it's qualifier component is less than the other version's qualifier component (using std::string::operator<()).

A version is considered to be equal to another version if the majorVersion, minorVersion and microVersion components are equal and the qualifier component is equal.

Parameters
objectThe ModuleVersion object to be compared.
Returns
A negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified ModuleVersion object.

Definition at line 228 of file usModuleVersion.cpp.

◆ EmptyVersion()

ModuleVersion us::ModuleVersion::EmptyVersion ( )
static

The empty version "0.0.0".

Definition at line 39 of file usModuleVersion.cpp.

Referenced by ParseVersion().

◆ GetMajor()

unsigned int us::ModuleVersion::GetMajor ( ) const

Returns the majorVersion component of this version identifier.

Returns
The majorVersion component.

Definition at line 176 of file usModuleVersion.cpp.

◆ GetMicro()

unsigned int us::ModuleVersion::GetMicro ( ) const

Returns the microVersion component of this version identifier.

Returns
The microVersion component.

Definition at line 188 of file usModuleVersion.cpp.

◆ GetMinor()

unsigned int us::ModuleVersion::GetMinor ( ) const

Returns the minorVersion component of this version identifier.

Returns
The minorVersion component.

Definition at line 182 of file usModuleVersion.cpp.

◆ GetQualifier()

std::string us::ModuleVersion::GetQualifier ( ) const

Returns the qualifier component of this version identifier.

Returns
The qualifier component.

Definition at line 194 of file usModuleVersion.cpp.

◆ IsUndefined()

bool us::ModuleVersion::IsUndefined ( ) const

Returns the undefined state of this version identifier.

Returns
true if this version identifier is undefined, false otherwise.

Definition at line 171 of file usModuleVersion.cpp.

◆ operator==()

bool us::ModuleVersion::operator== ( const ModuleVersion object) const

Compares this ModuleVersion object to another object.

A version is considered to be equal to another version if the majorVersion, minorVersion and microVersion components are equal and the qualifier component is equal.

Parameters
objectThe ModuleVersion object to be compared.
Returns
true if object is a ModuleVersion and is equal to this object; false otherwise.

Definition at line 213 of file usModuleVersion.cpp.

◆ ParseVersion()

ModuleVersion us::ModuleVersion::ParseVersion ( const std::string &  version)
static

Parses a version identifier from the specified string.

See ModuleVersion(const std::string&) for the format of the version string.

Parameters
versionstring representation of the version identifier. Leading and trailing whitespace will be ignored.
Returns
A ModuleVersion object representing the version identifier. If version is the empty string then EmptyVersion will be returned.

Definition at line 153 of file usModuleVersion.cpp.

References EmptyVersion().

◆ ToString()

std::string us::ModuleVersion::ToString ( ) const

Returns the string representation of this version identifier.

The format of the version string will be majorVersion.minorVersion.microVersion if qualifier is the empty string or majorVersion.minorVersion.microVersion.qualifier otherwise.

Returns
The string representation of this version identifier.

Definition at line 200 of file usModuleVersion.cpp.

Referenced by QmitkModuleTableModel::data().

◆ UndefinedVersion()

ModuleVersion us::ModuleVersion::UndefinedVersion ( )
static

Creates an undefined version identifier, representing either infinity or minus infinity.

Definition at line 45 of file usModuleVersion.cpp.

References us::IsInvalidQualifier().


The documentation for this class was generated from the following files: