Message statistics
[anna.git] / include / anna / statistics / Engine.hpp
index 61a9fe6..5300cfa 100644 (file)
 
 #include <anna/core/Singleton.hpp>
 #include <anna/core/util/Millisecond.hpp>
+#include <anna/core/RuntimeException.hpp>
 #include <anna/core/mt/Mutex.hpp>
 
 // Standard
 #include <string>
-#include <vector>
 #include <map>
 
 // Local
@@ -34,6 +34,9 @@ namespace anna {
 namespace statistics {
 
 
+class Accumulator;
+
+
 typedef struct {
 
   std::string SampleFile; // Sample file to optional writtings
@@ -47,8 +50,9 @@ 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;
+typedef std::map <std::string, Accumulator*> _accumulator_map_t;
+typedef std::map <std::string, Accumulator*>::const_iterator _accumulator_map_it;
+typedef std::map <std::string, Accumulator*>::iterator _accumulator_map_nc_it;
 
 
 /**
@@ -137,16 +141,26 @@ 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();
+   * Creates a statistic accumulator
+   *
+   * @param name Accumulator name
+   *
+   * \return The accumulator created or exception when already exists for the provided name.
+   */
+  Accumulator *createAccumulator(const std::string &name) throw(anna::RuntimeException);
+
+  /**
+   * Returns accumulator instance identified by name.
+   *
+   * \param name Accumulator name
+   *
+   * \return The accumulator instance identified by name provided, NULL if not found
+   */
+  Accumulator* getAccumulator(const std::string &name) throw();
+
+
 
   /**
   * Class string representation
@@ -171,7 +185,7 @@ 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
+  _accumulator_map_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