ground/gcs/src/libs/version_info/version_info.h

   1 /**
   2  ******************************************************************************
   3  * @file       version_info.h
   4  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2013.
   5  * @addtogroup VersionInfo
   6  * @{
   7  * @brief      GCS version info class header.
   8  *****************************************************************************/
   9 /*
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful, but
  16  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  17  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  18  * for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  23  */
  24
  25 #ifndef VERSION_INFO_H
  26 #define VERSION_INFO_H
  27
  28 #include <QString>
  29
  30 /**
  31  * @class VersionInfo
  32  * @brief Library class to provide version info information extracted from a git repository.
  33  *
  34  * Class static members return read-only strings extracted from a git repository at compile time.
  35  * The content is generated by the version-info.py utility using template.
  36  *
  37  * @note If repository or git utility is unavailable, strings can be empty or be "None".
  38  *       So do not assume they have some particular format when used, use them as strings only.
  39  *
  40  * More info: https://librepilot.atlassian.net/wiki/display/LPDOC/Building+and+Packaging+Overview
  41  */
  42 class VersionInfo {
  43 public:
  44     static QString origin();
  45     static QString revision();
  46     static QString hash();
  47     static QString uavoHash();
  48     static QString uavoHashArray();
  49     static QString label();
  50     static QString tag();
  51     static QString tagOrBranch();
  52     static QString tagOrHash8();
  53     static QString hash8();
  54     static QString fwTag();
  55     static QString unixTime();
  56     static QString dateTime();
  57     static QString date();
  58     static QString day();
  59     static QString month();
  60     static QString year();
  61     static QString hour();
  62     static QString minute();
  63     static QString dirty();
  64 private:
  65     VersionInfo();
  66 };
  67
  68 #endif // VERSION_INFO_H