Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
includeEtcEntry Class Reference

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

Inheritance diagram for includeEtcEntry:
Inheritance graph
[legend]
Collaboration diagram for includeEtcEntry:
Collaboration graph
[legend]

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 report
 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:

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

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 98 of file includeEtcEntry.C.

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

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 137 of file includeEtcEntry.C.

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

Here is the call graph for this function:

Member Data Documentation

bool report
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: