Message statistics

[anna.git] / source / statistics / Accumulator.cpp

diff --git a/source/statistics/Accumulator.cpp b/source/statistics/Accumulator.cpp
index c8c5abf..c3e3b2c 100644 (file)
--- a/source/statistics/Accumulator.cpp
+++ b/source/statistics/Accumulator.cpp
@@ -1,37 +1,9 @@
-// ANNA - Anna is Not Nothingness Anymore
-//
-// (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
-//
-// http://redmine.teslayout.com/projects/anna-suite
-//
-// 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 the copyright holder 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 //
 
 
 //------------------------------------------------------------------------------
@@ -60,23 +32,6 @@ using namespace anna::statistics;
 using namespace anna::time;
 
 
-//******************************************************************************
-//------------------------------------------------------------------------------
-//--------------------------------------------------- Accumulator::Accumulator()
-//------------------------------------------------------------------------------
-
-// Default Constructor
-Accumulator::Accumulator() {
-  //reset (); no sense
-}
-
-
-Accumulator::~Accumulator() {
-// LOGMETHOD (TraceMethod tttm ("anna::statistics::Accumulator", "Destructor", ANNA_FILE_LOCATION));
-}
-
-
-
 // Private functions:
 
 
@@ -90,10 +45,19 @@ void Accumulator::initialize(const int & conceptId) throw() {
 }
 
 
+//------------------------------------------------------------------------------
+//---------------------------------------------------- Accumulator::addConcept()
+//------------------------------------------------------------------------------
+int Accumulator::addConcept(const std::string & description, const std::string & unit, const bool & integerNatureSample, const char *conceptNameFormat) throw() {
+  std::string conceptName = anna::functions::asString(conceptNameFormat, description.c_str(), a_name.c_str());
+  return anna::statistics::Engine::instantiate().addConcept(conceptName, unit, integerNatureSample);
+}
+
+
 //------------------------------------------------------------------------------
 //---------------------------------------------------- Accumulator::getConcept()
 //------------------------------------------------------------------------------
-_concept_data_t * Accumulator::getConcept(const int & conceptId) const throw(anna::RuntimeException) {
+_concept_data_t *Accumulator::getConcept(const int & conceptId) const throw(anna::RuntimeException) {
   _concept_data_map_iter it = a_concept_data_map.find(conceptId);
 
   if(it == a_concept_data_map.end()) {  // not found
@@ -110,7 +74,6 @@ _concept_data_t * Accumulator::getConcept(const int & conceptId) const throw(ann
 
     Accumulator * nc_this = const_cast<Accumulator *>(this);
     nc_this->initialize(conceptId);
-    // (la otra posibilidad era hacer mutable el mapa e inicializar poniendo el contenido de 'initialize()')
     it = a_concept_data_map.find(conceptId);
   }
 
@@ -129,9 +92,6 @@ std::string Accumulator::floatFormat(const int & numberOfDecimals) const throw()
 }
 
 
-
-
-
 //------------------------------------------------------------------------------
 //------------------------------------------ Accumulator::getStandardDeviation()
 //------------------------------------------------------------------------------
@@ -173,7 +133,7 @@ void Accumulator::process(const int & conceptId, const double & value) throw(ann
   _concept_data_t *ptr_auxConceptData = getConcept(conceptId);
   anna::Millisecond current = anna::Millisecond::getTime();
   // Optional sample file dump:
-  Engine::instantiate().logSample(conceptId, current, value);
+  Engine::instantiate().logSample(conceptId, current, value); // Accumulator is friend of Engine
 
   // Statistics calculations
   if(ptr_auxConceptData->Size == ULLONG_MAX)  // Statistics is better during processing until reset
@@ -254,8 +214,10 @@ void Accumulator::reset(void) throw() {
 //------------------------------------------------------------------------------
 void Accumulator::reset(const int & conceptId) throw(anna::RuntimeException) {
 // LOGMETHOD (TraceMethod tttm ("anna::statistics::Accumulator", "reset", ANNA_FILE_LOCATION));
-  _concept_data_t *ptr_auxConceptData = getConcept(conceptId);
-  //if (ptr_auxConceptData == NULL) return; // Not possible: getConcept initializes it if not found.
+  _concept_data_t *ptr_auxConceptData = getConcept(conceptId); // will initialize if didn't associated to this accumulator,
+                                                               // exception if engine knows nothing about such concept id.
+  //if (ptr_auxConceptData == NULL) return; // Not possible: getConcept initializes it if not found or exception was launched
+                                            //               previously if the engine don't know the concept id.
   ptr_auxConceptData->reset();
 }
 
@@ -317,6 +279,8 @@ std::string Accumulator::asString(const int & numberOfDecimals) const throw() {
   trace =  "\n=====================";
   trace +=  "\nStatistic Information";
   trace +=  "\n=====================";
+  trace += "\nAccumulator name: ";
+  trace += a_name;
   trace += "\nCurrent Time: ";
   trace += time_now.asString();
 
@@ -398,6 +362,7 @@ std::string Accumulator::asString(const int & numberOfDecimals) const throw() {
 //------------------------------------------------------------------------------
 anna::xml::Node* Accumulator::asXML(anna::xml::Node* parent, const int & numberOfDecimals) const throw() {
   anna::xml::Node* result = parent->createChild("anna.statistics.Accumulator");
+  result->createAttribute("Name", a_name);
   _concept_data_map_iter iter;
   _concept_data_map_iter iter_min(a_concept_data_map.begin());
   _concept_data_map_iter iter_max(a_concept_data_map.end());