Mantid::Kernel::MantidVersion Class Reference

Class containing static methods to return the Mantid version number and date. More...

#include <MantidVersion.h>

Classes
struct	VersionInfo

Static Public Member Functions
static std::string	doi ()
	The DOI for this release of Mantid. More...
static std::string	paperCitation ()
	The citation for the Mantid paper. More...
static const char *	releaseDate ()
	The date of the last commit. More...
static std::string	releaseNotes ()
	The url to the most applicable release notes. More...
static const char *	revision ()
	The abbreviated SHA-1 of the last commit. More...
static const char *	revisionFull ()
	The full SHA-1 of the last commit. More...
static const char *	version ()
	The full version number. More...
static const VersionInfo	versionInfo ()
	A data structure containing the full version info. More...
static const char *	versionShort ()
	The version number of the last full version. More...

Private Member Functions
	MantidVersion ()
	Private, unimplemented constructor. More...

Detailed Description

Class containing static methods to return the Mantid version number and date.

Definition at line 21 of file MantidVersion.h.

Constructor & Destructor Documentation

MantidVersion()

Mantid::Kernel::MantidVersion::MantidVersion ( )

private

Private, unimplemented constructor.

Not a class that can

Member Function Documentation

doi()

std::string Mantid::Kernel::MantidVersion::doi ( )

static

The DOI for this release of Mantid.

Definition at line 84 of file MantidVersion.cpp.

References doi().

Referenced by doi(), export_MantidVersion(), and Mantid::welcomeMessage().

paperCitation()

std::string Mantid::Kernel::MantidVersion::paperCitation ( )

static

The citation for the Mantid paper.

Definition at line 107 of file MantidVersion.cpp.

Referenced by export_MantidVersion(), and Mantid::welcomeMessage().

releaseDate()

const char * Mantid::Kernel::MantidVersion::releaseDate ( )

static

The date of the last commit.

Definition at line 79 of file MantidVersion.cpp.

Referenced by Mantid::DataHandling::CheckMantidVersion::exec(), export_MantidVersion(), and Mantid::DataHandling::CheckMantidVersion::getVersionsFromGitHub().

releaseNotes()

std::string Mantid::Kernel::MantidVersion::releaseNotes ( )

static

The url to the most applicable release notes.

Definition at line 37 of file MantidVersion.cpp.

References versionShort().

Referenced by export_MantidVersion(), and Mantid::API::NotebookWriter::headerComment().

revision()

const char * Mantid::Kernel::MantidVersion::revision ( )

static

The abbreviated SHA-1 of the last commit.

Definition at line 69 of file MantidVersion.cpp.

Referenced by Mantid::Kernel::ConfigServiceImpl::ConfigServiceImpl(), and export_MantidVersion().

revisionFull()

const char * Mantid::Kernel::MantidVersion::revisionFull ( )

static

The full SHA-1 of the last commit.

Definition at line 74 of file MantidVersion.cpp.

Referenced by Mantid::Algorithms::GeneratePythonScript::exec(), export_MantidVersion(), Mantid::Kernel::ErrorReporter::generateErrorMessage(), and Mantid::Kernel::UsageServiceImpl::generateStartupMessage().

version()

const char * Mantid::Kernel::MantidVersion::version ( )

static

The full version number.

Definition at line 20 of file MantidVersion.cpp.

Referenced by Mantid::Kernel::ConfigServiceImpl::ConfigServiceImpl(), Mantid::Kernel::InternetHelper::createRequest(), Mantid::DataHandling::SaveCanSAS1D::createSASProcessElement(), Mantid::DataHandling::SaveCanSAS1D2::createSASProcessElement(), Mantid::Algorithms::GeneratePythonScript::exec(), Mantid::DataHandling::SaveNXSPE::exec(), export_MantidVersion(), Mantid::Kernel::EnvironmentHistory::frameworkVersion(), Mantid::Kernel::ErrorReporter::generateErrorMessage(), Mantid::Kernel::UsageServiceImpl::generateStartupMessage(), Mantid::DataHandling::CheckMantidVersion::getCurrentVersion(), Mantid::API::NotebookWriter::headerComment(), Mantid::DataHandling::SaveNXTomo::setupFile(), Mantid::welcomeMessage(), and Mantid::DataHandling::SavePDFGui::writeMetaData().

versionInfo()

const MantidVersion::VersionInfo Mantid::Kernel::MantidVersion::versionInfo ( )

static

A data structure containing the full version info.

Definition at line 33 of file MantidVersion.cpp.

Referenced by export_MantidVersion().

versionShort()

const char * Mantid::Kernel::MantidVersion::versionShort ( )

static

The version number of the last full version.

Definition at line 27 of file MantidVersion.cpp.

Referenced by Mantid::Kernel::UsageServiceImpl::generateFeatureHeader(), and releaseNotes().

---

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

• Framework/Kernel/inc/MantidKernel/MantidVersion.h
• Framework/Kernel/src/MantidVersion.cpp