-// ANNA - Anna is Not 'N' 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
#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>
namespace statistics {
+class Accumulator;
+
+
typedef struct {
std::string SampleFile; // Sample file to optional writtings
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::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;
/**
public:
+ /** Destructor */
+ ~Engine();
+
// Sets
/**
*
* @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
* @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
*
* @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); }
+
+
+ /**
+ * 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) ;
+
/**
*
* @return String with class content
*/
- std::string asString(void) const throw();
+ std::string asString(void) const ;
/**
*
* @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:
Engine(); // private constructor
_concept_identification_map_t a_concept_identification_map;
+ _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 <Engine>;
friend class Accumulator;