includeEntry Class Reference

Specify an include file when reading dictionaries, expects a single string to follow. More...

#include <OpenFOAM/includeEntry.H>

---

Detailed Description

Specify an include file when reading dictionaries, expects a single string to follow.

An example of the #include directive:

#include "includeFile"

The usual expansion of environment variables and other constructs (eg, the ~OpenFOAM/ expansion) is retained.

See also:

fileName, string::expand()

Source files

• src/OpenFOAM/db/dictionary/functionEntries/includeEntry/includeEntry.H
• src/OpenFOAM/db/dictionary/functionEntries/includeEntry/includeEntry.C

Definition at line 63 of file includeEntry.H.

Inheritance diagram for includeEntry:

Collaboration diagram for includeEntry:

List of all members.

Public Member Functions
	ClassName ("include")
	Runtime type information.
Static Public Member Functions
static bool	execute (dictionary &parentDict, Istream &)
	Execute the functionEntry in a sub-dict context.
static bool	execute (const dictionary &parentDict, primitiveEntry &, Istream &)
	Execute the functionEntry in a primitiveEntry context.
Static Protected Member Functions
static fileName	includeFileName (Istream &)
	Read the include fileName from Istream, expand and return.

---

Member Function Documentation

Foam::fileName includeFileName

(

Istream &

is  )

[static, protected]

Read the include fileName from Istream, expand and return.

Definition at line 67 of file includeEntry.C.

References string::expand(), and IOstream::name().

ClassName

(

"include"

)

Runtime type information.

bool execute	(	dictionary &	parentDict,
		Istream &	is
	)		[static]

Execute the functionEntry in a sub-dict context.

Reimplemented in includeIfPresentEntry.

Definition at line 87 of file includeEntry.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, dictionaryName::name(), IFstream::name(), and dictionary::read().

Referenced by entry::New().

bool execute	(	const dictionary &	parentDict,
		primitiveEntry &	entry,
		Istream &	is
	)		[static]

Execute the functionEntry in a primitiveEntry context.

Reimplemented in includeIfPresentEntry.

Definition at line 116 of file includeEntry.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, dictionaryName::name(), IFstream::name(), and primitiveEntry::read().

---

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

• src/OpenFOAM/db/dictionary/functionEntries/includeEntry/includeEntry.H
• src/OpenFOAM/db/dictionary/functionEntries/includeEntry/includeEntry.C