Engine.hpp

Go to the documentation of this file.

// 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
#define 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>
#include <map>

// Local
#include <anna/statistics/Accumulator.hpp>

namespace anna {
namespace xml {
class Node;
}
}



namespace anna {

namespace statistics {


class Accumulator;


typedef struct {

  std::string SampleFile; // Sample file to optional writtings
  std::string Description;
  std::string Unit;
  bool IntegerNatureSample;

} _concept_identification_t;

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::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;


class Engine : public anna::Singleton <Engine> {


public:

  ~Engine();

  // Sets

  int addConcept(const std::string & description, const std::string & unit, const bool & integerNatureSample = true) ;


  void enable(void) { a_enabled = true; }


  void disable(void) { a_enabled = false; }

  bool enableSampleLog(const int & id = -1, const char *sampleFileName = NULL) ;


  bool disableSampleLog(const int & id = -1) ;

  // Gets

  bool getConcept(const int & id, std::string & description, std::string & unit, bool & integerNatureSample) const ;


  bool enabled(void) const { return (a_enabled); }


  Accumulator *createAccumulator(const std::string &name) noexcept(false);

  Accumulator* getAccumulator(const std::string &name) ;



  std::string asString(void) const ;


  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 ;

  friend class anna::Singleton <Engine>;
  friend class Accumulator;
};


}
}

#endif