Actions.hpp

/*
  Copyright 2018 Equinor ASA.

  This file is part of the Open Porous Media project (OPM).

  OPM is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  OPM 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
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with OPM.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef ActionCOnfig_HPP
#define ActionCOnfig_HPP

#include <opm/input/eclipse/Schedule/Action/ActionX.hpp>
#include <opm/input/eclipse/Schedule/Action/PyAction.hpp>

#include <cstddef>
#include <ctime>
#include <string>
#include <vector>

namespace Opm::Action {

class State;

} // namespace Opm::Action

namespace Opm::Action {

class Actions
{
public:
    Actions() = default;

    Actions(const std::vector<ActionX>&  action,
            const std::vector<PyAction>& pyactions);

    static Actions serializationTestObject();

    void add(const ActionX& action);

    void add(const PyAction& pyaction);

    std::size_t ecl_size() const;

    std::size_t py_size() const;

    int max_input_lines() const;

    bool empty() const;

    bool ready(const State& state, std::time_t sim_time) const;

    const ActionX& operator[](const std::string& name) const;

    const ActionX& operator[](std::size_t index) const;

    std::vector<const ActionX*>
    pending(const State& state, std::time_t sim_time) const;

    std::vector<const PyAction*> pending_python(const State& state) const;

    bool has(const std::string& name) const;

    auto begin() const { return this->actions_.begin(); }

    auto end() const { return this->actions_.end(); }

    bool operator==(const Actions& data) const;

    template<class Serializer>
    void serializeOp(Serializer& serializer)
    {
        serializer(this->actions_);
        serializer(this->pyactions_);
    }

private:
    std::vector<ActionX> actions_{};

    std::vector<PyAction> pyactions_{};
};

} // namespace Opm::Action

#endif // ActionCOnfig_HPP