output.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_LIBS_STUDY_OUTPUT_H__
#define __ANTARES_LIBS_STUDY_OUTPUT_H__
 
#include <functional>
#include <map>
#include <memory>
 
#include <yuni/yuni.h>
#include <yuni/core/string.h>
 
#include "antares/study/study.h"
 
namespace Antares::Data
{
 
// TODO VP: remove with GUI
class Output final
{
public:
    using Ptr = std::shared_ptr<Output>;
    using List = std::list<Ptr>;
    using Title = Yuni::CString<128, false>;
    using Name = Yuni::CString<128, false>;
 
    using MapByTimestamp = std::map<int64_t, Ptr>;
    using MapByTimestampDesc = std::map<int64_t, Ptr, std::greater<int64_t>>;
 
public:
    static void RetrieveListFromStudy(List& out, const Study& study);
 
public:
 
 
    explicit Output(const AnyString& folder);
 
    bool loadFromFolder(const AnyString& folder);
 
    bool valid() const;
 
    bool operator<(const Output& rhs) const;
 
public:
    StudyVersion version;
    int64_t timestamp;
    Data::SimulationMode mode;
    int menuID;
    int viewMenuID;
    int outputViewerID;
 
    Title title;
    Name name;
    YString path;
 
}; // class Output
 
} // namespace Antares::Data
 
#include "output.hxx"
 
#endif // __ANTARES_STUDY_LIBS_OUTPUT_H__