1 // ANNA - Anna is Not Nothingness Anymore
3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
5 // http://redmine.teslayout.com/projects/anna-suite
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
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
17 // * Neither the name of the copyright holder 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.
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.
33 // Authors: eduardo.ramos.testillano@gmail.com
34 // cisco.tierra@gmail.com
37 #ifndef anna_statistics_Meter_hpp
38 #define anna_statistics_Meter_hpp
40 #include <anna/timex/Meter.hpp>
46 #include <anna/statistics/Accumulator.hpp>
58 namespace statistics {
64 //------------------------------------------------------------------------------
65 //------------------------------------------------------------------ class Meter
66 //------------------------------------------------------------------------------
68 * Accumulated data information for statistic sample oriented to processing time.
69 * It manage a single concept, with integer nature sample and unit 'milliseconds'.
71 * @short Processing time control
79 Meter(const std::string & description);
88 * Sets the time control point for processing measure
90 void setControlPoint(void) throw() { a_meter.setControlPoint(); }
96 void reset(void) throw() { a_accumulator.reset(); }
100 * Process new value for the sample: milliseconds time since last control point
102 * @return Returns processed delay
104 Millisecond process(void) throw() { a_accumulator.process(a_single_accumulator_concept_id, a_meter.getDelay()); return (a_meter.getDelay()); }
110 * @param Meter Class instance source of data
112 * @return Returns copied reference
114 const Meter & operator = (const Meter & meter);
121 // * Gets accumulator information in order to extract statistics indicators
123 // const Accumulator & getAccumulator(void) const throw() { return (a_accumulator); }
126 * Gets accumulator value information (statistics indicators)
128 * @param operation Solicited operation
130 * @return Value for solicited operation
132 double getAccumulatorValue(const Operation::Type &operation) const throw() { return (a_accumulator.getValue(a_single_accumulator_concept_id, operation)); }
136 * Class string representation
138 * @param numberOfDecimals Number of float decimals at representation string. Default is 2.
140 * @return String with class content
142 std::string asString(const int & numberOfDecimals = 2) const throw();
146 * Class XML representation
148 * @param numberOfDecimals Number of float decimals at XML representation. Default is 2.
150 * @return XML with class content
152 anna::xml::Node* asXML(anna::xml::Node* parent, const int & numberOfDecimals = 2) const throw();
158 timex::Meter a_meter;
159 Accumulator a_accumulator;
160 int a_single_accumulator_concept_id;