FreeFOAM The Cross-Platform CFD Toolkit
includeIfPresentEntry Class Reference

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

#include <OpenFOAM/includeIfPresentEntry.H>


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

Definition at line 57 of file includeIfPresentEntry.H.

+ Inheritance diagram for includeIfPresentEntry:
+ Collaboration diagram for includeIfPresentEntry:

List of all members.

Public Member Functions

 ClassName ("includeIfPresent")
 Runtime type information.
- Public Member Functions inherited from includeEntry
 ClassName ("include")
 Runtime type information.
- 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.
static bool execute (const dictionary &parentDict, primitiveEntry &, Istream &)
 Execute the functionEntry in a primitiveEntry context.

Additional Inherited Members

- Static Protected Member Functions inherited from includeEntry
static fileName includeFileName (Istream &)
 Read the include fileName from Istream, expand and return.

Member Function Documentation

ClassName ( "includeIfPresent"  )

Runtime type information.

bool execute ( dictionary parentDict,
Istream is 
)
static

Execute the functionEntry in a sub-dict context.

Reimplemented from includeEntry.

Definition at line 67 of file includeIfPresentEntry.C.

References dictionary::read().

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

Execute the functionEntry in a primitiveEntry context.

Reimplemented from includeEntry.

Definition at line 84 of file includeIfPresentEntry.C.

References primitiveEntry::read().


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