ResInsight/ApplicationLibCode/ProjectDataModel/RimUserDefinedCalculation.h
Magne Sjaastad f8c5cf389f
clang-format: Set column width to 140
* Set column width to 140
* Use c++20
* Remove redundant virtual
2023-02-26 10:48:40 +01:00

100 lines
3.3 KiB
C++

/////////////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2022 Equinor 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 "RiuExpressionContextMenuManager.h"
#include "cafPdmChildArrayField.h"
#include "cafPdmField.h"
#include "cafPdmObject.h"
#include <memory>
class RimUserDefinedCalculationVariable;
//==================================================================================================
///
///
//==================================================================================================
class RimUserDefinedCalculation : public caf::PdmObject
{
CAF_PDM_HEADER_INIT;
public:
RimUserDefinedCalculation();
void setDescription( const QString& description );
QString description() const;
void setId( int id );
int id() const;
bool isDirty() const;
caf::PdmChildArrayFieldHandle* variables();
std::vector<RimUserDefinedCalculationVariable*> allVariables() const;
void setExpression( const QString& expr );
QString expression() const;
QString unitName() const;
bool parseExpression();
virtual bool calculate() = 0;
virtual void updateDependentObjects() = 0;
virtual void removeDependentObjects() = 0;
caf::PdmFieldHandle* userDescriptionField() override;
static QString findLeftHandSide( const QString& expression );
void attachToWidget();
QString shortName() const;
protected:
virtual RimUserDefinedCalculationVariable* createVariable() = 0;
void fieldChangedByUi( const caf::PdmFieldHandle* changedField, const QVariant& oldValue, const QVariant& newValue ) override;
void defineUiOrdering( QString uiConfigName, caf::PdmUiOrdering& uiOrdering ) override;
void defineEditorAttribute( const caf::PdmFieldHandle* field, QString uiConfigName, caf::PdmUiEditorAttribute* attribute ) override;
RimUserDefinedCalculationVariable* findByName( const QString& name ) const;
RimUserDefinedCalculationVariable* addVariable( const QString& name );
void deleteVariable( RimUserDefinedCalculationVariable* calcVariable );
virtual QString buildCalculationName() const;
protected:
caf::PdmField<QString> m_description;
caf::PdmField<QString> m_expression;
caf::PdmField<bool> m_helpButton;
caf::PdmField<QString> m_helpText;
caf::PdmField<QString> m_unit;
caf::PdmChildArrayField<RimUserDefinedCalculationVariable*> m_variables;
caf::PdmField<std::vector<double>> m_calculatedValues_OBSOLETE;
caf::PdmField<std::vector<time_t>> m_timesteps_OBSOLETE;
caf::PdmField<int> m_id;
std::unique_ptr<RiuExpressionContextMenuManager> m_exprContextMenuMgr;
bool m_isDirty;
};