removeEntry Class Reference

Remove a dictionary entry. More...

#include <OpenFOAM/removeEntry.H>

---

Detailed Description

Remove a dictionary entry.

The #remove directive takes a list or a single wordRe. For example,

#remove entry0
#remove ( entry1 entry2 entry3 otherEntry )
#remove "entry[1-3]"
#remove ( "entry[1-3]" otherEntry )

The removal only occurs in the current context. Removing sub-entries or parent entries is not supported.

Source files

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

Definition at line 63 of file removeEntry.H.

Inheritance diagram for removeEntry:

Collaboration diagram for removeEntry:

List of all members.

Public Member Functions
	ClassName ("remove")
	Runtime type information.
Static Public Member Functions
static bool	execute (dictionary &parentDict, Istream &)
	Execute the functionEntry in a sub-dict context.

---

Member Function Documentation

ClassName

(

"remove"

)

Runtime type information.

bool execute	(	dictionary &	parentDict,
		Istream &	is
	)		[static]

Execute the functionEntry in a sub-dict context.

Definition at line 62 of file removeEntry.C.

References Foam::findStrings(), forAll, dictionary::remove(), and dictionary::toc().

---

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

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