PerformanceMonitor.h

Go to the documentation of this file.

// this is for emacs file handling -*- mode: c++; indent-tabs-mode: nil -*-

// -- BEGIN LICENSE BLOCK ----------------------------------------------
// This file is part of FZIs ic_workspace.
//
// This program is free software licensed under the LGPL
// (GNU LESSER GENERAL PUBLIC LICENSE Version 3).
// You can find a copy of this license in LICENSE folder in the top
// directory of the source code.
//
// © Copyright 2016 FZI Forschungszentrum Informatik, Karlsruhe, Germany
//
// -- END LICENSE BLOCK ------------------------------------------------

//----------------------------------------------------------------------
//----------------------------------------------------------------------/*

#ifndef ICL_CORE_TIMER_H
#define ICL_CORE_TIMER_H

#include <string>
#include <vector>
#include <map>
#include <ostream>

#include "icl_core_performance_monitor/logging_performance_monitor.h"
#include "icl_core_performance_monitor/PerformanceMonitorMacros.h"
#include "icl_core_performance_monitor/ImportExport.h"


#include <icl_core/TimeStamp.h>

namespace icl_core {
namespace perf_mon{


class ICL_CORE_PERFORMANCE_MONITOR_EXPORT PerformanceMonitor
{
public:
  static PerformanceMonitor* getInstance();

  static void initialize(const uint32_t num_names, const uint32_t num_events);

  static void start(std::string timer_name);

  static double measurement(std::string timer_name, std::string description, std::string prefix = "",
                          logging::LogLevel level = icl_core::logging::eLL_INFO);

  static double startStop(std::string timer_name, std::string description, std::string prefix = "",
                          logging::LogLevel level = icl_core::logging::eLL_INFO);

  static void addData(std::string name, double data, std::string prefix);

  static void addStaticData(std::string name, double data, std::string prefix);

  static void addNonTimeData(std::string name, double data, std::string prefix);

  static void enablePrefix(std::string prefix);

  static void enableAll(const bool& enabled);

  static void disablePrefix(std::string prefix);

  static void printSummary(std::string prefix, std::string name,
                           icl_core::logging::LogLevel level = icl_core::logging::eLL_INFO);

  static void printSummaryAll(icl_core::logging::LogLevel level = icl_core::logging::eLL_INFO);


  static void printSummaryFromPrefix(std::string prefix, icl_core::logging::LogLevel level = icl_core::logging::eLL_INFO);

  bool m_enabled;
  bool m_print_stop;

protected:
  PerformanceMonitor();
  ~PerformanceMonitor();

  void createStatisticSummary(std::stringstream& ss, std::string prefix, std::string name);
  void createStatisticSummaryNonTime(std::stringstream& ss, std::string prefix, std::string name);


  void print(std::string message, icl_core::logging::LogLevel level = icl_core::logging::eLL_DEBUG);

  void addEvent(std::string prefix, std::string name, double data);
  void addNonTimeEvent(std::string prefix, std::string name, double data);

  bool isEnabled(std::string prefix);

  double getAverage(std::string name);
  double getAverageNonTime(std::string name);

  void getMedian(std::string name, double& median, double& min, double& max);
  void getMedianNonTime(std::string name, double& median, double& min, double& max);

  std::map<std::string, std::vector<double> > m_data;
  std::map<std::string, std::vector<double> > m_data_nontime;
  std::map<std::string, TimeStamp> m_timer;
  std::vector<std::vector<double> > m_buffer;
  std::map<std::string, bool> m_enabled_prefix;
  std::map<std::string, double > m_static_data;

  bool m_all_enabled;


private:
  static PerformanceMonitor* m_instance;
};


} // namespace perf_mon
} // namespace icl_core

#endif /* ICL_CORE_TIMER_H */