inspector.h

/*
** Copyright 2007-2024, 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_INSPECTOR_H__
#define __ANTARES_WINDOWS_INSPECTOR_INSPECTOR_H__
 
#include <yuni/yuni.h>
#include <antares/study/study.h>
#include "antares/study/binding_constraint/BindingConstraintsRepository.h"
 
namespace Antares
{
namespace Window
{
namespace Inspector
{
 
 
void Refresh();
 
void Show();
 
void Hide();
 
void Destroy();
 
void Unselect();
 
 
void SelectArea(const Data::Area* area);
 
void SelectAreas(const Data::Area::Vector& areas);
 
void AddArea(const Data::Area* area);
 
void AddAreas(const Data::Area::Vector& list);
 
void AddAreas(const Data::Area::Set& list);
 
void RemoveArea(const Data::Area* area);
 
 
 
void SelectLink(const Data::AreaLink* lnk);
 
void SelectLinks(const Data::AreaLink::Vector& lnks);
 
void AddLink(const Data::AreaLink* link);
 
void AddLinks(const Data::AreaLink::Vector& links);
 
void AddLinks(const Data::AreaLink::Set& links);
 
const Data::AreaLink::Set& getLinks();
 
void RemoveLink(const Data::AreaLink* link);
 
 
 
void SelectThermalCluster(const Data::ThermalCluster* cluster);
 
void AddThermalClusters(const Data::ThermalCluster::Vector& clusters);
void RemoveThermalCluster(const Data::ThermalCluster* cluster);
 
 
 
void SelectRenewableCluster(const Data::RenewableCluster* cluster);
 
void RemoveRenewableCluster(const Data::RenewableCluster* cluster);
 
void AddBindingConstraints(const Data::BindingConstraintsRepository::Set& set);
 
 
 
uint SelectionAreaCount();
 
uint SelectionLinksCount();
 
uint SelectionThermalClusterCount();
 
uint SelectionBindingConstraintCount();
 
uint SelectionTotalCount();
 
bool isAreaSelected(Antares::Data::AreaName name);
bool AreasSelected(const Data::Area::NameSet& set,
                   std::map<Antares::Data::AreaName, Antares::Data::AreaName>& nameMap);
 
bool isConstraintSelected(const Yuni::String& constraintName);
bool ConstraintsSelected(const std::set<Yuni::String>& set);
 
bool IsLinkSelected(const Data::AreaName& from, const Data::AreaName& with);
bool LinksSelected(std::map<Data::AreaName, std::map<Data::AreaName, bool>>& set);
 
void FirstSelectedArea(Data::AreaName& out);
 
void FirstSelectedAreaLink(Data::AreaLink** link);
 
 
 
uint CopyToClipboard();
 
} // namespace Inspector
} // namespace Window
} // namespace Antares
 
#endif // __ANTARES_WINDOWS_INSPECTOR_INSPECTOR_H__