library.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/>.
 */
#pragma once
 
#include <string>
#include <unordered_map>
 
#include "model.h"
#include "portType.h"
 
namespace Antares::ModelerStudy::SystemModel
{
 
class Library final
{
public:
    Library() = default;
    ~Library() = default;
 
    const std::string& Id() const
    {
        return id_;
    }
 
    const std::string& Description() const
    {
        return description_;
    }
 
    const std::unordered_map<std::string, PortType>& PortTypes() const
    {
        return portTypes_;
    }
 
    const std::unordered_map<std::string, Model>& Models() const
    {
        return *models_;
    }
 
private:
    friend class LibraryBuilder;
 
    std::string id_;
    std::string description_;
 
    std::unordered_map<std::string, PortType> portTypes_;
    std::shared_ptr<std::unordered_map<std::string, Model>>
      models_ = std::make_shared<std::unordered_map<std::string, Model>>();
};
 
class LibraryBuilder final
{
public:
    LibraryBuilder& withId(const std::string& id);
    LibraryBuilder& withDescription(const std::string& description);
    LibraryBuilder& withPortTypes(std::vector<PortType>&& portTypes);
    LibraryBuilder& withModels(std::vector<Model>&& models);
 
    const Library& build() const;
 
private:
    Library library_;
};
 
} // namespace Antares::ModelerStudy::SystemModel