A keyword and a list of tokens is an 'entry'. More...

Inheritance diagram for entry:

[legend]

Collaboration diagram for entry:

Public Member Functions
	entry (const keyType &key, const label keywordLineNumber)
	Construct from keyword and corresponding line number. More...

	entry (const entry &)
	Copy constructor. More...

virtual autoPtr< entry >	clone (const dictionary &parentDict) const =0
	Construct on freestore as copy with reference to the. More...

virtual autoPtr< entry >	clone () const
	Construct on freestore as copy. More...

virtual	~entry ()
	Destructor. More...

const keyType &	keyword () const
	Return keyword. More...

keyType &	keyword ()
	Return non-const access to keyword. More...

virtual const fileName &	name () const =0
	Return the dictionary name. More...

virtual fileName &	name ()=0
	Return the dictionary name. More...

virtual label	startLineNumber () const
	Return line number of keyword of the entry. More...

virtual label &	startLineNumber ()
	Return non-const access to line number of keyword of the entry. More...

virtual label	endLineNumber () const =0
	Return line number of last token in dictionary. More...

virtual bool	isStream () const
	Return true if this entry is a stream. More...

virtual ITstream &	stream () const =0
	Return token stream if this entry is a primitive entry. More...

virtual bool	isDict () const
	Return true if this entry is a dictionary. More...

virtual const dictionary &	dict () const =0
	Return dictionary if this entry is a dictionary. More...

virtual dictionary &	dict ()=0
	Return non-const access to dictionary if this entry is a dictionary. More...

virtual void	write (Ostream &) const =0
	Write. More...

void	operator= (const entry &)

bool	operator== (const entry &) const

bool	operator!= (const entry &) const

Static Public Member Functions
static bool	New (dictionary &parentDict, Istream &)
	Construct from Istream and insert into dictionary. More...

static autoPtr< entry >	New (Istream &is)
	Construct on freestore from Istream and return. More...

Static Public Attributes
static int	disableFunctionEntries

Friends
Ostream &	operator<< (Ostream &, const entry &)

Detailed Description

A keyword and a list of tokens is an 'entry'.

An entry can be read, written and printed, and the types and values of its tokens analysed. An entry is a high-level building block for data description. It is a front-end for the token parser. A list of entries can be used as a set of keyword syntax elements, for example.

Source files

Definition at line 65 of file entry.H.

Constructor & Destructor Documentation

◆ entry() [1/2]

entry	(	const keyType &	key,
		const label	keywordLineNumber
	)

explicit

Construct from keyword and corresponding line number.

Definition at line 40 of file entry.C.

References Foam::link.

◆ entry() [2/2]

entry ( const entry & e )

Copy constructor.

Definition at line 48 of file entry.C.

References Foam::link.

◆ ~entry()

virtual ~entry ( )

inlinevirtual

Destructor.

Definition at line 129 of file entry.H.

Member Function Documentation

◆ clone() [1/2]

virtual autoPtr<entry> clone ( const dictionary & parentDict ) const

pure virtual

Construct on freestore as copy with reference to the.

dictionary the copy belongs to

Implemented in dictionaryListEntry, dictionaryEntry, functionEntry, primitiveEntry, streamEntry, removeEntry, printEntry, inputModeEntry, includeIfPresentEntry, includeFuncEntry, includeEtcEntry, includeEntry, ifeqEntry, ifEntry, exitEntry, endifEntry, endCodeBlockEntry, elseEntry, elifEntry, dumpEntry, codeStream, codeIncludeEntry, codeDict, codeBlockStreamEntry, codeBlockDictEntry, codeBlockEntry, calcEntry, includeFvModelEntry, and includeFvConstraintEntry.

Referenced by Foam::addEntry().

Here is the caller graph for this function:

◆ clone() [2/2]

Foam::autoPtr< Foam::entry > clone ( ) const

virtual

Construct on freestore as copy.

Note: the parent directory is set to dictionary::null

Definition at line 56 of file entry.C.

