Opm::ParserKeyword Class Reference

#include <ParserKeyword.hpp>

Public Types
typedef std::set< std::string >	DeckNameSet
typedef std::set< std::string >	SectionNameSet

Public Member Functions
	ParserKeyword (const std::string &name, const std::string &sizeKeyword, const std::string &sizeItem, bool isTableCollection=false)
	ParserKeyword (const std::string &name)
	ParserKeyword (const Json::JsonObject &jsonConfig)
void	setFixedSize (size_t keywordSize)
void	setSizeType (ParserKeywordSizeEnum sizeType)
void	setTableCollection (bool isTableCollection)
void	initSizeKeyword (const std::string &sizeKeyword, const std::string &sizeItem)
bool	hasMatchRegex () const
void	setMatchRegex (const std::string &deckNameRegexp)
bool	matches (const std::string &deckKeywordName) const
bool	hasDimension () const
void	addRecord (std::shared_ptr< ParserRecord > record)
void	addDataRecord (std::shared_ptr< ParserRecord > record)
ParserRecordPtr	getRecord (size_t recordIndex) const
std::vector< ParserRecordPtr > ::const_iterator	recordBegin () const
std::vector< ParserRecordPtr > ::const_iterator	recordEnd () const
const std::string	className () const
const std::string &	getName () const
size_t	getFixedSize () const
bool	hasFixedSize () const
bool	isTableCollection () const
std::string	getDescription () const
void	setDescription (const std::string &description)
bool	hasMultipleDeckNames () const
void	clearDeckNames ()
void	addDeckName (const std::string &deckName)
DeckNameSet::const_iterator	deckNamesBegin () const
DeckNameSet::const_iterator	deckNamesEnd () const
void	clearValidSectionNames ()
void	addValidSectionName (const std::string &sectionName)
bool	isValidSection (const std::string &sectionName) const
SectionNameSet::const_iterator	validSectionNamesBegin () const
SectionNameSet::const_iterator	validSectionNamesEnd () const
DeckKeywordPtr	parse (const ParseMode &parseMode, RawKeywordConstPtr rawKeyword) const
enum ParserKeywordSizeEnum	getSizeType () const
const std::pair< std::string, std::string > &	getSizeDefinitionPair () const
bool	isDataKeyword () const
bool	equal (const ParserKeyword &other) const
std::string	createDeclaration (const std::string &indent) const
std::string	createDecl () const
std::string	createCode () const
void	applyUnitsToDeck (std::shared_ptr< const Deck > deck, std::shared_ptr< const DeckKeyword > deckKeyword) const

Static Public Member Functions
static std::string	getDeckName (const std::string &rawString)
static bool	validInternalName (const std::string &name)
static bool	validDeckName (const std::string &name)

Member Typedef Documentation

typedef std::set<std::string> Opm::ParserKeyword::DeckNameSet

typedef std::set<std::string> Opm::ParserKeyword::SectionNameSet

Constructor & Destructor Documentation

Opm::ParserKeyword::ParserKeyword	(	const std::string &	name,
		const std::string &	sizeKeyword,
		const std::string &	sizeItem,
		bool	isTableCollection = false
	)

Opm::ParserKeyword::ParserKeyword ( const std::string &  name )

explicit

Opm::ParserKeyword::ParserKeyword ( const Json::JsonObject &  jsonConfig )

explicit

Member Function Documentation

void Opm::ParserKeyword::addDataRecord

(

std::shared_ptr< ParserRecord >

record

)

void Opm::ParserKeyword::addDeckName

(

const std::string &

deckName

)

void Opm::ParserKeyword::addRecord

(

std::shared_ptr< ParserRecord >

record

)

void Opm::ParserKeyword::addValidSectionName

(

const std::string &

sectionName

)

void Opm::ParserKeyword::applyUnitsToDeck	(	std::shared_ptr< const Deck >	deck,
		std::shared_ptr< const DeckKeyword >	deckKeyword
	)		const

const std::string Opm::ParserKeyword::className

(

)

const

void Opm::ParserKeyword::clearDeckNames

(

)

void Opm::ParserKeyword::clearValidSectionNames

(

)

std::string Opm::ParserKeyword::createCode

(

)

const

std::string Opm::ParserKeyword::createDecl

(

)

const

std::string Opm::ParserKeyword::createDeclaration

(

const std::string &

indent

)

const

DeckNameSet::const_iterator Opm::ParserKeyword::deckNamesBegin

(

)

const

DeckNameSet::const_iterator Opm::ParserKeyword::deckNamesEnd

(

)

const

bool Opm::ParserKeyword::equal

(

const ParserKeyword &

other

)

const

static std::string Opm::ParserKeyword::getDeckName ( const std::string &  rawString )

static

std::string Opm::ParserKeyword::getDescription

(

)

const

size_t Opm::ParserKeyword::getFixedSize

(

)

const

const std::string& Opm::ParserKeyword::getName

(

)

const

ParserRecordPtr Opm::ParserKeyword::getRecord

(

size_t

recordIndex

)

const

const std::pair<std::string,std::string>& Opm::ParserKeyword::getSizeDefinitionPair

(

)

const

enum ParserKeywordSizeEnum Opm::ParserKeyword::getSizeType

(

)

const

bool Opm::ParserKeyword::hasDimension

(

)

const

bool Opm::ParserKeyword::hasFixedSize

(

)

const

bool Opm::ParserKeyword::hasMatchRegex

(

)

const

bool Opm::ParserKeyword::hasMultipleDeckNames

(

)

const

void Opm::ParserKeyword::initSizeKeyword	(	const std::string &	sizeKeyword,
		const std::string &	sizeItem
	)

bool Opm::ParserKeyword::isDataKeyword

(

)

const

bool Opm::ParserKeyword::isTableCollection

(

)

const

bool Opm::ParserKeyword::isValidSection

(

const std::string &

sectionName

)

const

bool Opm::ParserKeyword::matches

(

const std::string &

deckKeywordName

)

const

DeckKeywordPtr Opm::ParserKeyword::parse	(	const ParseMode &	parseMode,
		RawKeywordConstPtr	rawKeyword
	)		const

std::vector<ParserRecordPtr>::const_iterator Opm::ParserKeyword::recordBegin

(

)

const

std::vector<ParserRecordPtr>::const_iterator Opm::ParserKeyword::recordEnd

(

)

const

void Opm::ParserKeyword::setDescription

(

const std::string &

description

)

void Opm::ParserKeyword::setFixedSize

(

size_t

keywordSize

)

void Opm::ParserKeyword::setMatchRegex

(

const std::string &

deckNameRegexp

)

void Opm::ParserKeyword::setSizeType

(

ParserKeywordSizeEnum

sizeType

)

void Opm::ParserKeyword::setTableCollection

(

bool

isTableCollection

)

static bool Opm::ParserKeyword::validDeckName ( const std::string &  name )

static

static bool Opm::ParserKeyword::validInternalName ( const std::string &  name )

static

SectionNameSet::const_iterator Opm::ParserKeyword::validSectionNamesBegin

(

)

const

SectionNameSet::const_iterator Opm::ParserKeyword::validSectionNamesEnd

(

)

const

---

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

• ParserKeyword.hpp