action.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_ACTION_H__
#define __ANTARES_LIBS_STUDY_ACTION_ACTION_H__
 
#include <yuni/yuni.h>
#include <yuni/core/tree/treeN.h>
#include <yuni/core/string.h>
#include "fwd.h"
#include <antares/study/study.h>
#include <vector>
 
namespace Antares::Action
{
class Context;
 
class IAction: public Yuni::Core::TreeN<IAction>
{
public:
    using AncestorType = Yuni::Core::TreeN<IAction>;
    using Ptr = AncestorType::Ptr;
    using ThreadingPolicy = AncestorType::ThreadingPolicy;
 
    using Vector = std::vector<Ptr>;
 
    using iterator = AncestorType::iterator;
 
public:
 
 
    IAction();
    virtual ~IAction();
 
    Yuni::String caption() const;
 
    Yuni::String message() const;
 
    bool prepare(Context& ctx);
 
    void registerViews(Context& ctx);
 
    void datagridCaption(Yuni::String& title);
 
    bool prepareRootNode(Context& ctx);
 
    bool perform(Context& ctx, bool recursive = true);
 
    void dump() const;
 
    virtual bool bold() const;
 
    virtual bool autoExpand() const;
 
    virtual bool canDoSomething() const;
 
    virtual bool allowUpdate() const;
    virtual bool allowSkip() const;
    virtual bool allowOverwrite() const;
    virtual bool shouldPrepareRootNode() const;
 
    virtual bool visible() const;
 
 
    Behavior behavior() const;
    void behavior(Behavior newBehavior);
 
    bool prepareStack(Vector& vector);
 
 
    State state() const;
 
 
    virtual void behaviorToText(Behavior behavior, Yuni::String& out);
 
    void createPostActions(const IAction::Ptr& node);
 
protected:
    virtual bool prepareWL(Context& ctx) = 0;
 
    virtual void prepareSkipWL(Context&)
    {
    }
 
    virtual bool performWL(Context& ctx) = 0;
 
    virtual void registerViewsWL(Context&)
    {
    }
 
    virtual void createPostActionsWL(const IAction::Ptr& node);
 
protected:
    ActionInformations pInfos;
 
private:
    void internalDump(Yuni::String& tmp, uint level) const;
 
}; // class IAction
 
} // namespace Antares::Action
 
#include "action.hxx"
#include "context.h"
 
#endif // __ANTARES_LIBS_STUDY_ACTION_ACTION_H__