References Foam::clone(), and dictionary::null.

Here is the call graph for this function:

◆ New() [1/2]

bool New	(	dictionary &	parentDict,
		Istream &	is
	)

static

Construct from Istream and insert into dictionary.

Definition at line 105 of file entryIO.C.

References dictionary::add(), token::BEGIN_BLOCK, token::BEGIN_LIST, dictionary::clear(), entry::dict(), token::END_BLOCK, Foam::endl(), Istream::eof(), inputModeEntry::error(), Foam::exit(), IOstream::fatalCheck(), Foam::FatalIOError, FatalIOErrorInFunction, forAllConstIter, Foam::stringOps::inplaceExpandEntry(), entry::isDict(), keyType::isFunctionName(), token::isLabel(), token::isPunctuation(), entry::isStream(), keyType::isVariable(), dictionary::lookupEntryPtr(), dictionary::lookupScopedEntryPtr(), inputModeEntry::merge(), IOstream::name(), functionEntry::New(), Foam::nl, inputModeEntry::overwrite(), inputModeEntry::protect(), token::pToken(), autoPtr< T >::ptr(), Istream::putBack(), s(), entry::stream(), and Foam::blendedInterfacialModel::valid().

Referenced by Foam::addArgEntry(), dictionaryListEntry::dictionaryListEntry(), functionEntry::insert(), and dictionary::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ New() [2/2]

Foam::autoPtr< Foam::entry > New ( Istream & is )

static

Construct on freestore from Istream and return.

Definition at line 366 of file entryIO.C.

References token::BEGIN_BLOCK, IOstream::fatalCheck(), dictionary::null, and Istream::putBack().

Here is the call graph for this function:

◆ keyword() [1/2]

const keyType& keyword ( ) const

inline

Return keyword.

Definition at line 136 of file entry.H.

Referenced by dictionary::add(), cellModel::cellModel(), dictionary::lookupEntryPtrBackwardsCompatible(), Foam::mergeDictionaries(), Foam::operator>>(), phaseProperties::phaseProperties(), primitiveEntry::primitiveEntry(), refinementRegions::refinementRegions(), refinementSurfaces::refinementSurfaces(), and dictionary::set().

Here is the caller graph for this function:

◆ keyword() [2/2]

keyType& keyword ( )

inline

Return non-const access to keyword.

Definition at line 142 of file entry.H.

◆ name() [1/2]

virtual const fileName& name ( ) const

pure virtual

Return the dictionary name.

Implemented in primitiveEntry, and dictionaryEntry.

Referenced by dictionary::add().

Here is the caller graph for this function:

◆ name() [2/2]

virtual fileName& name ( )

pure virtual

Return the dictionary name.

Implemented in primitiveEntry, and dictionaryEntry.

◆ startLineNumber() [1/2]

virtual label startLineNumber ( ) const

inlinevirtual

Return line number of keyword of the entry.

Reimplemented in dictionaryEntry.

Definition at line 154 of file entry.H.

Referenced by primitiveEntry::primitiveEntry(), and dictionaryEntry::startLineNumber().

Here is the caller graph for this function:

◆ startLineNumber() [2/2]

virtual label& startLineNumber ( )

inlinevirtual

Return non-const access to line number of keyword of the entry.

Definition at line 160 of file entry.H.

◆ endLineNumber()

virtual label endLineNumber ( ) const

pure virtual

Return line number of last token in dictionary.

Implemented in primitiveEntry, and dictionaryEntry.

◆ isStream()

virtual bool isStream ( ) const

inlinevirtual

Return true if this entry is a stream.

Reimplemented in primitiveEntry.

Definition at line 169 of file entry.H.

Referenced by entry::New().

Here is the caller graph for this function:

◆ stream()

virtual ITstream& stream ( ) const

pure virtual

Return token stream if this entry is a primitive entry.

Implemented in primitiveEntry, and dictionaryEntry.

