include/anna/statistics/Meter.hpp

   1 // ANNA - Anna is Not 'N' Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_statistics_Meter_hpp
  38 #define anna_statistics_Meter_hpp
  39
  40 #include <anna/timex/Meter.hpp>
  41
  42 // Standard
  43 #include <string>
  44
  45 // Local
  46 #include <anna/statistics/Accumulator.hpp>
  47
  48
  49 namespace anna {
  50 namespace xml {
  51 class Node;
  52 }
  53 }
  54
  55
  56 namespace anna {
  57
  58 namespace statistics {
  59
  60
  61 using namespace anna;
  62
  63
  64 //------------------------------------------------------------------------------
  65 //------------------------------------------------------------------ class Meter
  66 //------------------------------------------------------------------------------
  67 /**
  68  * Accumulated data information for statistic sample oriented to processing time.
  69  * It manage a single concept, with integer nature sample and unit 'milliseconds'.
  70  *
  71  * @short Processing time control
  72  */
  73 class Meter {
  74 public:
  75
  76   /**
  77   * Constructor.
  78   */
  79   Meter(const std::string & description);
  80
  81   /**
  82   * Destructor.
  83   */
  84   ~Meter();
  85
  86
  87   /**
  88   * Sets the time control point for processing measure
  89   */
  90   void setControlPoint(void) throw() { a_meter.setControlPoint(); }
  91
  92
  93   /**
  94   * Reset sample
  95   */
  96   void reset(void) throw() { a_accumulator.reset(); }
  97
  98
  99   /**
 100   * Process new value for the sample: milliseconds time since last control point
 101   *
 102   * @return Returns processed delay
 103   */
 104   Millisecond process(void) throw() { a_accumulator.process(a_single_accumulator_concept_id, a_meter.getDelay()); return (a_meter.getDelay()); }
 105
 106
 107   /**
 108   * Copy operator
 109   *
 110   * @param Meter Class instance source of data
 111   *
 112   * @return Returns copied reference
 113   */
 114   const Meter & operator = (const Meter & meter);
 115
 116
 117
 118   // Gets
 119
 120 //    /**
 121 //    * Gets accumulator information in order to extract statistics indicators
 122 //    */
 123 //    const Accumulator & getAccumulator(void) const throw() { return (a_accumulator); }
 124
 125   /**
 126   * Gets accumulator value information (statistics indicators)
 127   *
 128   * @param operation Solicited operation
 129   *
 130   * @return Value for solicited operation
 131   */
 132   double getAccumulatorValue(const Operation::Type &operation) const throw() { return (a_accumulator.getValue(a_single_accumulator_concept_id, operation)); }
 133
 134
 135   /**
 136   * Class string representation
 137   *
 138   * @param numberOfDecimals Number of float decimals at representation string. Default is 2.
 139   *
 140   * @return String with class content
 141   */
 142   std::string asString(const int & numberOfDecimals = 2) const throw();
 143
 144
 145   /**
 146   * Class XML representation
 147   *
 148   * @param numberOfDecimals Number of float decimals at XML representation. Default is 2.
 149   *
 150   * @return XML with class content
 151   */
 152   anna::xml::Node* asXML(anna::xml::Node* parent, const int & numberOfDecimals = 2) const throw();
 153
 154
 155
 156 private:
 157
 158   timex::Meter a_meter;
 159   Accumulator a_accumulator;
 160   int a_single_accumulator_concept_id;
 161 };
 162
 163 }
 164 }
 165
 166 #endif