ResInsight/ApplicationLibCode/ProjectDataModel/RimCase.h
2021-01-11 15:27:45 +01:00

120 lines
4.0 KiB
C++

/////////////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2015- Statoil ASA
// Copyright (C) 2015- Ceetron Solutions AS
//
// 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 "RimCaseDisplayNameTools.h"
#include "cafPdmChildArrayField.h"
#include "cafPdmChildField.h"
#include "cafPdmField.h"
#include "cafPdmObject.h"
#include "cafPdmPtrField.h"
#include "cvfVector3.h"
#include <vector>
class Rim3dView;
class RimGridView;
class RimFormationNames;
class RimTimeStepFilter;
class Rim2dIntersectionView;
class RimExtrudedCurveIntersection;
class Rim2dIntersectionViewCollection;
namespace cvf
{
class BoundingBox;
}
class RimCase : public caf::PdmObject
{
CAF_PDM_HEADER_INIT;
using DisplayNameEnum = caf::AppEnum<RimCaseDisplayNameTools::DisplayName>;
public:
RimCase();
~RimCase() override;
caf::PdmField<int> caseId;
caf::PdmField<QString> caseUserDescription;
void setGridFileName( const QString& fileName );
QString gridFileName() const;
void setDisplayNameOption( RimCaseDisplayNameTools::DisplayName displayNameOption );
void updateAutoShortName();
void updateOptionSensitivity();
std::vector<Rim3dView*> views() const;
std::vector<RimGridView*> gridViews() const;
virtual void updateFilePathsFromProjectPath( const QString& projectPath, const QString& oldProjectPath ) = 0;
virtual std::vector<QDateTime> timeStepDates() const = 0;
virtual QStringList timeStepStrings() const = 0;
virtual QString timeStepName( int frameIdx ) const = 0;
virtual cvf::BoundingBox reservoirBoundingBox() = 0;
virtual cvf::BoundingBox activeCellsBoundingBox() const = 0;
virtual cvf::BoundingBox allCellsBoundingBox() const = 0;
virtual cvf::Vec3d displayModelOffset() const;
void setFormationNames( RimFormationNames* formationNames );
RimFormationNames* activeFormationNames() const;
virtual void updateFormationNamesData() = 0;
virtual double characteristicCellSize() const = 0;
size_t uiToNativeTimeStepIndex( size_t uiTimeStepIndex );
Rim2dIntersectionViewCollection* intersectionViewCollection();
caf::Signal<> settingsChanged;
protected:
QList<caf::PdmOptionItemInfo> calculateValueOptions( const caf::PdmFieldHandle* fieldNeedingOptions,
bool* useOptionsOnly ) override;
void fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue ) override;
virtual std::vector<Rim3dView*> allSpecialViews() const = 0;
void initAfterRead() override;
void updateTreeItemName();
virtual QString caseName() const;
static QString uniqueShortNameCase( RimCase* rimCase, int shortNameLengthLimit );
private:
caf::PdmFieldHandle* userDescriptionField() override;
protected:
caf::PdmField<caf::FilePath> m_caseFileName;
caf::PdmField<DisplayNameEnum> m_displayNameOption;
caf::PdmChildField<RimTimeStepFilter*> m_timeStepFilter;
caf::PdmChildField<Rim2dIntersectionViewCollection*> m_2dIntersectionViewCollection;
caf::PdmPtrField<RimFormationNames*> m_activeFormationNames;
private:
bool m_isInActiveDestruction;
};