HLT/MUON/src/Version/Version.hpp

   1 ////////////////////////////////////////////////////////////////////////////////
   2 //
   3 // Author: Artur Szostak
   4 // Email:  artur@alice.phy.uct.ac.za | artursz@iafrica.com
   5 //
   6 ////////////////////////////////////////////////////////////////////////////////
   7
   8 /* This source file defines the routines used to extract the version
   9    information for the muon HLT module.
  10  */
  11
  12 #ifndef dHLT_VERSION_FUNCTIONS_HPP
  13 #define dHLT_VERSION_FUNCTIONS_HPP
  14
  15 #include "BasicTypes.hpp"
  16
  17 namespace dHLT
  18 {
  19
  20
  21 /* Returns a NULL terminated version string of the form: XX.YY.ZZ
  22    where XX will be the MajorVersion() number, YY the MinorVersion() number
  23    and ZZ the BuildVersion() build number.
  24   */
  25 const Char* VersionString();
  26
  27 /* Returns the major version number of the muon HLT module.
  28    Major version numbers are incremented after major and fundemental changes
  29    to the muon HLT module. Fundemental changes include: changing large
  30    parts of the code, e.g. changing existing class behaviour or completely
  31    rewriting classes and methods.
  32  */
  33 UInt MajorVersion();
  34
  35 /* Returns the minor version number of the muon HLT module.
  36    Minor version numbers are incremented for any small changes made to the
  37    module such as adding new classes, fixing methods etc...
  38  */
  39 UInt MinorVersion();
  40
  41 /* Returns the build number of the muon HLT module.
  42    The build number is incremented every time the source is built for distribution.
  43  */
  44 UInt BuildNumber();
  45
  46
  47 }; // dHLT
  48
  49 #endif // dHLT_VERSION_FUNCTIONS_HPP