RawKeyword.hpp

Go to the documentation of this file.

/*
  Copyright 2013 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 RAWKEYWORD_HPP
#define RAWKEYWORD_HPP

#include <string>
#include <utility>
#include <vector>
#include <memory>

#include <opm/parser/eclipse/RawDeck/RawRecord.hpp>
#include <opm/parser/eclipse/RawDeck/RawEnums.hpp>

namespace Opm {


    class RawKeyword {
    public:
        RawKeyword(const std::string& name , Raw::KeywordSizeEnum sizeType , const std::string& filename, size_t lineNR);
        RawKeyword(const std::string& name , const std::string& filename, size_t lineNR , size_t inputSize , bool isTableCollection = false);

        const std::string& getKeywordName() const;
        void addRawRecordString(const std::string& partialRecordString);
        size_t size() const;
        Raw::KeywordSizeEnum getSizeType() const;
        RawRecordPtr getRecord(size_t index) const;

        static bool isKeywordPrefix(const std::string& line, std::string& keywordName);
        static bool isTerminator(std::string line);


        bool isPartialRecordStringEmpty() const;
        bool isFinished() const;
        bool unKnownSize() const;
        void finalizeUnknownSize();

        const std::string& getFilename() const;
        size_t getLineNR() const;


    private:
        Raw::KeywordSizeEnum m_sizeType;
        bool m_isFinished;
        size_t m_fixedSize;
        size_t m_numTables;
        size_t m_currentNumTables;
        std::string m_name;
        std::vector<RawRecordPtr> m_records;
        std::string m_partialRecordString;

        size_t m_lineNR;
        std::string m_filename;

        void commonInit(const std::string& name,const std::string& filename, size_t lineNR);
        void setKeywordName(const std::string& keyword);
        static bool isValidKeyword(const std::string& keywordCandidate);
    };
    typedef std::shared_ptr<RawKeyword> RawKeywordPtr;
    typedef std::shared_ptr<const RawKeyword> RawKeywordConstPtr;

}
#endif  /* RAWKEYWORD_HPP */