Stats.mqh

//+------------------------------------------------------------------+
//|                                                EA31337 framework |
//|                                 Copyright 2016-2021, EA31337 Ltd |
//|                                       https://github.com/EA31337 |
//+------------------------------------------------------------------+

/*
 * This file is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

// Includes.
#include "Chart.mqh"

/**
 * Class to collect ticks, bars and other data for statistical purposes.
 */
class Stats {
 public:
  ulong total_bars;
  ulong total_ticks;
  int curr_period;
  // int custom_int[];
  // double custom_dbl[];

  /**
   * Implements class constructor.
   */
  Stats(void) { Reset(); }

  /**
   * Implements class destructor.
   */
  ~Stats(void) {}

  void Reset() {
    curr_period = Period();
    total_bars = 0;
    total_ticks = 0;
  }

  /**
   * Update stats on tick.
   */
  void OnTick() {
    static long _last_bar_time = 0;
    total_ticks++;
    if (_last_bar_time != ChartStatic::iTime(_Symbol, 0, 0)) {
      _last_bar_time = ChartStatic::iTime(_Symbol, 0, 0);
      total_bars++;
    }
  }

  /**
   * Update stats on deinit.
   */
  void OnDeinit() {}

  /* Getters */

  /**
   * Get number of counted bars.
   */
  ulong GetTotalBars() { return (total_bars); }

  /**
   * Get number of counted ticks.
   */
  ulong GetTotalTicks() { return (total_ticks); }

  /**
   * Get number of ticks per bar.
   */
  ulong GetTicksPerBar() { return (total_bars > 0 ? (total_ticks / total_bars) : 0); }

  /**
   * Get number of ticks per minute.
   */
  ulong GetTicksPerMin() { return (total_bars > 0 ? (total_ticks / total_bars / curr_period) : 0); }

  /**
   * Get number of ticks per second.
   */
  double GetTicksPerSec() { return round(total_bars > 0 ? (total_ticks / total_bars / curr_period) / 60 : 0); }

  /**
   * Get number of ticks per given time period.
   */
  ulong GetTicksPerPeriod(int period = PERIOD_H1) { return (GetTicksPerMin() * period); }

  /**
   * Get number of bars per given time period.
   */
  ulong GetBarsPerPeriod(int period = PERIOD_H1) { return (total_bars / period); }
};