Message statistics

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

diff --git a/include/anna/statistics/Accumulator.hpp b/include/anna/statistics/Accumulator.hpp
index c13bbf1..d86c65f 100644 (file)
--- a/include/anna/statistics/Accumulator.hpp
+++ b/include/anna/statistics/Accumulator.hpp
@@ -85,6 +85,23 @@ typedef std::map <int, _concept_data_t>::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:
 
   /**
@@ -97,7 +114,15 @@ public:
   /**
   * Destructor.
   */
-  ~Accumulator();
+  ~Accumulator() {;}
+
+
+  /**
+   * Sets the accumulator name
+   *
+   * @param name Name provided
+   */
+  void setName(const std::string &name) throw() { a_name = name; }
 
   /**
   * Adds a new statistic concept through the accumulator, to ease the concept name creation,
@@ -109,14 +134,15 @@ public:
   *                            (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: '<concept description> [<accumulator name>]' by default.
   *
   * @return Assigned concept identification number (sequence)
   */
-  int addConcept(const std::string & description, const std::string & unit, const bool & integerNatureSample = true) throw();
-
+  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.
+  * 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
@@ -157,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
   *
@@ -202,23 +235,6 @@ public:
   * @return XML with class content
   */
   anna::xml::Node* asXML(anna::xml::Node* parent, const int & numberOfDecimals = 2) const throw();
-
-
-private:
-
-  std::string a_name;
-
-  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);
 };
 
 }