X-Git-Url: https://git.teslayout.com/public/public/public/?a=blobdiff_plain;f=include%2Fanna%2Fstatistics%2FEngine.hpp;h=e0c9233eb0d3a17775f64083a9a11f4ef25c175f;hb=f34b8069233e9e09208339bb79d8576c1ff962e1;hp=8f59a2e38710f1ef4d93d5d4d5eacfa1999357cd;hpb=66409396bebc1cfeb63d404f3aee8639159298d5;p=anna.git diff --git a/include/anna/statistics/Engine.hpp b/include/anna/statistics/Engine.hpp index 8f59a2e..e0c9233 100644 --- a/include/anna/statistics/Engine.hpp +++ b/include/anna/statistics/Engine.hpp @@ -11,11 +11,11 @@ #include #include +#include #include // Standard #include -#include #include // 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 _concept_identification_map_t; typedef std::map ::const_iterator _concept_identification_map_iter; typedef std::map ::iterator _concept_identification_map_nc_iter; -typedef std::vector _accumulator_vector_t; -typedef std::vector ::const_iterator _accumulator_vector_it; +typedef std::map _accumulator_map_t; +typedef std::map ::const_iterator _accumulator_map_it; +typedef std::map ::iterator _accumulator_map_nc_it; /** @@ -78,19 +82,19 @@ public: * * @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) ; /** * Stops statistics engine */ - void enable(void) throw() { a_enabled = true; } + void enable(void) { a_enabled = true; } /** * Starts statistics engine */ - void disable(void) throw() { a_enabled = false; } + void disable(void) { a_enabled = false; } /** * Enable sample log for statistics processings. Engine starts with this feature disabled. When a new concept id is added @@ -105,17 +109,18 @@ public: * @return @em false if not concept is registered with provided id * @warning Many systems add concepts dynamically. This method only affects to current concepts registered at statistics engine. */ - bool enableSampleLog(const int & id = -1, const char *sampleFileName = NULL) throw(); + bool enableSampleLog(const int & id = -1, const char *sampleFileName = NULL) ; /** * Disable sample log for statistics processings * - * @param id Concept identification. + * @param id Concept identification. If -1 value is provided, all concepts will be deactivated. * * @return @em false if not concept is registered with provided id + * @warning Many systems add concepts dynamically. This method only affects to current concepts registered at statistics engine. */ - bool disableSampleLog(const int & id) throw(); + bool disableSampleLog(const int & id = -1) ; // Gets @@ -129,29 +134,41 @@ public: * * @return @em false if not concept is registered with provided id */ - bool getConcept(const int & id, std::string & description, std::string & unit, bool & integerNatureSample) const throw(); + bool getConcept(const int & id, std::string & description, std::string & unit, bool & integerNatureSample) const ; /** * Boolean about engine state (enabled / disabled) */ - bool enabled(void) const throw() { return (a_enabled); } + bool enabled(void) const { 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. - * - * @return New allocated accumulator, to be used by the client - */ - Accumulator *createAccumulator() 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) noexcept(false); + + /** + * 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) ; + + /** * Class string representation * * @return String with class content */ - std::string asString(void) const throw(); + std::string asString(void) const ; /** @@ -161,7 +178,7 @@ public: * * @return XML with class content */ - anna::xml::Node* asXML(anna::xml::Node* parent, const int & numberOfDecimals = 2) const throw(); + anna::xml::Node* asXML(anna::xml::Node* parent, const int & numberOfDecimals = 2) const ; private: @@ -169,12 +186,12 @@ 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 - bool logSample(const int & conceptId, const anna::Millisecond & unixTimestamp, const double & value) const throw(); + bool logSample(const int & conceptId, const anna::Millisecond & unixTimestamp, const double & value) const ; friend class anna::Singleton ; friend class Accumulator;