ResInsight/ApplicationLibCode/ProjectDataModel/Summary/RimSummaryTimeAxisProperties.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2016 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 "RiaDateTimeDefines.h"

#include "Appearance/RimFontSizeField.h"
#include "RimPlotAxisPropertiesInterface.h"
#include "RimTimeAxisAnnotation.h"

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

#include <QDateTime>
#include <QString>

//==================================================================================================
///
///
//==================================================================================================
class RimSummaryTimeAxisProperties : public RimPlotAxisPropertiesInterface
{
    CAF_PDM_HEADER_INIT;

public:
    enum TimeModeType
    {
        DATE,
        TIME_FROM_SIMULATION_START
    };

    enum TimeUnitType
    {
        SECONDS,
        MINUTES,
        HOURS,
        DAYS,
        MONTHS,
        YEARS
    };

    enum class TickmarkType
    {
        TICKMARK_COUNT,
        TICKMARK_CUSTOM,
    };
    using TickmarkTypeEnum = caf::AppEnum<TickmarkType>;

    enum class TickmarkInterval
    {
        MINUTES,
        HOURS,
        DAYS,
        MONTHS,
        YEARS,
    };
    using TickmarkIntervalEnum = caf::AppEnum<TickmarkInterval>;

    using DateFormatEnum = caf::AppEnum<RiaDefines::DateFormatComponents>;
    using TimeFormatEnum = caf::AppEnum<RiaDefines::TimeFormatComponents>;

    caf::Signal<> requestLoadDataAndUpdate;

public:
    RimSummaryTimeAxisProperties();

    bool    showTitle() const;
    QString title() const;
    bool    showLabels() const;

    RiuPlotAxis           plotAxis() const override;
    AxisTitlePositionType titlePosition() const override;
    int                   titleFontSize() const override;
    int                   valuesFontSize() const override;
    TimeModeType          timeMode() const;
    void                  setTimeMode( TimeModeType val );
    TimeUnitType          timeUnit() const;
    double                fromTimeTToDisplayUnitScale();
    double                fromDaysToDisplayUnitScale();

    static double scaleFromSecondsToDisplayUnit( TimeUnitType displayUnit );

    // Time from simulation start expressed in the given display unit. MONTHS and YEARS are computed using calendar
    // arithmetic, so a time step exactly N calendar months/years after the start reports exactly N.
    static double timeFromSimulationStart( const QDateTime& simulationStartTime, const QDateTime& timeStep, TimeUnitType displayUnit );
    double        timeFromSimulationStart( const QDateTime& simulationStartTime, const QDateTime& timeStep ) const;

    RiaDefines::DateFormatComponents
        dateComponents( RiaDefines::DateFormatComponents fallback = RiaDefines::DateFormatComponents::DATE_FORMAT_UNSPECIFIED ) const;
    RiaDefines::TimeFormatComponents
        timeComponents( RiaDefines::TimeFormatComponents fallback = RiaDefines::TimeFormatComponents::TIME_FORMAT_UNSPECIFIED ) const;

    std::vector<RimPlotAxisAnnotation*> annotations() const override;
    void                                appendAnnotation( RimPlotAxisAnnotation* annotation ) override;
    void                                removeAnnotation( RimTimeAxisAnnotation* annotation );

    void removeAllAnnotations() override;

    const QString& dateFormat() const;
    const QString& timeFormat() const;

    double visibleRangeMin() const override;
    double visibleRangeMax() const override;

    void setVisibleRangeMin( double value ) override;
    void setVisibleRangeMax( double value ) override;

    bool isAutoZoom() const override;
    void setAutoZoom( bool enableAutoZoom ) override;

    bool isActive() const override;

    QDateTime visibleDateTimeMin() const;
    QDateTime visibleDateTimeMax() const;

    void setVisibleDateTimeMin( const QDateTime& dateTime );
    void setVisibleDateTimeMax( const QDateTime& dateTime );

    void setTickmarkInterval( TickmarkInterval interval );
    void setTickmarkIntervalStep( int step );

    QList<double>                    createTickmarkList( const QDateTime& minDateTime, const QDateTime& maxDateTime ) const;
    double                           getTickmarkIntervalDouble();
    TickmarkType                     tickmarkType() const;
    std::pair<TickmarkInterval, int> tickmarkIntervalAndStep() const;

    LegendTickmarkCount majorTickmarkCount() const override;
    void                setMajorTickmarkCount( LegendTickmarkCount count ) override;
    void                setAutoValueForMajorTickmarkCount( LegendTickmarkCount count, bool notifyFieldChanged );
    void                enableAutoValueForMajorTickmarkCount( bool enable );

    const QString objectName() const override;
    const QString axisTitleText() const override;

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

    double                   fromDateToDisplayTime( const QDateTime& displayTime );
    QDateTime                fromDisplayTimeToDate( double displayTime );
    void                     updateTimeVisibleRange();
    void                     updateDateVisibleRange();
    caf::FontTools::FontSize plotFontSize() const;

private:
    void defineObjectEditorAttribute( QString uiConfigName, caf::PdmUiEditorAttribute* attribute ) override;

private:
    caf::PdmField<QString> m_title;
    caf::PdmField<bool>    m_showTitle;
    caf::PdmField<bool>    m_showLabels;

    caf::PdmField<caf::AppEnum<TimeModeType>> m_timeMode;
    caf::PdmField<caf::AppEnum<TimeUnitType>> m_timeUnit;

    caf::PdmField<bool>  m_isActive;
    caf::PdmField<QDate> m_visibleDateRangeMin;
    caf::PdmField<QDate> m_visibleDateRangeMax;
    caf::PdmField<QTime> m_visibleTimeRangeMin;
    caf::PdmField<QTime> m_visibleTimeRangeMax;

    caf::PdmField<double> m_visibleTimeSinceStartRangeMin;
    caf::PdmField<double> m_visibleTimeSinceStartRangeMax;
    caf::PdmField<bool>   m_isAutoZoom;

    RimFontSizeField m_titleFontSize;
    RimFontSizeField m_valuesFontSize;

    caf::PdmField<caf::AppEnum<AxisTitlePositionType>> m_titlePositionEnum;
    caf::PdmField<bool>                                m_automaticDateComponents;
    caf::PdmField<DateFormatEnum>                      m_dateComponents;
    caf::PdmField<TimeFormatEnum>                      m_timeComponents;
    caf::PdmField<QString>                             m_dateFormat;
    caf::PdmField<QString>                             m_timeFormat;
    caf::PdmField<TickmarkTypeEnum>                    m_tickmarkType;
    caf::PdmField<TickmarkIntervalEnum>                m_tickmarkInterval;
    caf::PdmField<int>                                 m_tickmarkIntervalStep;
    caf::PdmField<LegendTickmarkCountEnum>             m_majorTickmarkCount;
    caf::PdmChildArrayField<RimPlotAxisAnnotation*>    m_annotations;
};