connection.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 <map>
#include <sstream>
 
#include "port.h"
 
namespace Antares::ModelerStudy::SystemModel
{
 
// Define an enumeration for the role of a ConnectionEnd
enum class FieldRole
{
    Sender,
    Receiver
};
 
inline std::ostream& operator<<(std::ostream& os, const SystemModel::FieldRole& role)
{
    return role == SystemModel::FieldRole::Sender ? os << "Sender" : os << "Receiver";
}
 
using PortFieldsRole = std::map<PortField, FieldRole>;
 
class Component;
 
class ConnectionEnd final
{
public:
    ConnectionEnd(Component* component, const Port* port);
    [[nodiscard]] const Component* component() const;
    [[nodiscard]] const Port* port() const;
 
private:
    const Component* component_;
    const Port* port_;
};
 
} // namespace Antares::ModelerStudy::SystemModel