///////////////////////////////////////////////////////
//
// SaherElm IT Center MQL5 Class
// -------------------------------------------------
// Name: XCXFIMAPoiDetector ...
// Description: XFIMA POI Detector Class ...
//
//
// Maintainer:
// ------------
// Hadi Khazaee Asl (hadi_khazaee_asl@yahoo.com)
//
//////////////////////////////////////////////////////
//
// Global Properties ...
#property library
#property copyright "Copyright 2023, SaherElm IT Center"
#property link "https://saherelm.ir"
#property version "1.00"
#property description "SaherElm XFIMA POI Detector Class"
#property strict

//
// Imports ...
#include "../../Classes/x-saherelm.base.class.mq5"
#include "../../Classes/x-saherelm.x-bar.analyser.class.mq5"
#include "../../Classes/x-saherelm.x-market.pattern.class.mq5"
#include "../Libraries/x-saherelm.xfima.lib.mq5"

//
// Implementation ...
class XCXFIMAPOIDetector : public XCMarketPatternDetector
{
    //
    // Public ...
  public:
    //
    // Props ...
    XCBarAnalyser *barAnalyser; // Bar Analyser ...
    XCXFIMAHelper *fimaHelper;  // XFIMA Helper ...

    //
    // Constructor ...
    XCXFIMAPOIDetector(
        XCXFIMAHelper *_fimaHelper //
        ) : XCMarketPatternDetector()
    {
        //
        barAnalyser = new XCBarAnalyser();
        fimaHelper = _fimaHelper;
    }

    //
    // Deconstructor ...
    ~XCXFIMAPOIDetector()
    {
        Destroy();
    }

    //
    // Actions and Tools ...

    //
    // Pivot Analysors ...

    /**
     * Analyse Market based on Specified Kind of Pivots ...
     *
     * @param  analysis: XPivotAnalysis, reference to hold result ...
     * @param  barIndex: int, Bar Index ...
     * @param  requiredNumberOFPivots: int, Specified which Number of Pivots must be Extracted ...
     * @param  maxAllowedLoopbackLength: int, Specified Maximum Loopback Length for Pivot Extraction ...
     * @param  validationLength: int, Specified Pivots Validation Length ignore if <= 0 ...
     *
     * @return ( bool )
     */
    bool AnalysePVPivots(
        XPivotAnalysis &analysis,
        int barIndex = 0,
        int requiredNumberOFPivots = 50,
        int maxAllowedLoopbackLength = 1500,
        int validationLength = 0 //
    )
    {
        //
        bool result = false;

        //
        // Prepare ...
        analysis.Clean();

        //
        // Reading Pivots ...
        XPivot pivots[];
        int count = ExtractPVPivots(
            pivots,                   // Result ...
            barIndex,                 // Bar Index ...
            requiredNumberOFPivots,   // Required Number of Pivots ...
            maxAllowedLoopbackLength, // Max Allowed Loopback ...
            validationLength          // Validation Length ...
        );
        result = IsValidSize(count);
        if (!result)
        {
            //
            SpecifiedClean(pivots);
            return result;
        }

        //
        string symbol = fimaHelper.GetSymbol();
        ENUM_TIMEFRAMES period = fimaHelper.GetPeriod();

        //
        // Initialize Analysis ...
        result = analysis.Init(
            "XFIMA_XPV",
            symbol,
            period,
            pivots //
        );

        //
        // Cleanup Resources ...
        if (!result)
        {
            analysis.Clean();
        }
        SpecifiedClean(pivots);

        //
        return result;
    }

    /**
     * Analyse Market based on Specified Kind of Pivots ...
     *
     * @param  analysis: XPivotAnalysis, reference to hold result ...
     * @param  barIndex: int, Bar Index ...
     * @param  requiredNumberOFPivots: int, Specified which Number of Pivots must be Extracted ...
     * @param  maxAllowedLoopbackLength: int, Specified Maximum Loopback Length for Pivot Extraction ...
     *
     * @return ( bool )
     */
    bool AnalyseZigZagPivots(
        XPivotAnalysis &analysis,
        int barIndex = 0,
        int requiredNumberOFPivots = 50,
        int maxAllowedLoopbackLength = 1500 //
    )
    {
        //
        bool result = false;

        //
        // Prepare ...
        analysis.Clean();

        //
        // Reading Pivots ...
        XPivot pivots[];
        int count = ExtractZigZagPivots(
            pivots,                  // Result ...
            barIndex,                // Bar Index ...
            requiredNumberOFPivots,  // Required Number of Pivots ...
            maxAllowedLoopbackLength // Max Allowed Loopback ...
        );
        result = IsValidSize(count);
        if (!result)
        {
            //
            SpecifiedClean(pivots);
            return result;
        }

        //
        string symbol = fimaHelper.GetSymbol();
        ENUM_TIMEFRAMES period = fimaHelper.GetPeriod();

        //
        // Initialize Analysis ...
        result = analysis.Init(
            "XFIMA_XZG",
            symbol,
            period,
            pivots //
        );

        //
        // Cleanup Resources ...
        if (!result)
        {
            analysis.Clean();
        }
        SpecifiedClean(pivots);

        //
        return result;
    }

