statistics.hpp

Go to the documentation of this file.

//
// Copyright (c) 2017 CNRS
//
// This file is part of tsid
// tsid is free software: you can redistribute it
// and/or modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation, either version
// 3 of the License, or (at your option) any later version.
// tsid is distributed in the hope that it will be
// useful, but WITHOUT ANY WARRANTY; without even the implied warranty
// of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Lesser Public License for more details. You should have
// received a copy of the GNU Lesser General Public License along with
// tsid If not, see
// <http://www.gnu.org/licenses/>.
//

#ifndef __invdyn_statistics_H__
#define __invdyn_statistics_H__

#include <iostream>
#include <map>
#include <sstream>

#define STATISTICS_MAX_NAME_LENGTH 60

// Generic statistics exception class
struct StatisticsException {
 public:
  StatisticsException(std::string error) : error(error) {}
  std::string error;
};

class Statistics {
 public:
  Statistics();

  ~Statistics();

  bool quantity_exists(std::string name);

  void store(std::string name, const double& value);

  void reset(std::string name);

  void reset_all();

  void report(std::string name, int precision = 2,
              std::ostream& output = std::cout);

  void report_all(int precision = 2, std::ostream& output = std::cout);

  long double get_total(std::string name);

  long double get_average(std::string name);

  long double get_min(std::string name);

  long double get_max(std::string name);

  long double get_last(std::string name);

  void turn_off();

  void turn_on();

 protected:
  struct QuantityData {
    QuantityData() : total(0), min(0), max(0), last(0), stops(0) {}

    long double total;

    long double min;

    long double max;

    long double last;

    int stops;
  };

  bool active;

  std::map<std::string, QuantityData>* records_of;
};

Statistics& getStatistics();

#endif