///////////////////////////////////////////////////////
//
// SaherElm IT Center MQL5 Helper Class Library
// ----------------------------------------------
// Name: XSCXHULLHelper
// 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_XHULLC_BUFFERS
{
    XHULLC_UP_LINE = 0,
    XHULLC_DOWN_LINE = 2,
};

//
// Input Models ...
struct XHULLInputs
{
    //
    // Props ...
    //
    // Market ...
    int length;     // Length
    double divisor; // Divisor (Speed)

    //
    // Calculation ...
    ENUM_APPLIED_PRICE upAppliedTo;   // Up Zone Applied to
    ENUM_APPLIED_PRICE downAppliedTo; // Down Zone Applied to

    //
    // Presentation ...
    bool showUpZone;   // Show Up Zone
    bool showDownZone; // Show Down Zone

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

    //
    // Tools ...

    //
    // Clean ...
    void Clean()
    {
        //
        // Market ...
        length = 0;
        divisor = 0;

        //
        // Calculation ...
        upAppliedTo = PRICE_HIGH;
        downAppliedTo = PRICE_LOW;

        //
        // Presentation ...
        showUpZone = false;
        showDownZone = false;
    }

    //
    // Default ...
    void Default()
    {
        //
        // Market ...
        length = 72;
        divisor = 2.0;

        //
        // Calculation ...
        upAppliedTo = PRICE_HIGH;
        downAppliedTo = PRICE_LOW;

        //
        // Presentation ...
        showUpZone = true;
        showDownZone = true;
    }

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

        //
        result =
            //
            length >= 9 &&
            divisor >= 0.5
            //
            ;

        //
        return result;
    }

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

        //
        result = MathMax(0, length);

        //
        return result;
    }
};

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

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

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

    //
    // Tools ...
    bool Init(
        string symbol,          // Trading Symbol
        ENUM_TIMEFRAMES period, // Trading Period
        XHULLInputs &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.xhull",
            //
            // Inputs ...
            //
            // Market ...
            "",
            mInputs.length,  // Length
            mInputs.divisor, // Divisor (Speed)
            //
            // Calculation ...
            "",
            mInputs.upAppliedTo,   // Up Zone Applied to
            mInputs.downAppliedTo, // Down Zone Applied to
            //
            // Presentation ...
            "",
            mInputs.showUpZone,  // Show Up Zone
            mInputs.showDownZone // Show Down Zone
            //
        );
        result = mHandler != INVALID_HANDLE;
        if (!result)
        {
            return result;
        }

        //
        return result;
    }

    //
    // Inputs ...

    //
    XHULLInputs GetInputs()
    {
        return mInputs;
    }

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

    //
    // Buffers ...

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

        //
        Calculate();

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

        //
        return upBuffer[barIndex];
    }

    //
    // Copy Required Items ...
    int CopyUp(
        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,
            upBuffer,
            buffer,
            forceClean
            //
        );
    }

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

        //
        Calculate();

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

        //
        return downBuffer[barIndex];
    }

    //
    // Copy Required Items ...
    int CopyDown(
        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,
            downBuffer,
            buffer,
            forceClean
            //
        );
    }

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

    //
    // Buffers ...
    double upBuffer[];
    double downBuffer[];

    //
    // Tools ...

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

        //
        // Up Buffer ...
        CopyBuffer(
            mHandler,
            XHULLC_UP_LINE,
            0,
            totalBars,
            upBuffer
            //
        );

        //
        // Down Buffer ...
        CopyBuffer(
            mHandler,
            XHULLC_DOWN_LINE,
            0,
            totalBars,
            downBuffer
            //
        );
    }
};

//
// Tools ...