FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

inputModeEntry Class Reference

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

#include <OpenFOAM/inputModeEntry.H>


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
protectkeepinitial entry and silently ignore subsequent ones
warnkeep initial entry and warn about subsequent ones
errorissue a FatalError for duplicate entries
defaultcurrentlyidentical to merge
Source files

Definition at line 65 of file inputModeEntry.H.

Inheritance diagram for inputModeEntry:
Collaboration diagram for inputModeEntry:

List of all members.

Public Member Functions

 ClassName ("inputMode")
 Runtime type information.

Static Public Member Functions

static bool  execute (dictionary &parentDict, Istream &)
 Execute the functionEntry in a sub-dict context.
static void  clear ()
 Reset the inputMode to default (ie, merge)
static bool  merge ()
 Return true if the inputMode is merge.
static bool  overwrite ()
 Return true if the inputMode is overwrite.
static bool  protect ()
 Return true if the inputMode is protect.
static bool  error ()
 Return true if the inputMode is error.

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 Foam::operator>>().

bool merge (  ) [static]

Return true if the inputMode is merge.

Definition at line 115 of file inputModeEntry.C.

Referenced by entry::New().

bool overwrite (  ) [static]

Return true if the inputMode is overwrite.

Definition at line 121 of file inputModeEntry.C.

Referenced by entry::New().

bool protect (  ) [static]

Return true if the inputMode is protect.

Definition at line 127 of file inputModeEntry.C.

Referenced by entry::New().

bool error (  ) [static]

Return true if the inputMode is error.

Definition at line 132 of file inputModeEntry.C.

Referenced by entry::New().


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