suffix-for-area-names.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_ACTION_SETTINGS_SUFFIXAREA_NAME_H__
#define __ANTARES_LIBS_STUDY_ACTION_SETTINGS_SUFFIXAREA_NAME_H__
 
#include <yuni/yuni.h>
#include "../action.h"
 
namespace Antares::Action::Settings
{
class SuffixAreaName: public IAction
{
public:
    using Ptr = IAction::Ptr;
    using ThreadingPolicy = IAction::ThreadingPolicy;
 
public:
 
 
    template<class StringT>
    explicit SuffixAreaName(const StringT& value, bool enabled = true);
    virtual ~SuffixAreaName();
 
    virtual bool autoExpand() const;
 
    virtual bool shouldPrepareRootNode() const;
 
    virtual void behaviorToText(Behavior behavior, Yuni::String& out);
 
protected:
    virtual bool prepareWL(Context& ctx);
    virtual bool performWL(Context& ctx);
    virtual void prepareSkipWL(Context& ctx);
 
private:
    Yuni::String pValue;
 
}; // class SuffixAreaName
 
} // namespace Antares::Action::Settings
 
#include "suffix-for-area-names.hxx"
 
#endif // __ANTARES_LIBS_STUDY_ACTION_SETTINGS_SUFFIXAREA_NAME_H__