includeEtcEntry Class Reference

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

Inheritance diagram for includeEtcEntry:

Collaboration diagram for includeEtcEntry:

Public Member Functions
	ClassName ("includeEtc")
	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 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...

Static Public Attributes
static bool	log
	Report which file is included to stdout. More...

Detailed Description

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

Searches for files from user/group/shipped directories. The search scheme allows for version-specific and version-independent files using the following hierarchy:

• user settings:
  • ~/.OpenFOAM/<VERSION>
  • ~/.OpenFOAM/
• group (site) settings (when $WM_PROJECT_SITE is set):
  • $WM_PROJECT_SITE/<VERSION>
  • $WM_PROJECT_SITE
• group (site) settings (when $WM_PROJECT_SITE is not set):
  • $WM_PROJECT_INST_DIR/site/<VERSION>
  • $WM_PROJECT_INST_DIR/site/
• other (shipped) settings:
  • $WM_PROJECT_DIR/etc/

An example of the #includeEtc directive:

    #includeEtc "etcFile"

The usual expansion of environment variables and other constructs is retained.

See also

findEtcFile, fileName, string::expand()

Source files

• includeEtcEntry.H
• includeEtcEntry.C

Definition at line 77 of file includeEtcEntry.H.

Member Function Documentation

ClassName

(

"includeEtc"

)

Runtime type information.

bool execute ( dictionary &  parentDict, Istream &  is  )

static

Execute the functionEntry in a sub-dict context.

Definition at line 97 of file includeEtcEntry.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, includeEtcEntry::log, dictionaryName::name(), IFstream::name(), 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 134 of file includeEtcEntry.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, includeEtcEntry::log, dictionaryName::name(), IFstream::name(), and primitiveEntry::read().

Here is the call graph for this function:

Member Data Documentation

bool log

static

Report which file is included to stdout.

Definition at line 102 of file includeEtcEntry.H.

Referenced by includeEtcEntry::execute().

---

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

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