ResInsight/ApplicationLibCode/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 "RifAsciiDataParseOptions.h"
#include "RifCsvUserDataParser.h"
#include "RifEclipseSummaryAddressDefines.h"

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

#include <QLocale>
#include <QString>

#include <memory>

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

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

    enum DecimalSeparator
    {
        DECIMAL_COMMA,
        DECIMAL_DOT,
    };

    using DecimalSeparatorEnum = caf::AppEnum<DecimalSeparator>;

    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
    };

    using DateFormatEnum = caf::AppEnum<DateFormat>;

    enum TimeFormat
    {
        TIME_NONE,
        TIME_HHMM,
        TIME_HHMMSS,
        TIME_HHMMSSZZZ,
    };

    using TimeFormatEnum = caf::AppEnum<TimeFormat>;

    enum CellSeparator
    {
        CELL_COMMA,
        CELL_TAB,
        CELL_SEMICOLON
    };

    using CellSeparatorEnum = caf::AppEnum<CellSeparator>;

public:
    RicPasteAsciiDataToSummaryPlotFeatureUi();

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

    UiMode                         uiModeImport() const;
    const RifAsciiDataParseOptions parseOptions() const;
    void                           setCreateNewPlot();

    QString contextString() const;

    static DateFormat dateFormatFromString( const QString& dateString );

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

private:
    void initialize( RifCsvUserDataParser* parser );
    void updatePreviewTextAndDateFormat();

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<RiuQwtPlotCurveDefines::LineStyleEnum>> m_curveLineStyle;
    caf::PdmField<caf::AppEnum<RiuPlotCurveSymbol::PointSymbolEnum>>   m_curveSymbol;
    caf::PdmField<float>                                               m_curveSymbolSkipDistance;

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

    std::unique_ptr<RifCsvUserDataParser> m_parser;
};