ResInsight/ApplicationCode/Commands/SummaryPlotCommands/RicPasteAsciiDataToSummaryPlotFeatureUi.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2017 Statoil ASA
// 
//  ResInsight is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
// 
//  ResInsight is distributed in the hope that it will be useful, but WITHOUT ANY
//  WARRANTY; without even the implied warranty of MERCHANTABILITY or
//  FITNESS FOR A PARTICULAR PURPOSE.
// 
//  See the GNU General Public License at <http://www.gnu.org/licenses/gpl.html> 
//  for more details.
//
/////////////////////////////////////////////////////////////////////////////////

#pragma once

#include "RimPlotCurve.h"

#include "RifCsvUserDataParser.h"

#include "cafPdmObject.h"
#include "cafPdmField.h"
#include "cafAppEnum.h"

#include <QString>
#include <QLocale>

#include <memory>


//==================================================================================================
/// 
//==================================================================================================
class AsciiDataParseOptions
{
public:
    AsciiDataParseOptions() : useCustomDateTimeFormat(false) { }

    QString                 plotTitle;
    QString                 curvePrefix;
    QString                 decimalSeparator;
    QLocale                 locale;

    bool                    useCustomDateTimeFormat;
    QString                 dateFormat;
    QString                 timeFormat;
    QString                 dateTimeFormat;
    QString                 cellSeparator;
    QString                 timeSeriesColumnName;

    RimPlotCurve::LineStyleEnum   curveLineStyle;
    RimPlotCurve::PointSymbolEnum curveSymbol;
    float                         curveSymbolSkipDistance;
};


//==================================================================================================
/// 
//==================================================================================================
class RicPasteAsciiDataToSummaryPlotFeatureUi : public caf::PdmObject
{
    CAF_PDM_HEADER_INIT;

public:
    enum UiMode
    {
        UI_MODE_NONE,
        UI_MODE_IMPORT,
        UI_MODE_PASTE
    };

    enum DecimalSeparator
    {
        DECIMAL_COMMA,
        DECIMAL_DOT,
    };

    typedef caf::AppEnum<DecimalSeparator> DecimalSeparatorEnum;

    enum DateFormat
    {
        DATE_DDMMYYYY_DOT_SEPARATED,
        DATE_DDMMYYYY_DASH_SEPARATED,
        DATE_DDMMYYYY_SLASH_SEPARATED,
        DATE_YYYYMMDD_DOT_SEPARATED,
        DATE_YYYYMMDD_DASH_SEPARATED,
        DATE_YYYYMMDD_SLASH_SEPARATED,
        DATE_MMDDYYYY_SLASH_SEPARATED,
        DATE_MMDDYY_SLASH_SEPARATED
    };

    typedef caf::AppEnum<DateFormat> DateFormatEnum;

    enum TimeFormat
    {
        TIME_HHMM,
        TIME_HHMMSS,
        TIME_HHMMSSZZZ,
    };

    typedef caf::AppEnum<TimeFormat> TimeFormatEnum;

    enum CellSeparator
    {
        CELL_COMMA,
        CELL_TAB,
        CELL_SEMICOLON
    };

    typedef caf::AppEnum<CellSeparator> CellSeparatorEnum;

public:
    RicPasteAsciiDataToSummaryPlotFeatureUi();

    void    setUiModeImport(const QString& fileName);
    void    setUiModePasteText(const QString& text);

    const AsciiDataParseOptions    parseOptions() const;
    void    createNewPlot();

protected:
    virtual void                            defineUiOrdering(QString uiConfigName, caf::PdmUiOrdering& uiOrdering) override;
    virtual QList<caf::PdmOptionItemInfo>   calculateValueOptions(const caf::PdmFieldHandle* fieldNeedingOptions, bool* useOptionsOnly) override;
    virtual void                            defineEditorAttribute(const caf::PdmFieldHandle* field, QString uiConfigName, caf::PdmUiEditorAttribute* attribute) override;
    virtual void                            fieldChangedByUi(const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue);

private:
    void    initialize(RifCsvUserDataParser* parser);

private:
    UiMode                                                      m_uiMode;

    caf::PdmField<QString>                                      m_plotTitle;
    caf::PdmField<QString>                                      m_curvePrefix;
    caf::PdmField<DecimalSeparatorEnum>                         m_decimalSeparator;
    caf::PdmField<DateFormatEnum>                               m_dateFormat;
    caf::PdmField<TimeFormatEnum>                               m_timeFormat;
    caf::PdmField<bool>                                         m_useCustomDateFormat;
    caf::PdmField<QString>                                      m_customDateTimeFormat;
    caf::PdmField<CellSeparatorEnum>                            m_cellSeparator;
    caf::PdmField<QString>                                      m_timeSeriesColumnName;

    caf::PdmField<caf::AppEnum<RimPlotCurve::LineStyleEnum>>    m_curveLineStyle;
    caf::PdmField<caf::AppEnum<RimPlotCurve::PointSymbolEnum>>  m_curveSymbol;
    caf::PdmField<float>                                        m_curveSymbolSkipDistance;

    bool                                                        m_createNewPlot;
    caf::PdmField<QString>                                      m_previewText;

    std::unique_ptr<RifCsvUserDataParser>                       m_parser;
};