includeIfPresentEntry Class Reference

Specify a file to include if it exists. Expects a single string to follow. More...

Inheritance diagram for includeIfPresentEntry:

Collaboration diagram for includeIfPresentEntry:

Public Member Functions
	ClassName ("includeIfPresent")
	Runtime type information. More...
Public Member Functions inherited from includeEntry
	ClassName ("include")
	Runtime type information. More...
Public Member Functions inherited from functionEntry
	declareMemberFunctionSelectionTable (bool, functionEntry, execute, dictionaryIstream,(dictionary &parentDict, Istream &is),(parentDict, is))
	declareMemberFunctionSelectionTable (bool, functionEntry, execute, primitiveEntryIstream,(const dictionary &parentDict, primitiveEntry &entry, Istream &is),(parentDict, entry, is))

Static Public Member Functions
static bool	execute (dictionary &parentDict, Istream &)
	Execute the functionEntry in a sub-dict context. More...
static bool	execute (const dictionary &parentDict, primitiveEntry &, Istream &)
	Execute the functionEntry in a primitiveEntry context. More...
Static Public Member Functions inherited from includeEntry
static bool	execute (dictionary &parentDict, Istream &)
	Execute the functionEntry in a sub-dict context. More...
static bool	execute (const dictionary &parentDict, primitiveEntry &, Istream &)
	Execute the functionEntry in a primitiveEntry context. More...
Static Public Member Functions inherited from functionEntry
static bool	execute (const word &functionName, dictionary &parentDict, Istream &)
	Execute the functionEntry in a sub-dict context. More...
static bool	execute (const word &functionName, const dictionary &parentDict, primitiveEntry &, Istream &)
	Execute the functionEntry in a primitiveEntry context. More...

Additional Inherited Members
Static Public Attributes inherited from includeEntry
static bool	log
	Report which file is included to stdout. More...
Static Protected Member Functions inherited from includeEntry
static fileName	includeFileName (Istream &, const dictionary &)
	Read the include fileName from Istream, expand and return. More...
static fileName	includeFileName (const fileName &dir, const fileName &, const dictionary &)
	Expand include fileName and return. More...

Detailed Description

Specify a file to include if it exists. Expects a single string to follow.

The #includeIfPresent directive is similar to the #include directive, but does not generate an error if the file does not exist.

See also

Foam::functionEntries::includeEntry

Source files

• includeIfPresentEntry.H
• includeIfPresentEntry.C

Definition at line 56 of file includeIfPresentEntry.H.

Member Function Documentation

ClassName

(

"includeIfPresent"

)

Runtime type information.

bool execute ( dictionary &  parentDict, Istream &  is  )

static

Execute the functionEntry in a sub-dict context.

Definition at line 67 of file includeIfPresentEntry.C.

References Foam::endl(), Foam::Info, includeEntry::log, and dictionary::read().

Here is the call graph for this function:

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

static

Execute the functionEntry in a primitiveEntry context.

Definition at line 89 of file includeIfPresentEntry.C.

References Foam::endl(), Foam::Info, includeEntry::log, and primitiveEntry::read().

Here is the call graph for this function:

---

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

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