///////////////////////////////////////////////////////
//
// SaherElm IT Center MQL5 Indicator
// -------------------------------------------------
// Name: XCXCAEADataCollector ...
// Description: Class for XCAEA Data Collector ...
//
//
// 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 Class for XCAEA Data Collector"
#property strict

//
// Imports ...
#include "../../Classes/x-saherelm.base.class.mq5"

//
// Definitions ...

//
// Implementation ...
class XCXCAEADataCollector : public XCBase
{
    //
    // Public ...
  public:
    //
    // Constructors ...
    XCXCAEADataCollector()
    {
    }

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

    //
    // Properties ...

    //
    string Path()
    {
        return mPath;
    }

    //
    void Path(string value)
    {
        //
        // Normalizing Collector Path ...
        if (IsValid(value))
        {
            mPath = value;
        }
        else
        {
            mPath = "XCXCAEADataCollector";
        }
    }

    //
    // Tools ...

    //
    string GetFilePath(string fileName)
    {
        //
        string result = "";

        //
        result =
            //
            mPath + "\\" + fileName + ".x121.log"
            //
            ;

        //
        return result;
    }

    //
    int GetFileHandlerForWrite(string filePath)
    {
        //
        int result = INVALID_HANDLE;

        //
        if (!IsValid(filePath))
        {
            return result;
        }

        //
        result = FileOpen(
            filePath,
            FILE_READ | FILE_WRITE | FILE_TXT //
        );

        //
        return result;
    }

    /**
     * Save Specified Content into Specified File Name ...
     * 
     * @param  fileName: string, file name ...
     * @param  content: string, content ...
     * 
     * @return ( bool )
     */
    bool Save(
        string fileName,
        string content //
    )
    {
        //
        bool result = false;

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

        //
        //
        int mHandler = GetFileHandlerForWrite(fileName);
        result = mHandler != INVALID_HANDLE;
        if (!result)
        {
            return result;
        }

        //
        FileWrite(mHandler, content);
        FileFlush(mHandler);
        FileClose(mHandler);

        //
        return result;
    }

    //
    // Protected ...
  protected:
    //
    // Private ...
  private:
    //
    // Props ...

    //
    string mPath; // Base Collector Path ...
};