ResInsight/ApplicationCode/ProjectDataModel/RimTimeStepFilter.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 "cafPdmObject.h"
#include "cafPdmField.h"

#include <vector>

class QDateTime;
class RimEclipseResultCase;
class RimGeoMechCase;

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
class RimTimeStepFilter : public caf::PdmObject
{
    CAF_PDM_HEADER_INIT;

public:
    enum TimeStepFilterTypeEnum
    {
        TS_ALL,
        TS_INTERVAL_DAYS,
        TS_INTERVAL_WEEKS,
        TS_INTERVAL_MONTHS,
        TS_INTERVAL_QUARTERS,
        TS_INTERVAL_YEARS
    };

public:
    RimTimeStepFilter();

    void                    clearFilteredTimeSteps();

    void                    setTimeStepsFromFile(const std::vector<QDateTime>& timeSteps);
    void                    setTimeStepsFromFile(const std::vector<std::pair<QString, QDateTime>>& timeSteps);
    std::vector<size_t>     filteredTimeSteps() const;
    bool                    updateFilteredTimeStepsFromUi();
private:
    std::vector<std::pair<QString, QDateTime>>  allTimeSteps() const;
    std::vector<int>        filteredTimeStepIndicesFromUi() const;

    void                    updateFieldVisibility();
    RimEclipseResultCase*   parentEclipseResultCase() const;
    RimGeoMechCase*         parentGeoMechCase() const;

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

private:
    caf::PdmField< caf::AppEnum< TimeStepFilterTypeEnum > > m_filterType;
    
    caf::PdmField< std::vector<int> >   m_filteredTimeSteps;
    caf::PdmField< std::vector<int> >   m_filteredTimeStepsUi;
    caf::PdmField<int>                  m_firstTimeStep;
    caf::PdmField<int>                  m_lastTimeStep;
    caf::PdmField<int>                  m_interval;
    caf::PdmField<bool>                 m_applyReloadOfCase;
    caf::PdmField<QString>              m_dateFormat;
    caf::PdmField<std::vector<QString>> m_timeStepNamesFromFile;
};