Referenced by dictionary::lookup(), dictionary::lookupBackwardsCompatible(), dictionary::lookupCompoundScoped(), dictionary::lookupOrAddDefault(), dictionary::lookupOrDefault(), dictionary::lookupOrDefaultBackwardsCompatible(), dictionary::lookupScoped(), coordinateSystem::New(), entry::New(), dynamicCode::read(), Foam::blockMeshTools::read(), dimensioned< Type >::readIfPresent(), dictionary::readIfPresent(), unitSet::readIfPresent(), and dimensioned< Type >::readOrDefault().

Here is the caller graph for this function:

◆ isDict()

virtual bool isDict ( ) const

inlinevirtual

Return true if this entry is a dictionary.

Reimplemented in dictionaryEntry.

Definition at line 178 of file entry.H.

Referenced by dictionary::add(), Foam::addEntry(), Foam::stringOps::inplaceExpandCodeString(), dictionary::isDict(), coordinateSystem::New(), entry::New(), dictionary::optionalTypeDict(), dictionary::scopedDict(), dictionary::set(), Foam::debug::switchSet(), dictionary::typeDict(), and dictionary::typeOrEmptyDict().

Here is the caller graph for this function:

◆ dict() [1/2]

virtual const dictionary& dict ( ) const

pure virtual

Return dictionary if this entry is a dictionary.

Implemented in primitiveEntry, and dictionaryEntry.

Referenced by dictionary::add(), Foam::addEntry(), Foam::stringOps::inplaceExpandCodeString(), entry::New(), dictionary::optionalSubDict(), dictionary::optionalTypeDict(), refinementRegions::refinementRegions(), refinementSurfaces::refinementSurfaces(), dictionary::scopedDict(), dictionary::set(), dictionary::subDict(), dictionary::subDictBackwardsCompatible(), dictionary::subDictPtr(), dictionary::subOrEmptyDict(), dictionary::substituteKeyword(), Foam::debug::switchSet(), dictionary::typeDict(), and dictionary::typeOrEmptyDict().

Here is the caller graph for this function:

◆ dict() [2/2]

virtual dictionary& dict ( )

pure virtual

Return non-const access to dictionary if this entry is a dictionary.

Implemented in primitiveEntry, and dictionaryEntry.

◆ write()

virtual void write ( Ostream & ) const

pure virtual

Write.

Implemented in primitiveEntry, functionEntry, codeBlockStreamEntry, codeBlockDictEntry, dictionaryListEntry, and dictionaryEntry.

◆ operator=()

void operator= ( const entry & e )

Definition at line 64 of file entry.C.

References Foam::abort(), Foam::e, Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ operator==()

bool operator== ( const entry & e ) const

Definition at line 79 of file entry.C.

References Foam::e, and OStringStream::str().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const entry & e ) const

Definition at line 98 of file entry.C.

References Foam::e, and Foam::operator==().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<<	(	Ostream &	,
		const entry &
	)

friend

Member Data Documentation

◆ disableFunctionEntries

int disableFunctionEntries

static

Definition at line 102 of file entry.H.

Referenced by dictionary::add(), codeBlockEntry::execute(), and Foam::readConfigFile().

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

src/OpenFOAM/db/dictionary/entry/entry.H
src/OpenFOAM/db/dictionary/entry/entry.C
src/OpenFOAM/db/dictionary/entry/entryIO.C

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ entry() [1/2]

◆ entry() [2/2]

◆ ~entry()

Member Function Documentation

◆ clone() [1/2]

◆ clone() [2/2]

◆ New() [1/2]

◆ New() [2/2]

◆ keyword() [1/2]

◆ keyword() [2/2]

◆ name() [1/2]

◆ name() [2/2]

◆ startLineNumber() [1/2]

◆ startLineNumber() [2/2]

◆ endLineNumber()

◆ isStream()

◆ stream()

◆ isDict()

◆ dict() [1/2]

◆ dict() [2/2]

◆ write()

◆ operator=()

◆ operator==()

◆ operator!=()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ disableFunctionEntries