///////////////////////////////////////////////////////
//
// SaherElm IT Center MQL5 Class Library
// ----------------------------------------------
// Name: XSCX121SetupCycle
// Description: provides implementation of X121
// Setup on Specified Market Cycle ...
//
//
// Maintainer:
// ------------
// Hadi Khazaee Asl (hadi_khazaee_asl@yahoo.com)
//
//////////////////////////////////////////////////////
//
// Global Properties ...
#property library
#property copyright "Copyright 2023, SaherElm IT Center"
#property link "https://www.saherelm.ir"
#property version "1.00"
#property strict

//
// Imports ...

//
#include "../Classes/x-saherelm.xea.class.mq5"
#include "../Classes/x-saherelm.x121.setup.class.mq5"

//
// Definitions ...

//
// Class ...
class XSCX121SetupEA : public XSCBaseEA
{
    //
    // Public ...
public:
    //
    // Props ...

    //
    // Constructors ...
    XSCX121SetupEA(
        //
        // XTrade Class Requirements ...
        int slippage,      // Specify Slippage
        ulong magicNumber, // Specify Magic Number
        //
        // XSCTrade Event Handlers ...
        TOnStopLoss onStopLossTriggered = NULL,                // On StopLoass Triggered Event Handler
        TOnTakeProfit onTakeProfitTriggered = NULL,            // On TakeProfit Triggered Event Handler
        TOnDealsChanged onDealsChangedHandler = NULL,          // On Deals Changed Event Handler
        TOnOrdersChanged onOrdersChangedHandler = NULL,        // On Orders Changed Event Handler
        TOnPositionsChanged onPositionsChangedHandler = NULL,  // On Positions Changed Event Handler
        TOnTradeStateChanged onTradeStateChangedHandler = NULL // On Trade State Changed Event Handler
        ) : XSCBaseEA(slippage,
                      magicNumber,
                      onStopLossTriggered,
                      onTakeProfitTriggered,
                      onDealsChangedHandler,
                      onOrdersChangedHandler,
                      onPositionsChangedHandler,
                      onTradeStateChangedHandler //
            )
    {
        //
    }

    //
    // Deconstructor ...
    ~XSCX121SetupEA()
    {
    }

    //
    // Overrides ...

    //
    // Customize Token ...
    string GetToken() override
    {
        return GetSpecificToken(this);
    }

    //
    string GetTag() override
    {
        return this.GetToken();
    }

    //
    // Check Provider for any Guards ...
    bool CheckForGuard(XGuard &guards[]) override
    {
        //
        bool result = false;

        //
        return result;
    }

    //
    // Request Provider to Collect all
    // Potentially Signals and then
    // filters theme here and passed them
    // for Executing ...
    int RequestForSignal(
        XSignal &signals[] // Holds Signals ...
        ) override
    {
        //
        bool result = 0;

        //
        Clean(signals);

        //
        // IMPLEMENT ...

        //
        result = ArraySize(signals);

        //
        return result;
    }

    //
    // Here we Manage Signals for Executing ...
    // - Check Policies based on their Signaller ...
    // - Check Same Time Open Positions ...
    // - Check Signal Age for new Trade ...
    // and etc ...
    int HandleSignalManagement(XSignal &signals[]) override
    {
        //
        int result = 0;

        //
        int signalsCount = ArraySize(signals);
        if (!IsValidSize(signalsCount))
        {
            return result;
        }

        //
        XSignal tmpSignals[];
        Copy(
            signals,
            tmpSignals //
        );

        //
        Clean(signals);

        //
        for (int i = 0; i < signalsCount; i++)
        {
            //
            XSignal iSignal = tmpSignals[i];

            //
            AddRef(
                iSignal,
                signals //
            );
        }

        //
        result = ArraySize(signals);

        //
        return result;
    }

    //
    // Handle State Management ....
    // here we can manage current state ...
    // - Check for Long Positions for each Signaller to Close ...
    // - Handle Hedging Signaller's Positions if it's enabled ...
    // - Force Closing Position when Specified Time reached ...
    // - Check Start and End time or Trading Dates ...
    // - handle Trailing or Risk free Signals based on several conditions ...
    // and etc ...
    bool HandleStateManagement(XSignal &signals[]) override
    {
        //
        const bool result = false;

        //
        // Here we Implement Account Protector ...
        HandleAccountProtect();

        //
        // Do all State Management here ...

        //
        // if Returns true, Signal Execution failed ...
        return result;
    }

    //
    // Protected ...
protected:
    //
    // Tools ...

    //
    //  Do All Protection Senarios here ...
    void HandleAccountProtect()
    {
    }

    //
    // Private ...
private:
};

//