VersionInfo Class Reference [Concept]

Version information class. More...

#include <OpenMS/CONCEPT/VersionInfo.h>

List of all members.

Classes
struct	VersionDetails
Static Public Member Functions
static String	getTime ()
	Return the build time of OpenMS.
static String	getVersion ()
	Return the version number of OpenMS.
static VersionDetails	getVersionStruct ()
	Return the version number of OpenMS.
static String	getRevision ()
	Return the revision number from revision control system, e.g. Subversion.

---

Detailed Description

Version information class.

The OpenMS release version and revision data can be retrieved as a string or as integers.

Note that the term "version" refers to releases (such as 1.0, 1.1, 1.1.1, 1.2, ...), whereas the term "revision" refers to a revision control system such as subversion and is mainly of interest for developers.

The VersionInfo class contains only static methods.

---

Member Function Documentation

static String getRevision

(

)

[static]

Return the revision number from revision control system, e.g. Subversion.

On released versions of OpenMS (not from SVN), the result is "exported". The result can be possibly be "" on some platforms, which means that revision info is unavailable. You should check for both cases in your code.

For internal use only.

The current svn version is queried by the build system regularly and the result is written as a header file which is included by VersionInfo.C.

static String getTime

(

)

[static]

Return the build time of OpenMS.

static String getVersion

(

)

[static]

Return the version number of OpenMS.

Referenced by SpectrumCanvas::addDataProcessing_(), TOPPViewBase::loadPreferences(), TOPPASBase::loadPreferences(), TOPPViewBase::savePreferences(), TOPPASBase::savePreferences(), TOPPViewBase::showAboutDialog(), TOPPASBase::showAboutDialog(), and IDEvaluationBase::showAboutDialog().

static VersionDetails getVersionStruct

(

)

[static]

Return the version number of OpenMS.