Include accumulators on statistics engine in order to centralize and ease asXML....

[anna.git] / include / anna / statistics / Engine.hpp

diff --git a/include/anna/statistics/Engine.hpp b/include/anna/statistics/Engine.hpp
index 5f39893..61a9fe6 100644 (file)
--- a/include/anna/statistics/Engine.hpp
+++ b/include/anna/statistics/Engine.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_Engine_hpp
@@ -39,9 +11,11 @@
 
 #include <anna/core/Singleton.hpp>
 #include <anna/core/util/Millisecond.hpp>
+#include <anna/core/mt/Mutex.hpp>
 
 // Standard
 #include <string>
+#include <vector>
 #include <map>
 
 // Local
@@ -73,6 +47,8 @@ typedef std::map <int, _concept_identification_t> _concept_identification_map_t;
 typedef std::map <int, _concept_identification_t>::const_iterator _concept_identification_map_iter;
 typedef std::map <int, _concept_identification_t>::iterator _concept_identification_map_nc_iter;
 
+typedef std::vector <Accumulator*> _accumulator_vector_t;
+typedef std::vector <Accumulator*>::const_iterator _accumulator_vector_it;
 
 
 /**
@@ -85,6 +61,9 @@ class Engine : public anna::Singleton <Engine> {
 
 public:
 
+  /** Destructor */
+  ~Engine();
+
   // Sets
 
   /**
@@ -158,6 +137,16 @@ public:
   */
   bool enabled(void) const throw() { return (a_enabled); }
 
+  /**
+  * There is an advantage creating Accumulators over the engine: the #asXML method will show all the controlled information
+  * easily. Anyway, you could allocate this class objects without using this. Then, this is a helper to create accumulators
+  * and centralize their reports.
+  *
+  * @param name Accumulator name
+  *
+  * @return New allocated accumulator, to be used by the client
+  */
+  Accumulator *createAccumulator(const std::string &name) throw();
 
   /**
   * Class string representation
@@ -182,8 +171,10 @@ private:
   Engine(); // private constructor
 
   _concept_identification_map_t a_concept_identification_map;
+  _accumulator_vector_t a_accumulators; // you could create accumulators regardless the engine, but this is easier and asXML will show all the information easily
   bool a_enabled;
   int a_sequence_concept_id;
+  anna::Mutex a_mutex; // for logSample
 
   bool logSample(const int & conceptId, const anna::Millisecond & unixTimestamp, const double & value) const throw();