# EA31337-classes

**Repository Path**: qinyi.git.org/EA31337-classes

## Basic Information

- **Project Name**: EA31337-classes
- **Description**: :page_facing_up: EA31337 framework (MQL library for writing EAs)
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-08-14
- **Last Updated**: 2021-08-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# EA31337 Framework

[![Tag][github-tag-image]][github-tag-link]
[![License][license-image]][license-link]
[![AppVeyor][appveyor-ci-build-link]][appveyor-ci-build-image]
[![Status][gha-image-check-master]][gha-link-check-master]
[![Status][gha-image-lint-master]][gha-link-lint-master]
[![Status][gha-image-test-master]][gha-link-test-master]
[![Channel][tg-channel-image]][tg-channel-link]
[![Chat][tg-chat-image]][tg-chat-link]
[![Edit Code][gitpod-image]][gitpod-link]

EA31337 framework is designed for writing trading robots for MetaTrader 4 and 5 platforms.
It can be also used to convert your MQL4 code into MQL5 with minimum code changes.

## Table of contents

<!-- TOC -->

- [About the project](#about-the-project)
  - [Table of contents](#table-of-contents)
  - [Build status](#build-status)
  - [Conversion](#conversion)
    - [MQL4 to MQL5 conversion](#mql4-to-mql5-conversion)
  - [Classes](#classes)
    - [`Account` class](#account-class)
      - [Example 1 - Managing account (dynamic calls)](#example-1---managing-account-dynamic-calls)
      - [Example 2 - Managing account (static calls)](#example-2---managing-account-static-calls)
    - [`Collection` class](#collection-class)
    - [`Dict` class](#dict-class)
      - [Example 1 - Storing string-int data structures](#example-1---storing-string-int-data-structures)
    - [`Mail` class](#mail-class)
      - [Example 1 - Send e-mail on trade execution](#example-1---send-e-mail-on-trade-execution)
    - [`Indicator` class](#indicator-class)
    - [`Indicators/` classes](#indicators-classes)
      - [Example 1 - `AC` indicator](#example-1---ac-indicator)
      - [Example 2 - `Alligator` indicator](#example-2---alligator-indicator)
    - [`IndicatorData` class](#indicatordata-class)
    - [`Profiler` class](#profiler-class)
      - [Example 1 - Measure execution time of function multiple times](#example-1---measure-execution-time-of-function-multiple-times)
      - [Example 2 - Measure execution time of function multiple times](#example-2---measure-execution-time-of-function-multiple-times)
    - [`SymbolInfo` class](#symbolinfo-class)
      - [Example 1 - Accessing symbol's data (dynamic)](#example-1---accessing-symbols-data-dynamic)
      - [Example 2 - Accessing symbol's data (static)](#example-2---accessing-symbols-data-static)
    - [`Timer` class](#timer-class)
      - [Example 1 - Single timer](#example-1---single-timer)
      - [Example 2 - Multiple timers](#example-2---multiple-timers)
      - [Support](#support)

<!-- /TOC -->

## Build status

| Type            | Status      |
| --------------: |:-----------:|

## Conversion

### MQL4 to MQL5 conversion

This framework can be used to convert your MQL4 code to be compatible with both MQL4 and MQL5.

Here is the table of conversion (replace code on left with right):

| MQL4 (original)      | MQL4 & MQL5 (replace with) | Required include file |
|:---------------------|:---------------------------|:----------------------|
| `WindowRedraw()`     | `Chart::WindowRedraw()`    | `Chart.mqh`           |
| `Day()`              | `DateTime::Day()` | `DateTime.mqh` |
| `TimeDayOfWeek()`    | `DateTime::DayOfWeek()` | `DateTime.mqh` |
| `DayOfWeek()`        | `DateTime::DayOfWeek()` | `DateTime.mqh` |
| `DayOfYear()`        | `DateTime::DayOfYear()` | `DateTime.mqh` |
| `Hour()`             | `DateTime::Hour()` | `DateTime.mqh` |
| `Month()`            | `DateTime::Month()` | `DateTime.mqh` |
| `TimeDay()`          | `DateTime::TimeDay()` | `DateTime.mqh` |
| `TimeDayOfYear()`    | `DateTime::TimeDayOfYear()` | `DateTime.mqh` |
| `TimeToStr()`        | `DateTime::TimeToStr()` | `DateTime.mqh` |
| `Year()`             | `DateTime::Year()` | `DateTime.mqh` |
| `iAC()`              | `Indi_AC::iAC()` | `Indicators/Indi_AC.mqh` |
| `iAD()`              | `Indi_AD::iAD()` | `Indicators/Indi_AD.mqh` |
| `iADX()`             | `Indi_ADX::iADX()` | `Indicators/Indi_ADX.mqh` |
| `iAO()`              | `Indi_AO::iAO()` | `Indicators/Indi_AO.mqh` |
| `iATR()`             | `Indi_ATR::iATR()` | `Indicators/Indi_ATR.mqh` |
| `iBWMFI()`           | `Indi_BWMFI::iBWMFI()` | `Indicators/Indi_BWMFI.mqh` |
| `iBands()`           | `Indi_Bands::iBands()` | `Indicators/Indi_Bands.mqh` |
| `iBearsPower()`      | `Indi_BearsPower::iBearsPower()` | `Indicators/Indi_BearsPower.mqh` |
| `iBullsPower()`      | `Indi_BullsPower::iBullsPower()` | `Indicators/Indi_BullsPower.mqh` |
| `iCCI()`             | `Indi_CCI::iCCI()` | `Indicators/Indi_CCI.mqh` |
| `iDeMarker()`        | `Indi_DeMarker::iDeMarker()` | `Indicators/Indi_DeMarker.mqh` |
| `iEnvelopes()`       | `Indi_Envelopes::iEnvelopes()` | `Indicators/Indi_Envelopes.mqh` |
| `iForce()`           | `Indi_Force::iForce()` | `Indicators/Indi_Force.mqh` |
| `iFractals()`        | `Indi_Fractals::iFractals()` | `Indicators/Indi_Fractals.mqh` |
| `iGator()`           | `Indi_Gator::iGator()` | `Indicators/Indi_Gator.mqh` |
| `iIchimoku()`        | `Indi_Ichimoku::iIchimoku()` | `Indicators/Indi_Ichimoku.mqh` |
| `iMA()`              | `Indi_MA::iMA()` | `Indicators/Indi_MA.mqh` |
| `iMACD()`            | `Indi_MAcD::iMACD()` | `Indicators/Indi_MACD.mqh` |
| `iMFI()`             | `Indi_MFI::iMFI()` | `Indicators/Indi_MFI.mqh` |
| `iMomentum()`        | `Indi_Momentum::iMomentum()` | `Indicators/Indi_Momentum.mqh` |
| `iOBV()`             | `Indi_OBV::iOBV()` | `Indicators/Indi_OBV.mqh` |
| `iOsMA()`            | `Indi_OsMA::iOsMA()` | `Indicators/Indi_OsMA.mqh` |
| `iRSI()`             | `Indi_RSI::iRSI()` | `Indicators/Indi_RSI.mqh` |
| `iRVI()`             | `Indi_RVI::iRVI()` | `Indicators/Indi_RVI.mqh` |
| `iSAR()`             | `Indi_SAR::iSAR()` | `Indicators/Indi_SAR.mqh` |
| `iStdDev()`          | `Indi_StdDev::iStdDev()` | `Indicators/Indi_StdDev.mqh` |
| `iStochastic()`      | `Indi_Stochastic::iStochastic()` | `Indicators/Indi_Stochastic.mqh` |
| `iWPR()`             | `Indi_WPR::iWPR()` | `Indicators/Indi_WPR.mqh` |
| `RefreshRates()`     | `Market::RefreshRates()` | `Market.mqh` |
| `delete object`      | `Object::Delete(object)` | `Object.mqh` |
| `GetOrderProfit()`   | `Order::GetOrderProfit()` | `Order.mqh` |
| `OrderClose()`       | `Order::OrderClose()` | `Order.mqh` |
| `OrderCloseTime()`   | `Order::OrderCloseTime()` | `Order.mqh` |
| `OrderCommission()`  | `Order::OrderCommission()` | `Order.mqh` |
| `OrderLots()`        | `Order::OrderLots()` | `Order.mqh` |
| `OrderMagicNumber()` | `Order::OrderMagicNumber()` | `Order.mqh` |
| `OrderOpenPrice()`   | `Order::OrderOpenPrice()` | `Order.mqh` |
| `OrderOpenTime()`    | `Order::OrderOpenTime()` | `Order.mqh` |
| `OrderPrint()`       | `Order::OrderPrint()` | `Order.mqh` |
| `OrderSelect()`      | `Order::OrderSelect()` | `Order.mqh` |
| `OrderStopLoss()`    | `Order::OrderStopLoss()` | `Order.mqh` |
| `OrderSymbol()`      | `Order::OrderSymbol()` | `Order.mqh` |
| `OrderTicket()`      | `Order::OrderTicket()` | `Order.mqh` |
| `OrderType()`        | `Order::OrderType()` | `Order.mqh` |
| `OrdersTotal()`      | `Orders::OrdersTotal()` | `Order.mqh` |

Here are the special [predefined variables](https://docs.mql4.com/predefined) conversion:

| MQL4 (original)      | MQL4 & MQL5 (replace with) | Required include file |
|:---------------------|:-----------------------------|:-----------------|
| `Ask`                | `SymbolInfo::GetAsk()`       | `SymbolInfo.mqh` |
| `Bars`               | `Chart::iBars()`             | `Chart.mqh`      |
| `Bid`                | `SymbolInfo::GetBid()`       | `SymbolInfo.mqh` |
| `Close[]`            | `Chart::iClose()`            | `Chart.mqh`      |
| `Digits`             | `SymbolInfo::GetDigits()`    | `SymbolInfo.mqh` |
| `High[]`             | `Chart::iHigh()`             | `Chart.mqh`      |
| `Low[]`              | `Chart::iLow()`              | `Chart.mqh`      |
| `Open[]`             | `Chart::iOpen()`             | `Chart.mqh`      |
| `Point`              | `SymbolInfo::GetPointSize()` | `SymbolInfo.mqh` |
| `Time[]`             | `Chart::iTime()`             | `Chart.mqh`      |
| `Volume[]`           | `Chart::iVolume()`           | `Chart.mqh`      |

## Classes

### `Account` class

The class for managing the current trading account.

#### Example 1 - Managing account (dynamic calls)

    Account *acc = new Account();
    double _balance = acc.GetBalance();
    double _credit = acc.GetCredit();
    double _equity = acc.GetEquity();
    double _margin_free = acc.GetMarginFree();
    double _margin_used = acc.GetMarginUsed();
    if (acc.IsExpertEnabled() && acc.IsTradeAllowed()) {
      // Some trade code.
    }
    delete acc;

#### Example 2 - Managing account (static calls)

    double _balance = Account::AccountBalance();
    double _credit = Account::AccountCredit();
    double _equity = Account::AccountEquity();
    double _margin_free = Account::AccountFreeMargin();
    double _margin_used = Account::AccountMargin();
    if (Account::IsExpertEnabled() && Account::IsTradeAllowed()) {
      // Some trade code.
    }

### `Collection` class

This class is for storing various type of objects. Here is the example usage:

    // Define custom classes of Object type.
    class Stack : Object {
      public:
        virtual string GetName() = NULL;
    };
    class Foo : Stack {
      public:
        string GetName() { return "Foo"; };
        double Weight() { return 0; };
    };
    class Bar : Stack {
      public:
        string GetName() { return "Bar"; };
        double Weight() { return 1; };
    };
    class Baz : Stack {
      public:
        string GetName() { return "Baz"; };
        double Weight() { return 2; };
    };

    int OnInit() {
      // Define and add items.
      Collection *stack = new Collection();
      stack.Add(new Foo);
      stack.Add(new Bar);
      stack.Add(new Baz);
      // Print the lowest and the highest items.
      Print("Lowest: ", ((Stack *)stack.GetLowest()).GetName());
      Print("Highest: ", ((Stack *)stack.GetHighest()).GetName());
      // Print all the items.
      for (uint i = 0; i < stack.GetSize(); i++) {
        Print(i, ": ", ((Stack *)stack.GetByIndex(i)).GetName());
      }
      // Clean up.
      Object::Delete(stack);
      return (INIT_SUCCEEDED);
    }

### `Dict` class

Use this class to store the values in form of a collective attribute–value pairs,
in similar way as [associative arrays](https://en.wikipedia.org/wiki/Associative_array)
with a [hash table](https://en.wikipedia.org/wiki/Hash_table) work.

#### Example 1 - Storing string-int data structures

Example of storing key-value data with string as a key:

    Dict<string, int> data1;
    data1.Set("a", 1);
    data1.Set("b", 2);
    data1.Set("c", 3);
    data1.Unset("c");
    Print(data1.GetByKey("a"));

### `Mail` class

The purpose of `Mail` class is to provide common functionality for managing e-mails.

#### Example 1 - Send e-mail on trade execution

Example sending e-mail on trade execution:

    int OnInit() { // @see: https://www.mql5.com/en/docs/event_handlers/oninit
      Mail *mail = new Mail();
      mail.SetSubjectPrefix("Trading");
    }
    void OnTrade() { // @see: https://www.mql5.com/en/docs/event_handlers/ontrade
      if (!Terminal::IsRealtime()) {
        mail.SendMailExecuteOrder();
      }
    }
    int OnDeinit() { // @see: https://www.mql5.com/en/docs/event_handlers/ondeinit
      delete mail;
    }

### `Indicator` class

The purpose of `Indicator` class is to provide common functionality
across all indicators such as storing and searching for values.

This class is used as a base class to handle technical indicator classes
which can be found in [`Indicators/`](Indicators/) folder.

### `Indicators/` classes

In [`Indicators/`](Indicators/) folder there is collection of indicator classes.

#### Example 1 - `AC` indicator

The example reading value from `AC` indicator:

    #include <EA31337-classes/Indicators/Indi_AC.mqh>
    int OnInit() {
      Indi_AC ac = new Indi_AC();
      PrintFormat("%g", ac.GetValue());
      delete ac;
    }

#### Example 2 - `Alligator` indicator

The example reading values from `Alligator` indicator:

    #include <EA31337-classes/Indicators/Indi_Alligator.mqh>
    int OnInit() {
      AlligatorParams alli_params(13, 8, 8, 5, 5, 3, MODE_SMMA, PRICE_MEDIAN);
      Indi_Alligator alli = new Indi_Alligator(alli_params));
      AlligatorEntry values = alli.GetEntry(0);
      if (alli.GetState().IsReady()) {
        Print("Alligator values: ", values.ToString());
      }
      delete alli;
    }

### `IndicatorData` class

The purpose of `IndicatorData` class is to store indicator data.
It is basically alternative implementation of `Indicator` class.

For more details, please read: [Class to hold indicator values](https://github.com/EA31337/EA31337-classes/issues/23).

For implementation example, check [`tests/IndicatorDataTest.mq4`](tests/IndicatorDataTest.mq4).

### `Profiler` class

The purpose of `Profiler` class is to profile functions by measuring its time of execution.
The minimum threshold can be set, so only slow execution can be reported.

#### Example 1 - Measure execution time of function multiple times

Example to measure execution time of function multiple times,
then printing the summary of all calls which took 5ms or more.

    #include "Profiler.mqh"

    void MyFunction() {
      PROFILER_START
      Sleep(rand()%10);
      PROFILER_STOP
    }

    int OnInit() {
      for (uint i = 0; i < 10; i++) {
        MyFunction();
      }
      // Set minimum threshold of 5ms.
      PROFILER_SET_MIN(5)
      // Print summary of slow executions above 5ms.
      PROFILER_PRINT
      return (INIT_SUCCEEDED);
    }

    void OnDeinit(const int reason) {
      PROFILER_DEINIT
    }

#### Example 2 - Measure execution time of function multiple times

Example to measure execution time of function multiple times, then automatically printing all calls which took 5ms or more.

    #include "Profiler.mqh"

    void MyFunction() {
      PROFILER_START
      Sleep(rand()%10);
      // Automatically prints slow executions.
      PROFILER_STOP_PRINT
    }

    int OnInit() {
      // Set minimum threshold of 5ms.
      PROFILER_SET_MIN(5);
      for (uint i = 0; i < 10; i++) {
        MyFunction();
      }
      return (INIT_SUCCEEDED);
    }

    void OnDeinit(const int reason) {
      PROFILER_DEINIT
    }

### `SymbolInfo` class

The class to manage the symbol's information.

#### Example 1 - Accessing symbol's data (dynamic)

    SymbolInfo *si = new SymbolInfo();
    string symbol = si.GetSymbol();
    MqlTick tick = si.GetTick()
    double ask = si.GetLastAsk();
    double bid = si.GetLastBid();
    uint spread = si.GetSpread();
    Print("MARKET: ", si.ToString());
    delete si;

#### Example 2 - Accessing symbol's data (static)

    string symbol = SymbolInfo::GetCurrentSymbol();
    MqlTick tick = SymbolInfo::GetTick(symbol)
    double ask = SymbolInfo::GetAsk(symbol);
    double bid = SymbolInfo::GetBid(symbol);
    uint spread = SymbolInfo::GetSpread(symbol);

### `Timer` class

The purpose of`Timer` class is to measure time between starting and stopping points.

#### Example 1 - Single timer

Single timer:

    #include "Timer.mqh"

    Timer *timer = new Timer("mytimer");
    timer.Start();
    // Some code to measure here.
    timer.Stop();
    Print("Time (ms): ", timer.GetSum());
    timer.PrintSummary();
    delete timer;

#### Example 2 - Multiple timers

Multiple measurements:

    #include "Timer.mqh"

    Timer *timer = new Timer(__FUNCTION__);
      for (uint i = 0; i < 5; i++) {
        timer.Start();
        Sleep(10); // Some code to measure here.
        PrintFormat("Current time elapsed before stop (%d/5): %d", i + 1, timer.GetTime());
        timer.Stop();
        PrintFormat("Current time elapsed after stop (%d/5): %d", i + 1, timer.GetTime(i));
      }
    timer.PrintSummary();
    delete timer;

#### Support

- For bugs/features, raise a [new issue at GitHub](https://github.com/EA31337/EA31337-classes/issues).
- Join our [Telegram group](https://t.me/EA31337) and [channel](https://t.me/EA31337_Announcements) for support.

<!-- Named links -->

[github-tag-image]: https://img.shields.io/github/tag/EA31337/EA31337-classes.svg?logo=github
[github-tag-link]: https://github.com/EA31337/EA31337-classes/tags

[license-image]: https://img.shields.io/github/license/EA31337/EA31337-classes.svg
[license-link]: https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)

[appveyor-ci-build-link]: https://ci.appveyor.com/project/kenorb/ea31337-classes/branch/master
[appveyor-ci-build-image]: https://ci.appveyor.com/api/projects/status/543yj94k3m50gy0g/branch/master?svg=true

[gha-link-check-master]: https://github.com/EA31337/EA31337-classes/actions?query=workflow%3ACheck+branch%3Amaster
[gha-image-check-master]: https://github.com/EA31337/EA31337-classes/workflows/Check/badge.svg

[gha-link-lint-master]: https://github.com/EA31337/EA31337-classes/actions?query=workflow%3ALint+branch%3Amaster
[gha-image-lint-master]: https://github.com/EA31337/EA31337-classes/workflows/Lint/badge.svg

[gha-link-test-master]: https://github.com/EA31337/EA31337-classes/actions?query=workflow%3ATest+branch%3Amaster
[gha-image-test-master]: https://github.com/EA31337/EA31337-classes/workflows/Test/badge.svg

[tg-channel-image]: https://img.shields.io/badge/Telegram-news-0088CC.svg?logo=telegram
[tg-channel-link]: https://t.me/EA31337_News
[tg-chat-image]: https://img.shields.io/badge/Telegram-chat-0088CC.svg?logo=telegram
[tg-chat-link]: https://t.me/EA31337

[gitpod-image]: https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod
[gitpod-link]: https://gitpod.io/#https://github.com/EA31337/EA31337-classes