src/testlib/qbenchmarkmetric.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtTest module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include <QtTest/private/qbenchmarkmetric_p.h>
  43
  44 /*!
  45   \enum QTest::QBenchmarkMetric
  46   \since 4.7
  47
  48   This enum lists all the things that can be benchmarked.
  49
  50   \value FramesPerSecond        Frames per second
  51   \value BitsPerSecond          Bits per second
  52   \value BytesPerSecond         Bytes per second
  53   \value WalltimeMilliseconds   Clock time in milliseconds
  54   \value CPUTicks               CPU time
  55   \value InstructionReads       Instruction reads
  56   \value Events                 Event count
  57   \value WalltimeNanoseconds    Clock time in nanoseconds
  58   \value BytesAllocated         Memory usage in bytes
  59
  60   Note that \c WalltimeNanoseconds and \c BytesAllocated are
  61   only provided for use via \l setBenchmarkResult(), and results
  62   in those metrics are not able to be provided automatically
  63   by the QTest framework.
  64
  65   \sa QTest::benchmarkMetricName(), QTest::benchmarkMetricUnit()
  66
  67  */
  68
  69 /*!
  70   \relates QTest
  71   \since 4.7
  72   Returns the enum value \a metric as a character string.
  73  */
  74 const char * QTest::benchmarkMetricName(QBenchmarkMetric metric)
  75 {
  76     switch (metric) {
  77     case FramesPerSecond:
  78         return "FramesPerSecond";
  79     case BitsPerSecond:
  80         return "BitsPerSecond";
  81     case BytesPerSecond:
  82         return "BytesPerSecond";
  83     case WalltimeMilliseconds:
  84         return "WalltimeMilliseconds";
  85     case CPUTicks:
  86         return "CPUTicks";
  87     case InstructionReads:
  88         return "InstructionReads";
  89     case Events:
  90         return "Events";
  91     case WalltimeNanoseconds:
  92         return "WalltimeNanoseconds";
  93     case BytesAllocated:
  94         return "BytesAllocated";
  95     default:
  96         return "";
  97     }
  98 };
  99
 100 /*!
 101   \relates QTest
 102   \since 4.7
 103   Retuns the units of measure for the specified \a metric.
 104  */
 105 const char * QTest::benchmarkMetricUnit(QBenchmarkMetric metric)
 106 {
 107     switch (metric) {
 108     case FramesPerSecond:
 109         return "fps";
 110     case BitsPerSecond:
 111         return "bits/s";
 112     case BytesPerSecond:
 113         return "bytes/s";
 114     case WalltimeMilliseconds:
 115         return "msecs";
 116     case CPUTicks:
 117         return "CPU ticks";
 118     case InstructionReads:
 119         return "instruction reads";
 120     case Events:
 121         return "events";
 122     case WalltimeNanoseconds:
 123         return "nsecs";
 124     case BytesAllocated:
 125         return "bytes";
 126     default:
 127         return "";
 128     }
 129 }
 130