Public Member Functions | Static Public Member Functions | List of all members
inputModeEntry Class Reference

Specify the input mode when reading dictionaries, expects a single word to follow. More...

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

Public Member Functions

 ClassName ("inputMode")
 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 void clear ()
 Reset the inputMode to default (ie, merge) More...
 
static bool merge ()
 Return true if the inputMode is merge. More...
 
static bool overwrite ()
 Return true if the inputMode is overwrite. More...
 
static bool protect ()
 Return true if the inputMode is protect. More...
 
static bool error ()
 Return true if the inputMode is error. 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...
 

Detailed Description

Specify the input mode when reading dictionaries, expects a single word to follow.

An example of #inputMode directive:

    #inputMode merge

The possible input modes:

Parameters
mergemerge sub-dictionaries when possible
overwritekeep last entry and silently remove previous ones
protectkeep initial entry and silently ignore subsequent ones
warnkeep initial entry and warn about subsequent ones
errorissue a FatalError for duplicate entries
defaultcurrently identical to merge
Source files

Definition at line 64 of file inputModeEntry.H.

Member Function Documentation

ClassName ( "inputMode"  )

Runtime type information.

bool execute ( dictionary parentDict,
Istream is 
)
static

Execute the functionEntry in a sub-dict context.

Definition at line 99 of file inputModeEntry.C.

void clear ( )
static

Reset the inputMode to default (ie, merge)

Definition at line 109 of file inputModeEntry.C.

Referenced by dictionary::dictionary(), and Foam::operator>>().

Here is the caller graph for this function:

bool merge ( )
static

Return true if the inputMode is merge.

Definition at line 115 of file inputModeEntry.C.

Referenced by entry::New().

Here is the caller graph for this function:

bool overwrite ( )
static

Return true if the inputMode is overwrite.

Definition at line 121 of file inputModeEntry.C.

Referenced by entry::New().

Here is the caller graph for this function:

bool protect ( )
static

Return true if the inputMode is protect.

Definition at line 127 of file inputModeEntry.C.

Referenced by entry::New().

Here is the caller graph for this function:

bool error ( )
static

Return true if the inputMode is error.

Definition at line 132 of file inputModeEntry.C.

Referenced by entry::New().

Here is the caller graph for this function:


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