frame.h

/*
 * Copyright 2007-2025, RTE (https://www.rte-france.com)
 * See AUTHORS.txt
 * SPDX-License-Identifier: MPL-2.0
 * This file is part of Antares-Simulator,
 * Adequacy and Performance assessment for interconnected energy networks.
 *
 * Antares_Simulator is free software: you can redistribute it and/or modify
 * it under the terms of the Mozilla Public Licence 2.0 as published by
 * the Mozilla Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * Antares_Simulator 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
 * Mozilla Public Licence 2.0 for more details.
 *
 * You should have received a copy of the Mozilla Public Licence 2.0
 * along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
 */
#ifndef __ANTARES_WINDOWS_INSPECTOR_FRAME_H__
#define __ANTARES_WINDOWS_INSPECTOR_FRAME_H__
 
#include <wx/propgrid/propgrid.h>
 
#include <antares/study/study.h>
#include "../notes.h"
#include "data.h"
#include <ui/common/component/panel.h>
 
namespace Antares::Window::Inspector
{
// Forward declaration
class InspectorGrid;
 
class Frame final: public Antares::Component::Panel, public Yuni::IEventObserver<Frame>
{
public:
 
 
    explicit Frame(wxWindow* parent, bool allowAnyObject = false);
    virtual ~Frame();
 
 
 
    void apply(const InspectorData::Ptr& data);
 
    void delayApplyGlobalSelection();
 
    void delayApply();
 
 
    void attachToTheMainForm();
 
    void detachFromTheMainForm();
 
public:
    // Events
    void onSelectAllLinks(wxCommandEvent& evt);
    void onSelectLink(wxCommandEvent& evt);
    void onSelectAllLinksFromArea(wxCommandEvent& evt);
 
    void onSelectAllPlants(wxCommandEvent& evt);
    void onSelectPlant(wxCommandEvent& evt);
 
    void clearAssociatinsBetweenIDAndPtr()
    {
        mapIDPointer.clear();
    }
 
    void assign(int id, const void* p)
    {
        mapIDPointer[id] = const_cast<void*>(p);
    }
 
protected:
    void onDelayApplyGlobalSelection();
    void onDelayApply();
    void onStudyClosed();
    void onSelectProperties(void*);
    void onSelectNotes(void*);
    void onPropertyChanging(wxPropertyGridEvent& event);
    void onLoadUserNotes();
    void onInternalRefresh(const void* sender);
 
private:
    wxPropertyGrid* pPropertyGrid;
    wxPanel* pMainPanel;
    Window::Notes* pNotes;
    // with the givel selection
    bool pAllowAnyObject;
    InspectorData::Ptr pCurrentSelection;
    Yuni::Bind<void(const InspectorData::Ptr&)> pApplyPropertyGrid;
 
    // Some property pointers are kept to speed-up the update
    // About a Study
    wxPGProperty* pPGCommonStudyName;
    wxPGProperty* pPGCommonStudyAuthor;
 
    // About studies
    wxPGProperty* pPGStudySpace1;
    wxPGProperty* pPGStudySpace2;
    wxPGProperty* pPGStudyTitle;
    wxPGProperty* pPGStudyGrpSimulation;
    wxPGProperty* pPGStudyGrpCalendar;
    wxPGProperty* pPGStudyMCScenarios;
    wxPGProperty* pPGStudyOutputProfile;
    wxPGProperty* pPGSimulationMode;
    wxPGProperty* pPGStudyYears;
    wxPGProperty* pPGStudyCalendarBegin;
    wxPGProperty* pPGStudyCalendarEnd;
    wxPGProperty* pPGStudy1rstJanuary;
    wxPGProperty* pPGStudyHorizon;
    wxPGProperty* pPGStudyCalendarMonth;
    wxPGProperty* pPGStudyLeapYear;
    wxPGProperty* pPGStudyCalendarWeek;
    wxPGProperty* pPGStudyBuildMode;
    wxPGProperty* pPGStudyPlaylist;
    wxPGProperty* pPGStudySimulationSynthesis;
    wxPGProperty* pPGStudyYearByYear;
    wxPGProperty* pPGGeographicTrimming;
    wxPGProperty* pPGThematicTrimming;
    wxPGProperty* pPGStudyUseMCScenarios;
 
