parameter.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 "timeAndScenarioType.h"
#include "valueType.h"
 
namespace Antares::ModelerStudy::SystemModel
{
 
class Parameter final
{
public:
    explicit Parameter(std::string id,
                       TimeDependent timeDependent,
                       ScenarioDependent scenarioDependent):
        id_(std::move(id)),
        timeDependent_(timeDependent),
        scenarioDependent_(scenarioDependent)
    {
    }
 
    const std::string& Id() const
    {
        return id_;
    }
 
    bool isTimeDependent() const
    {
        return timeDependent_ == TimeDependent::YES;
    }
 
    bool isScenarioDependent() const
    {
        return scenarioDependent_ == ScenarioDependent::YES;
    }
 
private:
    std::string id_;
    TimeDependent timeDependent_ = TimeDependent::YES;             // optional at construction
    ScenarioDependent scenarioDependent_ = ScenarioDependent::YES; // optional at construction
};
 
} // namespace Antares::ModelerStudy::SystemModel