X-Git-Url: https://git.teslayout.com/public/public/public/?a=blobdiff_plain;f=include%2Fanna%2Fstatistics%2FAccumulator.hpp;h=d86c65fa88fbbf8b52a6db61476360ce305bab72;hb=028006fc5ee34967fcfffff24a2b1c8b410c26c3;hp=e471e71860e4c1be142c0ad44263c18e6abe52f2;hpb=3e258840b15577cb8bda3cdedd0b9b88e16404b3;p=anna.git diff --git a/include/anna/statistics/Accumulator.hpp b/include/anna/statistics/Accumulator.hpp index e471e71..d86c65f 100644 --- a/include/anna/statistics/Accumulator.hpp +++ b/include/anna/statistics/Accumulator.hpp @@ -1,37 +1,9 @@ -// ANNA - Anna is Not Nothingness Anymore -// -// (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo -// -// https://bitbucket.org/testillano/anna -// -// Redistribution and use in source and binary forms, with or without -// modification, are permitted provided that the following conditions -// are met: -// -// * Redistributions of source code must retain the above copyright -// notice, this list of conditions and the following disclaimer. -// * Redistributions in binary form must reproduce the above -// copyright notice, this list of conditions and the following disclaimer -// in the documentation and/or other materials provided with the -// distribution. -// * Neither the name of Google Inc. nor the names of its -// contributors may be used to endorse or promote products derived from -// this software without specific prior written permission. -// -// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -// -// Authors: eduardo.ramos.testillano@gmail.com -// cisco.tierra@gmail.com +// ANNA - Anna is Not Nothingness Anymore // +// // +// (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo // +// // +// See project site at http://redmine.teslayout.com/projects/anna-suite // +// See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE // #ifndef anna_statistics_Accumulator_hpp @@ -113,21 +85,64 @@ typedef std::map ::const_iterator _concept_data_map_iter; * @short Contains statistical sample information */ class Accumulator { + + std::string a_name; + + void initialize(const int & conceptId) throw(); + _concept_data_t * getConcept(const int & conceptId) const throw(anna::RuntimeException); + // Gets the data structure for a existing concept Id. + // Initializes and returns the new data structure for a new stored concept Id which is valid (exists for the engine). + // Launch exception if concept id is not a valid concept registered at Engine. + + /*mutable */_concept_data_map_t a_concept_data_map; + + std::string floatFormat(const int & numberOfDecimals) const throw(); + + double getStandardDeviation(const _concept_data_t * conceptData) const throw(anna::RuntimeException); + double getBesselStandardDeviation(const _concept_data_t * conceptData) const throw(anna::RuntimeException); + + public: /** * Constructor. + * + * @param name Accumulator name */ - Accumulator(); + Accumulator(const std::string &name) : a_name(name) {}; /** * Destructor. */ - ~Accumulator(); + ~Accumulator() {;} + + /** + * Sets the accumulator name + * + * @param name Name provided + */ + void setName(const std::string &name) throw() { a_name = name; } /** - * Process new value for the sample. + * Adds a new statistic concept through the accumulator, to ease the concept name creation, + * which will be a string defined by: concept name + ': ' + accumulator name. + * + * @param description Concept description; e.g.: processing time, messages size, etc. + * @param unit Concept unit description + * @param integerNatureSample Most of cases we will measure 'time' with the unit which force integer values + * (is more intuitive 850 msecs than 0,850 secs). Then, it is @em true by default. + * This is useful to advice better representation for some indicators like minimum/maximum + * within integer samples. + * @param conceptNameFormat Format to register the complete concept name. Will be parsed using (in order) the provided + * description, and the accumulator name: ' []' by default. + * + * @return Assigned concept identification number (sequence) + */ + int addConcept(const std::string & description, const std::string & unit, const bool & integerNatureSample = true, const char *conceptNameFormat = "%s [%s]") throw(); + + /** + * Process new value for the sample regarding a concept identifier previously registered through the engine. * * @param conceptId statistical concept processed * @param value Value for processed item @@ -168,6 +183,13 @@ public: // Gets + /** + * Gets the accumulator name + * + * @result Accumulator name + */ + const std::string &getName() const throw() { return a_name; } + /** * Gets current sample size for any concept id * @@ -213,21 +235,6 @@ public: * @return XML with class content */ anna::xml::Node* asXML(anna::xml::Node* parent, const int & numberOfDecimals = 2) const throw(); - - -private: - - void initialize(const int & conceptId) throw(); - _concept_data_t * getConcept(const int & conceptId) const throw(anna::RuntimeException); - // Return NULL if no data is found for the concept Id - // Launch exception if concept id is not a valid concept registered at Engine - - /*mutable */_concept_data_map_t a_concept_data_map; - - std::string floatFormat(const int & numberOfDecimals) const throw(); - - double getStandardDeviation(const _concept_data_t * conceptData) const throw(anna::RuntimeException); - double getBesselStandardDeviation(const _concept_data_t * conceptData) const throw(anna::RuntimeException); }; }