    // About Areas
    wxPGProperty* pPGAreaSeparator;
    wxPGProperty* pPGAreaTitle;
    wxPGProperty* pPGAreaGeneral;
    wxPGProperty* pPGAreaOptimization;
    wxPGProperty* pPGAreaLocalization;
    wxPGProperty* pPGAreaFilteringStatus;
    wxPGProperty* pPGAreaFilteringSynthesis[5];
    wxPGProperty* pPGAreaFilteringYbY[5];
    wxPGProperty* pPGAreaDeps;
    wxPGProperty* pPGAreaResort;
    wxPGProperty* pPGAreaResortNon;
    wxPGProperty* pPGAreaResortHydroPower;
    wxPGProperty* pPGAreaResortOther;
    wxPGProperty* pPGUnsupplied;
    wxPGProperty* pPGSpilled;
    wxPGProperty* pPGAreaName;
    wxPGProperty* pPGAreaAdequacyPatchTitle;
    wxPGProperty* pPGAreaAdequacyPatchMode;
    wxPGProperty* pPGAreaColor;
    wxPGProperty* pPGAreaLinks;
    wxPGProperty* pPGAreaPlants;
 
    // About links
    wxPGProperty* pPGLinkSeparator;
    wxPGProperty* pPGLinkFilteringStatus;
    wxPGProperty* pPGLinkFilteringSynthesis[5];
    wxPGProperty* pPGLinkFilteringYbY[5];
    wxPGProperty* pPGLinkColor;
    wxPGProperty* pPGLinkStyle;
    wxPGProperty* pPGLinkWidth;
 
    // About Thermal clusters
    wxPGProperty* pPGThClusterSeparator;
    wxPGProperty* pPGThClusterGeneral;
    wxPGProperty* pPGThClusterParams;
    wxPGProperty* pPGThClusterReliabilityModel;
    wxPGProperty* pPGThClusterCosts;
    wxPGProperty* pPGThClusterName;
    wxPGProperty* pPGThClusterDoGenerateTS;
 
public:
    wxPGProperty* pPGThClusterNominalCapacity;
    wxPGProperty* pPGThClusterUnitCount;
    wxPGProperty* pPGThClusterInstalled;
 
private:
    wxPGProperty* pPGThClusterEnabled;
    wxPGProperty* pPGThClusterMustRun;
    wxPGProperty* pPGThClusterGroup;
    wxPGProperty* pPGThClusterArea;
    wxPGProperty* pPGThClusterCO2;
    wxPGProperty* pPGThClusterVolatilityForced;
    wxPGProperty* pPGThClusterVolatilityPlanned;
    wxPGProperty* pPGThClusterLawForced;
    wxPGProperty* pPGThClusterLawPlanned;
    wxPGProperty* pPGThClusterSpinning;
    wxPGProperty* pPGThClusterEfficiency;
 
    wxPGProperty* pPGThClusterCostGeneration;
    wxPGProperty* pPGThClusterMarginalCost;
    wxPGProperty* pPGThClusterFixedCost;
    wxPGProperty* pPGThClusterStartupCost;
    wxPGProperty* pPGThClusterOperatingCost;
    wxPGProperty* pPGThClusterRandomSpread;
    wxPGProperty* pPGThClusterVariableOMcost;
 
    wxPGProperty* pPGThClusterMinStablePower;
    wxPGProperty* pPGThClusterMinUpTime;
    wxPGProperty* pPGThClusterMinDownTime;
 
    // About Renewable clusters
    wxPGProperty* pPGRnClusterSeparator;
    wxPGProperty* pPGRnClusterGeneral;
    wxPGProperty* pPGRnClusterName;
    wxPGProperty* pPGRnClusterGroup;
    wxPGProperty* pPGRnClusterArea;
    wxPGProperty* pPGRnClusterParams;
 
public:
    wxPGProperty* pPGRnClusterUnitCount;
    wxPGProperty* pPGRnClusterInstalled;
    wxPGProperty* pPGRnClusterNominalCapacity;
 
private:
    wxPGProperty* pPGRnClusterEnabled;
    wxPGProperty* pPGRnClusterTSMode;
 
    // About constraints
    wxPGProperty* pPGConstraintSeparator;
    wxPGProperty* pPGConstraintTitle;
    wxPGProperty* pPGConstraintName;
    wxPGProperty* pPGConstraintGeneral;
    wxPGProperty* pPGConstraintComments;
    wxPGProperty* pPGConstraintEnabled;
    wxPGProperty* pPGConstraintType;
 
    // Association between id and a pointer
    // This ugly map is required because wxMenuItem/Connect() does not support
    // user-data........
    std::map<int, void*> mapIDPointer;
 
    Component::Button* pBtnInspector;
    bool pAlreadyConnectedToSimulationChangesEvent;
 
    // Friend !
    friend class InspectorGrid;
 
}; // class InspectorFramce
 
// Singleton
extern Frame* gInspector;
 
} // namespace Antares::Window::Inspector
 
#endif // __ANTARES_WINDOWS_INSPECTOR_FRAME_H__