/////////////////////////////////////////////////////// // // SaherElm IT Center XTest MQL5 Expert Advisor // ------------------------------------------------- // Name: XEATemplate // Description: a Template For Exper Advisors // // Maintainer: // ------------ // Hadi Khazaee Asl (hadi_khazaee_asl@yahoo.com) // //////////////////////////////////////////////////////x // // Global Properties ... #property copyright "Copyright 2023, SaherElm IT Center" #property link "https://saherelm.ir" #property version "1.00" #property description "SaherElm XEATemplate" #property strict // #define ShortName "XEATemplate" // // Imports ... #include "../Classes/x-saherelm.xalert.class.mq5" #include "../Classes/x-saherelm.xtrade.class.mq5" #include "../Helpers/x-saherelm.xcc.helper.mq5" #include "../Helpers/x-saherelm.xct.helper.mq5" // // Inputs ... // // Common ... input group "Common"; input long eaMagicNumber = 78692110; // Magic Number input int eaSlippage = 10; // Slippgae input string eaLogSuffix = ""; // Log Suffix // // Alert ... // Here we Provider All Requirements for // Configuring Alert Provider ... input group "Alert"; input bool eAEnableAlerts = true; // Enable Alerts input bool eALogAlerts = true; // Log Alerts input bool eAMailAlerts = false; // Mail Alerts input bool eAPushAlerts = false; // Push Alerts input bool eATerminalAlerts = false; // Terminal Alerts // // Time Report ... input group "Reports"; input bool eaReportNewMonths = false; // Report New Month input bool eaReportNewWeeks = false; // Report New Weeks input bool eaReportNewDays = false; // Report New Days input bool eaReportNewHours = false; // Report New Hours // // Define Local Variables ... // string eaLogTag; // EA Log Prefix ... XSCAlert *eaAlert; // Alert Provider for Expert Adviser ... XSCTrade *eaTrader; // Trader of Expert Adviser ... XTimeTracker eaTimeTracker; // Time Tracker for Providing Reports ... XSCXCTHelper *eaCHelper; // Bar Timer Indicator Helper class ... XSCXCCHelper *eaCCHelper; // Chart Styler Indicator Helper Class ... // // Event Handlers ... // // Initialization ... int OnInit() { // // Validate Inputs and Required Parameters // for EA to Works fine ... if (!ValidateInputs()) { return INIT_PARAMETERS_INCORRECT; } // // Initialize Timer ... if (!InitTimer()) { return INIT_FAILED; } // // Initialize all Requirements ... if (!InitEA()) { return INIT_FAILED; } // // Initialize all GUI Objects and Classes ... if (!InitGUI()) { return INIT_FAILED; } // // Alert Initialization ... string msg = "Initialized Successfully ..."; eaAlert.SendAlert(msg); // // Init Succeed ... return INIT_SUCCEEDED; } // // DeInitialization ... void OnDeinit(const int reason) { // // REASON_PROGRAM 0 The EA has stopped working calling the ExpertRemove() function // REASON_REMOVE 1 Program removed from a chart // REASON_RECOMPILE 2 Program recompiled // REASON_CHARTCHANGE 3 A symbol or a chart period is changed // REASON_CHARTCLOSE 4 Chart closed // REASON_PARAMETERS 5 Inputs changed by a user // REASON_ACCOUNT 6 Another account has been activated or reconnection to the trade server has occurred due to changes in the account settings // REASON_TEMPLATE 7 Another chart template applied // REASON_INITFAILED 8 The OnInit() handler returned a non-zero value // REASON_CLOSE 9 Terminal closed // // Destroy Timer ... DestroyTimer(); // // Destroy all GUI Requirements ... DestroyGUI(); // // Alert De Initialization Succeeded ... string msg = "De Initialized Successfully ..."; eaAlert.SendAlert(msg); // // Destroy all EA Requirements ... DestroyEA(); } // // On Tick Handler ... void OnTick() { // UpdateGUI(); HandleReportTime(); UpdatePositionsState(); // // TODO: Implemetn Tick Processors Algorithm ... } // // Handle On Trade Event ... void OnTrade() { eaTrader.HandleOnTrade(); } // // On Timer ... void OnTimer() { // // TODO: Implement Time Based Functionalities ... } // // Chart Event Handler ... void OnChartEvent( const int id, const long &lparam, const double &dparam, const string &sparam // ) { // // Handle OnClick Event ... if (id == CHARTEVENT_OBJECT_CLICK) { HandleOnClickEvent(sparam); } } // // Custom Event Handlers ... /** * Handle StopLoss Triggered Positions ... * * @param deal: XDeal ... */ void OnStopLossTriggered(const XDeal &deal) { // HandleReportBalance(); } /** * Handle Take Profit Triggered Positions ... * * @param deal: XDeal ... */ void OnTakeProfitTriggered(const XDeal &deal) { // HandleReportBalance(); } /** * Handle Force Close a Position ... * * @param ticket: Position Ticket ... * @param position: XPosition ... * @param comment: Closing Comment ... */ void OnPositionForceClosed( const ulong ticket, const XPosition &position, const string comment // ) { // HandleReportBalance(); } // // Custom Functions ... /** * Validate all Inputs of Expert Adviser ... * * @return ( bool ) */ bool ValidateInputs() { // bool result = false; // string errMessage = ""; // bool isCommonValid = ( // eaSlippage > 0 && eaMagicNumber > 0 // ); if (!isCommonValid) { // errMessage += "common configurations error;" + "\n"; } // result = // // Common ... isCommonValid && // // Otere ... true // ; // if (!result) { // // Since here Logger not Initiallized, we Use Raw Print Command ... Print(ShortName + " Errors: \n", errMessage); } // return result; } /** * Initialize Timer ... * * @return ( bool ) */ bool InitTimer() { // bool result = false; // // TODO: Initialize Timer if necessary ... // result = EventSetTimer(1); // result = EventSetMillisecondTimer(100); result = true; // return result; } /** * Destroy Timer ... */ void DestroyTimer() { // // TODO: Use This ... // EventKillTimer(); } /** * Initialize all Requirements for Working Fine ... * * @return ( bool ) */ bool InitEA() { // bool result = false; // // Locally Apply Changes on Prefix ... eaLogTag = ShortName + ">" + eaLogSuffix; // // Bar Timer ... XCTInputs ctInputs; ctInputs.Default(); // Default Configurations ... eaCHelper = new XSCXCTHelper(); result = eaCHelper.Init( _Symbol, _Period, ctInputs // ); if (!result) { return result; } // // Bar Styles ... XCCInputs ccInputs; ccInputs.Default(); // Default Configurations ... eaCCHelper = new XSCXCCHelper(); result = eaCCHelper.Init( _Symbol, _Period, ccInputs // ); if (!result) { return result; } // // Create Instance of Alert Class and Configure it ... eaAlert = new XSCAlert(); eaAlert.SetPrefix(eaLogTag); eaAlert.SetLogAlerts(eALogAlerts); eaAlert.SetMailAlerts(eAMailAlerts); eaAlert.SetPushAlerts(eAPushAlerts); eaAlert.SetEnableAlerts(eAEnableAlerts); eaAlert.SetTerminalAlerts(eATerminalAlerts); // // Create Trader Instance and Configure it ... eaTrader = new XSCTrade( eaSlippage, eaMagicNumber // ); eaTrader.AddOnStopLossEventHandler(OnStopLossTriggered); eaTrader.AddOnTakeProfitEventHandler(OnTakeProfitTriggered); eaTrader.AddOnForceClosePositionEventHandler(OnPositionForceClosed); // return result; } /** * Destroy all Initialized EA Requirements ... */ void DestroyEA() { // delete eaCHelper; delete eaCCHelper; // delete eaAlert; } /** * Initialize all GUI Requirements for EA ... * * @return ( bool ) */ bool InitGUI() { // bool result = false; // // TODO: Fix This ... result = true; // return result; } /** * Update GUI based on Each Ticks ... */ void UpdateGUI() { // // TODO: Implement this ... } /** * Destroy all Initialized GUi Requirements ... */ void DestroyGUI() { // // TODO: Complete this ... } // // Others ... /** * Update Positions States ... */ void UpdatePositionsState() { // // TODO: Implement this ... } /** * Handle On Click Event for GUI Components ... * * @param name: Object Name ... */ void HandleOnClickEvent(string name) { // if (!IsValid(name)) { return; } // bool isClicked = false; // // TODO: Implement Chart Objects On Click ... // if (isClicked) { UpdateGUI(); } } /** * Report Account Balance ... */ void HandleReportBalance() { // if (!IsRunningOnTestMode()) { return; } // string msg = "Balance: " + ToString(eaTrader.mAccount.GetBalance()); eaAlert.Log(msg); } /** * Time Reporting based on Inputs ... */ void HandleReportTime() { // // Monthly Report .... if (eaReportNewMonths && eaTimeTracker.IsNewMonth()) { // string msg = "New Month ..."; // eaAlert.SendAlert(msg); } // // Weekly Report .... if (eaReportNewWeeks && eaTimeTracker.IsNewWeek()) { // string msg = "New Week ..."; // eaAlert.SendAlert(msg); } // // Daily Report .... if (eaReportNewDays && eaTimeTracker.IsNewDay()) { // string msg = "New Day ..."; // eaAlert.SendAlert(msg); } // // Hourly Report .... if (eaReportNewHours && eaTimeTracker.IsNewHour()) { // string msg = "New Hour ..."; // eaAlert.SendAlert(msg); } } //