    //
    // Pivot Extractors ...

    /**
     * Extract Specified Kind of Pivots ...
     *
     * @param  pivots: XPivot, refrence Collection to hold Extracted pivots ...
     * @param  barIndex: int, Specified Bar Index ...
     * @param  requiredNumberOFPivots: int, Specified which Number of Pivots must be Extracted ...
     * @param  maxAllowedLoopbackLength: int, Specified Maximum Loopback Length for Pivot Extraction ...
     * @param  validationLength: int, Specified Pivots Validation Length ignore if <= 0 ...
     *
     * @return ( int )
     */
    int ExtractPVPivots(
        XPivot &pivots[],
        int barIndex = 0,
        int requiredNumberOFPivots = 50,
        int maxAllowedLoopbackLength = 1500,
        int validationLength = 0 //
    )
    {
        //
        int result = 0;

        //
        result = fimaHelper.ExtractPVPivots(
            pivots,
            barIndex,
            requiredNumberOFPivots,
            maxAllowedLoopbackLength,
            validationLength //
        );

        //
        return result;
    }

    /**
     * Extract Specified Kind of Pivots ...
     *
     * @param  pivots: XPivot, refrence Collection to hold Extracted pivots ...
     * @param  barIndex: int, Specified Bar Index ...
     * @param  requiredNumberOFPivots: int, Specified which Number of Pivots must be Extracted ...
     * @param  maxAllowedLoopbackLength: int, Specified Maximum Loopback Length for Pivot Extraction ...
     * @param  validationLength: int, Specified Pivots Validation Length ignore if <= 0 ...
     *
     * @return ( int )
     */
    int ExtractMAPivots(
        XPivot &pivots[],
        int barIndex = 0,
        int requiredNumberOFPivots = 50,
        int maxAllowedLoopbackLength = 1500,
        int validationLength = 0 //
    )
    {
        //
        int result = 0;

        //
        result = fimaHelper.ExtractMAPivots(
            pivots,
            barIndex,
            requiredNumberOFPivots,
            maxAllowedLoopbackLength,
            validationLength //
        );

        //
        return result;
    }

    /**
     * Extract Specified Kind of Pivots ...
     *
     * @param  pivots: XPivot, refrence Collection to hold Extracted pivots ...
     * @param  barIndex: int, Specified Bar Index ...
     * @param  requiredNumberOFPivots: int, Specified which Number of Pivots must be Extracted ...
     * @param  maxAllowedLoopbackLength: int, Specified Maximum Loopback Length for Pivot Extraction ...
     *
     * @return ( int )
     */
    int ExtractSARPivots(
        XPivot &pivots[],
        int barIndex = 0,
        int requiredNumberOFPivots = 50,
        int maxAllowedLoopbackLength = 1500 //
    )
    {
        //
        int result = 0;

        //
        result = fimaHelper.ExtractSARPivots(
            pivots,
            barIndex,
            requiredNumberOFPivots,
            maxAllowedLoopbackLength //
        );

        //
        return result;
    }

    /**
     * Extract Specified Kind of Pivots ...
     *
     * @param  pivots: XPivot, refrence Collection to hold Extracted pivots ...
     * @param  barIndex: int, Specified Bar Index ...
     * @param  requiredNumberOFPivots: int, Specified which Number of Pivots must be Extracted ...
     * @param  maxAllowedLoopbackLength: int, Specified Maximum Loopback Length for Pivot Extraction ...
     *
     * @return ( int )
     */
    int ExtractZigZagPivots(
        XPivot &pivots[],
        int barIndex = 0,
        int requiredNumberOFPivots = 50,
        int maxAllowedLoopbackLength = 1500 //
    )
    {
        //
        int result = 0;

        //
        result = fimaHelper.ExtractZigZagPivots(
            pivots,
            barIndex,
            requiredNumberOFPivots,
            maxAllowedLoopbackLength //
        );

        //
        return result;
    }

    /**
     * Destroy ...
     */
    void Destroy()
    {
        //
        delete barAnalyser;
        ZeroMemory(barAnalyser);
    }

    //
    // Protected ...
  protected:
    //
    // Props ...

    //
    // Tools / Actions ...

    //
    // Private ...
  private:
    //

    //
};

//