WList.hpp

/*
  Copyright 2019 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 WLIST_HPP
#define WLIST_HPP

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


namespace Opm {

class WList
{
public:
    WList() = default;

    WList(const std::vector<std::string>& wlist, const std::string& wlname);

    std::size_t size() const;

    bool empty() const { return this->size() == 0; }

    void clear();

    void add(const std::string& well);

    void del(const std::string& well);

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

    const std::string& getName() const { return this->name; }

    const std::vector<std::string>& wells() const;

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

    bool operator!=(const WList& that) const
    {
        return ! (*this == that);
    }

    template<class Serializer>
    void serializeOp(Serializer& serializer)
    {
        serializer(well_list);
        serializer(name);
    }

private:
    std::vector<std::string> well_list;

    std::string name;
};

} // namespace Opm

#endif // WLIST_HPP