Opm::DeckKeyword Class Reference

#include <DeckKeyword.hpp>

Public Member Functions

 DeckKeyword (const std::string &keywordName)
 
 DeckKeyword (const std::string &keywordName, bool knownKeyword)
 
const std::string & name () const
 
void setLocation (const std::string &fileName, int lineNumber)
 
const std::string & getFileName () const
 
int getLineNumber () const
 
std::shared_ptr< const
ParserKeyword
getParserKeyword () const
 Returns the Parser keyword from which the current deck keyword was created from. More...
 
bool hasParserKeyword () const
 
void setParserKeyword (std::shared_ptr< const ParserKeyword > &parserKeyword)
 
size_t size () const
 
void addRecord (DeckRecordConstPtr record)
 
DeckRecordConstPtr getRecord (size_t index) const
 
DeckRecordConstPtr getDataRecord () const
 
void setDataKeyword (bool isDataKeyword=true)
 
bool isKnown () const
 
bool isDataKeyword () const
 
const std::vector< int > & getIntData () const
 
const std::vector< double > & getRawDoubleData () const
 
const std::vector< double > & getSIDoubleData () const
 
const std::vector< float > & getSIFloatData () const
 
const std::vector< float > & getRawFloatData () const
 
const std::vector< std::string > & getStringData () const
 
size_t getDataSize () const
 
std::vector
< DeckRecordConstPtr >
::const_iterator 
begin () const
 
std::vector
< DeckRecordConstPtr >
::const_iterator 
end () const
 

Constructor & Destructor Documentation

Opm::DeckKeyword::DeckKeyword ( const std::string &  keywordName)
Opm::DeckKeyword::DeckKeyword ( const std::string &  keywordName,
bool  knownKeyword 
)

Member Function Documentation

void Opm::DeckKeyword::addRecord ( DeckRecordConstPtr  record)
std::vector<DeckRecordConstPtr>::const_iterator Opm::DeckKeyword::begin ( ) const
std::vector<DeckRecordConstPtr>::const_iterator Opm::DeckKeyword::end ( ) const
DeckRecordConstPtr Opm::DeckKeyword::getDataRecord ( ) const
size_t Opm::DeckKeyword::getDataSize ( ) const
const std::string& Opm::DeckKeyword::getFileName ( ) const
const std::vector<int>& Opm::DeckKeyword::getIntData ( ) const
int Opm::DeckKeyword::getLineNumber ( ) const
std::shared_ptr<const ParserKeyword> Opm::DeckKeyword::getParserKeyword ( ) const

Returns the Parser keyword from which the current deck keyword was created from.

If no parser keyword is available, this method throws std::invalid_exception. Use hasParserKeyword() to test if one is available..

const std::vector<double>& Opm::DeckKeyword::getRawDoubleData ( ) const
const std::vector<float>& Opm::DeckKeyword::getRawFloatData ( ) const
DeckRecordConstPtr Opm::DeckKeyword::getRecord ( size_t  index) const
const std::vector<double>& Opm::DeckKeyword::getSIDoubleData ( ) const
const std::vector<float>& Opm::DeckKeyword::getSIFloatData ( ) const
const std::vector<std::string>& Opm::DeckKeyword::getStringData ( ) const
bool Opm::DeckKeyword::hasParserKeyword ( ) const
bool Opm::DeckKeyword::isDataKeyword ( ) const
bool Opm::DeckKeyword::isKnown ( ) const
const std::string& Opm::DeckKeyword::name ( ) const
void Opm::DeckKeyword::setDataKeyword ( bool  isDataKeyword = true)
void Opm::DeckKeyword::setLocation ( const std::string &  fileName,
int  lineNumber 
)
void Opm::DeckKeyword::setParserKeyword ( std::shared_ptr< const ParserKeyword > &  parserKeyword)
size_t Opm::DeckKeyword::size ( ) const

The documentation for this class was generated from the following file: