///////////////////////////////////////////////////////
//
// SaherElm IT Center MQL5 Helper Class Library
// ----------------------------------------------
// Name: XSCXTMHelper
// Description: provides all Indicator
// Helper requirements ...
//
//
// 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.xhelper.class.mq5"

//
// Definitions ...

//
enum ENUM_XTM_BUFFERS
{
    XTM_MAIN_LINE = 0
};

//
// Input Models ...
struct XTMInputs
{
    //
    // Props ...
    //
    // Market ...
    int maPeriod;                   // Period
    int maShift;                    // Shift
    ENUM_MA_METHOD maMethod;        // Method
    ENUM_APPLIED_PRICE maAppliedTo; // Applied To
    //
    // Presentation ...
    bool showLine; // Show Line

    //
    // Constructor(s) ...
    XTMInputs()
    {
        //
        Clean();
    }

    //
    // Tools ...

    //
    // Clean ...
    void Clean()
    {
        //
        maShift = 0;
        maPeriod = 0;
        showLine = false;
        maMethod = MODE_SMA;
        maAppliedTo = PRICE_CLOSE;
    }

    //
    // Default ...
    void Default()
    {
        //
        maShift = 0;
        maPeriod = 14;
        showLine = true;
        maMethod = MODE_SMA;
        maAppliedTo = PRICE_CLOSE;
    }

    //
    // Validate ...
    bool IsValid()
    {
        //
        bool result = false;

        //
        result =
            //
            maPeriod >= 2
            //
            ;

        //
        return result;
    }

    //
    // Retrieve MAx Length ...
    int Max()
    {
        //
        int result = 0;

        //
        result = MathMax(result, maPeriod);

        //
        return result;
    }
};

//
// Class ...
class XSCXTMHelper : public XSCBaseHelper
{
    //
    // Public ...
public:
    //
    // Props ...

    //
    // Constructors ...
    XSCXTMHelper() : XSCBaseHelper(_Symbol, _Period)
    {
    }

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

    //
    // Tools ...
    bool Init(
        string symbol,          // Trading Symbol
        ENUM_TIMEFRAMES period, // Trading Period
        XTMInputs &inputs      // Inputs
    )
    {
        //
        bool result = false;

        //
        mSymbol = symbol;
        mPeriod = period;

        //
        result = inputs.IsValid();
        if (!result)
        {
            return result;
        }

        //
        mInputs = inputs;

        //
        ArraySetAsSeries(mainBuffer, true);
        mHandler = iCustom(
            mSymbol,
            mPeriod,
            "x-saherelm.xtm",
            //
            // Inputs ...
            //
            // Market ...
            "",
            mInputs.maPeriod,    // Period
            mInputs.maShift,     // Shift
            mInputs.maMethod,    // Method
            mInputs.maAppliedTo, // Applied To
            //
            // Presentation ...
            "",
            mInputs.showLine // Show Line
            //
        );
        result = mHandler != INVALID_HANDLE;
        if (!result)
        {
            return result;
        }

        //
        return result;
    }

    //
    // Inputs ...

    //
    XTMInputs GetInputs()
    {
        return mInputs;
    }

    //
    bool SetInputs(
        XTMInputs &inputs // Configs
    )
    {
        //
        return Init(
            mSymbol,
            mPeriod,
            inputs
            //
        );
    }

    //
    // Buffers ...

    //
    double GetMain(
        int barIndex // Bar Index
    )
    {
        //
        if (barIndex < 0)
        {
            barIndex = 0;
        }

        //
        Calculate();

        //
        int count = ArraySize(mainBuffer);
        if (barIndex >= count)
        {
            barIndex = count - 1;
        }

        //
        return mainBuffer[barIndex];
    }

    //
    // Copy Required Items ...
    int CopyMain(
        int start,             // Start
        int count,             // Number of Items for read
        double &buffer[],      // Dest Buffer
        bool forceClean = true // Force To Clean buffer
    )
    {
        //
        // Update Calculations ...
        Calculate();

        //
        // Copy Items ...
        return Copy(
            start,
            count,
            mainBuffer,
            buffer,
            forceClean
            //
        );
    }

    //
    // Protected ...
protected:
    //
    // Private ...
private:
    //
    // Props ...
    XTMInputs mInputs; // Inputs ...

    //
    // Buffers ...
    double mainBuffer[];

    //
    // Tools ...

    //
    // Calculate Values Until Now ...
    void Calculate()
    {
        //
        int totalBars = CountBars();

        //
        // Main Buffer ...
        CopyBuffer(
            mHandler,
            XTM_MAIN_LINE,
            0,
            totalBars,
            mainBuffer
            //
        );
    }
};

//
// Tools ...