ColumnSchema.hpp

/*
  Copyright 2015 Statoil 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 OPM_COLUMN_SCHEMA_HPP
#define OPM_COLUMN_SCHEMA_HPP

#include <string>
#include <vector>

#include <opm/input/eclipse/EclipseState/Tables/TableEnums.hpp>

namespace Opm {

    class ColumnSchema {
    public:
        ColumnSchema();
        ColumnSchema(const std::string& name , Table::ColumnOrderEnum order, Table::DefaultAction defaultAction);
        ColumnSchema(const std::string& name , Table::ColumnOrderEnum order, double defaultValue);

        static ColumnSchema serializationTestObject();

        const std::string& name() const;
        std::string orderSchema() const;
        bool validOrder( double value1 , double value2) const;
        bool lookupValid( ) const;
        bool isDecreasing( ) const;
        Table::DefaultAction getDefaultMode( ) const;
        double getDefaultValue( ) const;

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

        template<class Serializer>
        void serializeOp(Serializer& serializer)
        {
            serializer(m_name);
            serializer(m_order);
            serializer(m_defaultAction);
            serializer(m_defaultValue);
        }

    private:
        std::string m_name;
        Table::ColumnOrderEnum m_order;
        Table::DefaultAction m_defaultAction;
        double m_defaultValue;
    };
}

#endif