study.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_APPLICATION_STUDY_H__
#define __ANTARES_APPLICATION_STUDY_H__
 
#include <yuni/yuni.h>
#include "../toolbox/wx-wrapper.h"
#include <antares/study/study.h>
#include <antares/study/output.h>
#include <yuni/core/event.h>
#include <list>
#include <antares/locator/locator.h>
 
#include "ui/simulator/toolbox/components/map/settings.h"
 
namespace Antares
{
enum SaveResult
{
    svsError = 0,
    svsSaved,
    svsDiscard,
    svsCancel
};
 
extern wxString gLastOpenedStudyFolder;
 
void NewStudy();
 
void OpenStudyFromFolder(wxString folder);
 
SaveResult SaveStudy();
 
SaveResult SaveStudyAs(const Yuni::String& path, bool copyoutput, bool copyuserdata, bool copylogs);
 
void SetCurrentStudy(std::shared_ptr<Data::Study> study);
 
std::shared_ptr<Data::Study> GetCurrentStudy();
 
bool CurrentStudyIsValid();
 
 
SaveResult ExportMap(const Yuni::String& path,
                     bool transparentBackground,
                     const wxColour& backgroundColor,
                     const std::list<uint16_t>& layers,
                     int nbSplitParts,
                     Antares::Map::mapImageFormat format);
 
bool CloseTheStudy(bool updateGUI = true);
 
bool CheckIfInsideAStudyFolder(const AnyString& path, bool quiet = false);
 
void RunSimulationOnTheStudy(Data::Study::Ptr study,
                             const YString& simuName,
                             const YString& simuComments,
                             bool ignoreWarnings,
                             Solver::Feature features = Solver::standard,
                             bool preproOnly = false,
                             const std::string& solverName = "sirius");
 
void UpdateGUIFromStudyState();
 
bool StudyRenameArea(Data::Area* area, const AnyString& newname, Data::Study* study = nullptr);
 
void MarkTheStudyAsModified();
 
void MarkTheStudyAsModified(const Data::Study::Ptr& study);
 
void ResetTheModifierState(bool v);
 
bool StudyHasBeenModified();
 
uint64_t StudyInMemoryRevisionID();
 
void RefreshListOfOutputsForTheCurrentStudy();
 
void StudyRefreshCalendar();
 
 
 
extern Yuni::Event<void()> OnStudyLoaded;
 
extern Yuni::Event<void()> OnStudyClosed;
 
extern Yuni::Event<void()> OnStudySaved;
 
extern Yuni::Event<void()> OnStudySavedAs;
 
extern Yuni::Event<void(Data::Study&)> OnStudyChanged;
 
extern Yuni::Event<void()> OnStudyAreasChanged;
 
extern Yuni::Event<void()> OnStudySettingsChanged;
 
extern Yuni::Event<void(const Data::Output::List&, const Data::Output::Ptr)>
  OnStudyUpdateOutputInfo;
 
extern Yuni::Event<void(Data::Area*)> OnStudyAreaRename;
 
extern Yuni::Event<void(Data::Area*)> OnStudyAreaAdded;
 
extern Yuni::Event<void(Data::Area*)> OnStudyAreaDelete;
 
extern Yuni::Event<void(Data::Area*)> OnStudyAreaColorChanged;
 
extern Yuni::Event<void(Data::AreaLink*)> OnStudyLinkAdded;
 
extern Yuni::Event<void(Data::AreaLink*)> OnStudyLinkDelete;
 
extern Yuni::Event<void(Data::AreaLink*)> OnStudyLinkChanged;
 
extern Yuni::Event<void(Data::BindingConstraint*)> OnStudyConstraintAdded;
 
extern Yuni::Event<void(Data::BindingConstraint*)> OnStudyConstraintDelete;
 
extern Yuni::Event<void(Data::BindingConstraint*)> OnStudyConstraintModified;
 
extern Yuni::Event<void()> OnStudyNodalOptimizationChanged;
 
extern Yuni::Event<void()> OnStudySimulationSettingsChanged;
 
extern Yuni::Event<void()> OnStudyUpdatePlaylist;
 
extern Yuni::Event<void()> OnStudyReloadAllComponentsWithJITData;
 
extern Yuni::Event<void()> OnStudyThermalClusterCommonSettingsChanged;
 
extern Yuni::Event<void(Data::ThermalCluster*)> OnStudyThermalClusterRenamed;
extern Yuni::Event<void(Data::Area*)> OnStudyThermalClusterGroupChanged;
 
extern Yuni::Event<void()> OnStudyRenewableClusterCommonSettingsChanged;
 
extern Yuni::Event<void(Data::RenewableCluster*)> OnStudyRenewableClusterRenamed;
extern Yuni::Event<void(Data::Area*)> OnStudyRenewableClusterGroupChanged;
 
extern Yuni::Event<void()> OnStudyScenarioBuilderDataAreLoaded;
 
extern Yuni::Event<void()> OnStudyBeginUpdate;
extern Yuni::Event<void()> OnStudyEndUpdate;
 
extern Yuni::Event<void(const void*)> OnInspectorRefresh;
 
extern Yuni::Event<void()> OnMainNotebookChanged;
 
extern Yuni::Event<void()> OnLayerNodeUIChanged;
 
extern Yuni::Event<void(const wxString*)> OnMapLayerChanged;
 
extern Yuni::Event<void(const wxString*)> OnMapLayerAdded;
extern Yuni::Event<void(const wxString*)> OnMapLayerRemoved;
extern Yuni::Event<void(const wxString*)> OnMapLayerRenamed;
 
//
// You should not have to call these routines yourselves
void MemoryFlushBeginUpdate();
void MemoryFlushEndUpdate();
bool CanPerformMemoryFlush();
 
extern bool SystemParameterHaveChanged;
 
extern bool GUIFlagInvalidateAreas;
 
extern Antares::Data::Output::List ListOfOutputsForTheCurrentStudy;
 
extern Yuni::String LastPathForOpeningAFile;
 
class StudyUpdateLocker final
{
public:
    StudyUpdateLocker()
    {
        OnStudyBeginUpdate();
    }
    ~StudyUpdateLocker()
    {
        OnStudyEndUpdate();
    }
};
 
class MemoryFlushLocker final
{
public:
    MemoryFlushLocker()
    {
        MemoryFlushBeginUpdate();
    }
    ~MemoryFlushLocker()
    {
        MemoryFlushEndUpdate();
    }
};
 
} // namespace Antares
 
#endif // __ANTARES_APPLICATION_STUDY_H__