Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::VersionInfo Class Reference

Information about a version. More...

#include <arcane/utils/VersionInfo.h>

Collaboration diagram for Arcane::VersionInfo:

Public Member Functions

 VersionInfo ()
 Constructs a null version.
 VersionInfo (int vmajor, int vminor, int vpatch)
 Constructs a version information.
 VersionInfo (const Arccore::String &version_str)
 Constructs a version information version_str must be in the format "M.m.p.b" where M is the major version, \m is the minor version, p is the patch number, and b is the beta number.
int versionMajor () const
 Returns the major version number.
int versionMinor () const
 Returns the minor version number.
int versionPatch () const
 Returns the patch version number.
String versionAsString () const
 Version number in string format.
void write (std::ostream &o) const

Private Attributes

int m_major
 Major version number.
int m_minor
 Minor version number.
int m_patch
 Patch version number.

Detailed Description

Information about a version.

This class contains information about an object's version. The version number comprises 3 integer values:

  • the major version number,
  • the minor version number,
  • the patch version number,

The major version number corresponds to a fundamental evolution of the object. The minor version number corresponds to less significant evolutions. A major or minor version evolution implies that binary compatibility is not maintained.

Note
the sub-version number is no longer used.

Definition at line 46 of file VersionInfo.h.

Constructor & Destructor Documentation

◆ VersionInfo() [1/3]

Arcane::VersionInfo::VersionInfo ( )

Constructs a null version.

Definition at line 30 of file VersionInfo.cc.

References m_major, m_minor, and m_patch.

◆ VersionInfo() [2/3]

Arcane::VersionInfo::VersionInfo ( int vmajor,
int vminor,
int vpatch )

Constructs a version information.

Definition at line 41 of file VersionInfo.cc.

References m_major, m_minor, and m_patch.

◆ VersionInfo() [3/3]

Arcane::VersionInfo::VersionInfo ( const Arccore::String & version_str)

Constructs a version information version_str must be in the format "M.m.p.b" where M is the major version, \m is the minor version, p is the patch number, and b is the beta number.

Definition at line 69 of file VersionInfo.cc.

References Arcane::String::localstr(), m_major, m_minor, and m_patch.

Here is the call graph for this function:

Member Function Documentation

◆ versionAsString()

String Arcane::VersionInfo::versionAsString ( ) const

Version number in string format.

Definition at line 93 of file VersionInfo.cc.

References versionMajor(), versionMinor(), and versionPatch().

Here is the call graph for this function:

◆ versionMajor()

int Arcane::VersionInfo::versionMajor ( ) const
inline

Returns the major version number.

Definition at line 65 of file VersionInfo.h.

References m_major.

Referenced by Arcane::Application::build(), Arcane::Application::initialize(), and versionAsString().

Here is the caller graph for this function:

◆ versionMinor()

int Arcane::VersionInfo::versionMinor ( ) const
inline

Returns the minor version number.

Definition at line 68 of file VersionInfo.h.

References m_minor.

Referenced by Arcane::Application::build(), Arcane::Application::initialize(), and versionAsString().

Here is the caller graph for this function:

◆ versionPatch()

int Arcane::VersionInfo::versionPatch ( ) const
inline

Returns the patch version number.

Definition at line 71 of file VersionInfo.h.

References m_patch.

Referenced by Arcane::Application::build(), Arcane::Application::initialize(), and versionAsString().

Here is the caller graph for this function:

◆ write()

void Arcane::VersionInfo::write ( std::ostream & o) const

Definition at line 84 of file VersionInfo.cc.

Member Data Documentation

◆ m_major

int Arcane::VersionInfo::m_major
private

Major version number.

Definition at line 83 of file VersionInfo.h.

Referenced by VersionInfo(), VersionInfo(), VersionInfo(), and versionMajor().

◆ m_minor

int Arcane::VersionInfo::m_minor
private

Minor version number.

Definition at line 84 of file VersionInfo.h.

Referenced by VersionInfo(), VersionInfo(), VersionInfo(), and versionMinor().

◆ m_patch

int Arcane::VersionInfo::m_patch
private

Patch version number.

Definition at line 85 of file VersionInfo.h.

Referenced by VersionInfo(), VersionInfo(), VersionInfo(), and versionPatch().

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