A keyword and a list of tokens is a 'dictionaryEntry'. More...
Public Member Functions | |
| dictionaryEntry (const dictionary &parentDict, Istream &) | |
| Construct from the parent dictionary and Istream. More... | |
| dictionaryEntry (const keyType &, const dictionary &parentDict, Istream &) | |
| Construct from the keyword, parent dictionary and a Istream. More... | |
| dictionaryEntry (const keyType &, const dictionary &parentDict, const dictionary &dict) | |
| Construct from the keyword, parent dictionary and a dictionary. More... | |
| dictionaryEntry (const dictionary &parentDict, const dictionaryEntry &) | |
| Construct as copy for the given parent dictionary. More... | |
| autoPtr< entry > | clone (const dictionary &parentDict) const |
| Construct on freestore as copy with reference to the. More... | |
| const word | dictName () const |
| Return the local dictionary name (final part of scoped name) More... | |
| const fileName & | name () const |
| Return the dictionary name (scoped, e.g. dictA::dictB::dictC) More... | |
| fileName & | name () |
| Return the dictionary name (scoped, e.g. dictA::dictB::dictC) More... | |
| label | startLineNumber () const |
| Return line number of first token in dictionary. More... | |
| label | endLineNumber () const |
| Return line number of last token in dictionary. More... | |
| ITstream & | stream () const |
| This entry is not a primitive,. More... | |
| bool | isDict () const |
| Return true because this entry is a dictionary. More... | |
| const dictionary & | dict () const |
| Return dictionary. More... | |
| dictionary & | dict () |
| Return non-const access to dictionary. More... | |
| void | write (Ostream &) const |
| Write. More... | |
| InfoProxy< dictionaryEntry > | info () const |
| Return info proxy. More... | |
 Public Member Functions inherited from entry | |
| entry (const keyType &) | |
| Construct from keyword. More... | |
| entry (const entry &) | |
| Construct as copy. More... | |
| virtual autoPtr< entry > | clone () const |
| Construct on freestore as copy. More... | |
| virtual | ~entry () |
| Destructor. More... | |
| const keyType & | keyword () const |
| Return keyword. More... | |
| keyType & | keyword () |
| Return non-const access to keyword. More... | |
| virtual bool | isStream () const |
| Return true if this entry is a stream. More... | |
| void | operator= (const entry &) |
| bool | operator== (const entry &) const |
| bool | operator!= (const entry &) const |
| Public Member Functions inherited from dictionary | |
| ClassName ("dictionary") | |
| dictionary () | |
| Construct top-level dictionary null. More... | |
| dictionary (const fileName &name) | |
| Construct top-level empty dictionary with given name. More... | |
| dictionary (const fileName &name, const dictionary &parentDict, Istream &) | |
| Construct given the entry name, parent dictionary and Istream,. More... | |
| dictionary (Istream &) | |
| Construct top-level dictionary from Istream,. More... | |
| dictionary (Istream &, const bool keepHeader) | |
| Construct top-level dictionary from Istream,. More... | |
| dictionary (const dictionary &parentDict, const dictionary &) | |
| Construct as copy given the parent dictionary. More... | |
| dictionary (const dictionary &) | |
| Construct top-level dictionary as copy. More... | |
| dictionary (const dictionary *) | |
| Construct top-level dictionary as copy from pointer to dictionary. More... | |
| dictionary (const dictionary &parentDict, const Xfer< dictionary > &) | |
| Construct by transferring parameter contents given parent dictionary. More... | |
| dictionary (const Xfer< dictionary > &) | |
| Construct top-level dictionary by transferring parameter contents. More... | |
| autoPtr< dictionary > | clone () const |
| Construct and return clone. More... | |
| virtual | ~dictionary () |
| Destructor. More... | |
| const dictionary & | parent () const |
| Return the parent dictionary. More... | |
| const dictionary & | topDict () const |
| Return the top of the tree. More... | |
| label | startLineNumber () const |
| Return line number of first token in dictionary. More... | |
| label | endLineNumber () const |
| Return line number of last token in dictionary. More... | |
| SHA1Digest | digest () const |
| Return the SHA1 digest of the dictionary contents. More... | |
| tokenList | tokens () const |
| Return the dictionary as a list of tokens. More... | |
| bool | found (const word &, bool recursive=false, bool patternMatch=true) const |
| Search dictionary for given keyword. More... | |
| const entry * | lookupEntryPtr (const word &, bool recursive, bool patternMatch) const |
| Find and return an entry data stream pointer if present. More... | |
| entry * | lookupEntryPtr (const word &, bool recursive, bool patternMatch) |
| Find and return an entry data stream pointer for manipulation. More... | |
| const entry & | lookupEntry (const word &, bool recursive, bool patternMatch) const |
| Find and return an entry data stream if present otherwise error. More... | |
| ITstream & | lookup (const word &, bool recursive=false, bool patternMatch=true) const |
| Find and return an entry data stream. More... | |
| template<class T > | |
| T | lookupType (const word &, bool recursive=false, bool patternMatch=true) const |
| Find and return a T,. More... | |
| template<class T > | |
| T | lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const |
| Find and return a T,. More... | |
| template<class T > | |
| T | lookupOrAddDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) |
| Find and return a T, if not found return the given. More... | |
| template<class T > | |
| bool | readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const |
| Find an entry if present, and assign to T. More... | |
| const entry * | lookupScopedEntryPtr (const word &, bool recursive, bool patternMatch) const |
| Find and return an entry data stream pointer if present. More... | |
| bool | isDict (const word &) const |
| Check if entry is a sub-dictionary. More... | |
| const dictionary * | subDictPtr (const word &) const |
| Find and return a sub-dictionary pointer if present. More... | |
| dictionary * | subDictPtr (const word &) |
| Find and return a sub-dictionary pointer if present. More... | |
| const dictionary & | subDict (const word &) const |
| Find and return a sub-dictionary. More... | |
| dictionary & | subDict (const word &) |
| Find and return a sub-dictionary for manipulation. More... | |
| dictionary | subOrEmptyDict (const word &, const bool mustRead=false) const |
| Find and return a sub-dictionary as a copy, or. More... | |
| const dictionary & | optionalSubDict (const word &) const |
| Find and return a sub-dictionary if found. More... | |
| wordList | toc () const |
| Return the table of contents. More... | |
| wordList | sortedToc () const |
| Return the sorted table of contents. More... | |
| List< keyType > | keys (bool patterns=false) const |
| Return the list of available keys or patterns. More... | |
| bool | substituteKeyword (const word &keyword) |
| Substitute the given keyword prepended by '$' with the. More... | |
| bool | substituteScopedKeyword (const word &keyword) |
| Substitute the given scoped keyword prepended by '$' with the. More... | |
| bool | add (entry *, bool mergeEntry=false) |
| Add a new entry. More... | |
| void | add (const entry &, bool mergeEntry=false) |
| Add an entry. More... | |
| void | add (const keyType &, const word &, bool overwrite=false) |
| Add a word entry. More... | |
| void | add (const keyType &, const string &, bool overwrite=false) |
| Add a string entry. More... | |
| void | add (const keyType &, const label, bool overwrite=false) |
| Add a label entry. More... | |
| void | add (const keyType &, const scalar, bool overwrite=false) |
| Add a scalar entry. More... | |
| void | add (const keyType &, const dictionary &, bool mergeEntry=false) |
| Add a dictionary entry. More... | |
| template<class T > | |
| void | add (const keyType &, const T &, bool overwrite=false) |
| Add a T entry. More... | |
| void | set (entry *) |
| Assign a new entry, overwrite any existing entry. More... | |
| void | set (const entry &) |
| Assign a new entry, overwrite any existing entry. More... | |
| void | set (const keyType &, const dictionary &) |
| Assign a dictionary entry, overwrite any existing entry. More... | |
| template<class T > | |
| void | set (const keyType &, const T &) |
| Assign a T entry, overwrite any existing entry. More... | |
| bool | remove (const word &) |
| Remove an entry specified by keyword. More... | |
| bool | changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false) |
| Change the keyword for an entry,. More... | |
| bool | merge (const dictionary &) |
| Merge entries from the given dictionary. More... | |
| void | clear () |
| Clear the dictionary. More... | |
| void | transfer (dictionary &) |
| Transfer the contents of the argument and annul the argument. More... | |
| Xfer< dictionary > | xfer () |
| Transfer contents to the Xfer container. More... | |
| bool | read (Istream &) |
| Read dictionary from Istream. More... | |
| bool | read (Istream &, const bool keepHeader) |
| Read dictionary from Istream, optionally keeping the header. More... | |
| void | write (Ostream &, const bool subDict=true) const |
| Write dictionary, normally with sub-dictionary formatting. More... | |
| ITstream & | operator[] (const word &) const |
| Find and return entry. More... | |
| void | operator= (const dictionary &) |
| void | operator+= (const dictionary &) |
| Include entries from the given dictionary. More... | |
| void | operator|= (const dictionary &) |
| Conditionally include entries from the given dictionary. More... | |
| void | operator<<= (const dictionary &) |
| Unconditionally include entries from the given dictionary. More... | |
| Public Member Functions inherited from dictionaryName | |
| dictionaryName () | |
| Construct dictionaryName null. More... | |
| dictionaryName (const fileName &name) | |
| Construct dictionaryName as copy of the given fileName. More... | |
| const fileName & | name () const |
| Return the dictionary name. More... | |
| fileName & | name () |
| Return the dictionary name. More... | |
| const word | dictName () const |
| Return the local dictionary name (final part of scoped name) More... | |
| Public Member Functions inherited from ILList< LListBase, T > | |
| ILList () | |
| Null construct. More... | |
| ILList (T *a) | |
| Construct given initial T. More... | |
| ILList (Istream &) | |
| Construct from Istream. More... | |
| ILList (const ILList< LListBase, T > &) | |
| Construct as copy. More... | |
| template<class CloneArg > | |
| ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg) | |
| Copy constructor with additional argument for clone. More... | |
| template<class INew > | |
| ILList (Istream &, const INew &) | |
| Construct from Istream using given Istream constructor class. More... | |
| ~ILList () | |
| Destructor. More... | |
| bool | eraseHead () |
| Remove the head element specified from the list and delete it. More... | |
| bool | erase (T *p) |
| Remove the specified element from the list and delete it. More... | |
| void | clear () |
| Clear the contents of the list. More... | |
| void | transfer (ILList< LListBase, T > &) |
| Transfer the contents of the argument into this List. More... | |
| void | operator= (const ILList< LListBase, T > &) |
| Assignment operator. More... | |
| Public Member Functions inherited from UILList< LListBase, T > | |
| UILList () | |
| Null construct. More... | |
| UILList (T *a) | |
| Construct given initial T. More... | |
| UILList (const UILList< LListBase, T > &) | |
| Construct as copy. More... | |
| T * | first () |
| Return the first entry. More... | |
| const T * | first () const |
| Return the first entry. More... | |
| T * | last () |
| Return the last entry. More... | |
| const T * | last () const |
| Return the last entry. More... | |
| T * | removeHead () |
| Remove and return head. More... | |
| T * | remove (T *p) |
| Remove and return element. More... | |
| T * | remove (iterator &it) |
| Remove and return specified by iterator. More... | |
| void | operator= (const UILList< LListBase, T > &) |
| iterator | begin () |
| const iterator & | end () |
| const_iterator | cbegin () const |
| const const_iterator & | cend () const |
| const_iterator | begin () const |
| const const_iterator & | end () const |
| const_reverse_iterator | crbegin () const |
| const const_reverse_iterator & | crend () const |
| const_reverse_iterator | rbegin () const |
| const const_reverse_iterator & | rend () const |
| bool | operator== (const UILList< LListBase, T > &) const |
| Equality operation on ULists of the same type. More... | |
| bool | operator!= (const UILList< LListBase, T > &) const |
| The opposite of the equality operation. Takes linear time. More... | |
Friends | |
| Ostream & | operator<< (Ostream &, const dictionaryEntry &) |
Additional Inherited Members | |
| Public Types inherited from UILList< LListBase, T > | |
| typedef T | value_type |
| Type of values the DLList contains. More... | |
| typedef T & | reference |
| Type that can be used for storing into DLList::value_type. More... | |
| typedef const T & | const_reference |
| Type that can be used for storing into constant. More... | |
| typedef label | size_type |
| The type that can represent the size of a DLList. More... | |
| typedef LListBase::iterator | LListBase_iterator |
| typedef LListBase::const_iterator | LListBase_const_iterator |
| Static Public Member Functions inherited from entry | |
| static bool | New (dictionary &parentDict, Istream &) |
| Construct from Istream and insert into dictionary. More... | |
| static autoPtr< entry > | New (Istream &is) |
| Construct on freestore from Istream and return. More... | |
| Static Public Member Functions inherited from dictionary | |
| static autoPtr< dictionary > | New (Istream &) |
| Construct top-level dictionary on freestore from Istream. More... | |
| Static Public Attributes inherited from entry | |
| static int | disableFunctionEntries |
| Static Public Attributes inherited from dictionary | |
| static const dictionary | null |
| Null dictionary. More... | |
A keyword and a list of tokens is a 'dictionaryEntry'.
An dictionaryEntry can be read, written and printed, and the types and values of its tokens analysed. A dictionaryEntry is a high-level building block for data description. It is a front-end for the token parser. A list of entries can be used as a set of keyword syntax elements, for example.
Definition at line 64 of file dictionaryEntry.H.
| dictionaryEntry | ( | const dictionary & | parentDict, |
| Istream & | is | ||
| ) |
Construct from the parent dictionary and Istream.
Definition at line 33 of file dictionaryEntryIO.C.
References IOstream::fatalCheck().
| dictionaryEntry | ( | const keyType & | key, |
| const dictionary & | parentDict, | ||
| Istream & | is | ||
| ) |
Construct from the keyword, parent dictionary and a Istream.
Definition at line 50 of file dictionaryEntryIO.C.
References IOstream::fatalCheck().
| dictionaryEntry | ( | const keyType & | key, |
| const dictionary & | parentDict, | ||
| const dictionary & | dict | ||
| ) |
Construct from the keyword, parent dictionary and a dictionary.
Definition at line 31 of file dictionaryEntry.C.
| dictionaryEntry | ( | const dictionary & | parentDict, |
| const dictionaryEntry & | dictEnt | ||
| ) |
Construct as copy for the given parent dictionary.
Definition at line 43 of file dictionaryEntry.C.
|
inlinevirtual |
Construct on freestore as copy with reference to the.
dictionary the copy belongs to
Implements entry.
Reimplemented in dictionaryListEntry.
Definition at line 107 of file dictionaryEntry.H.
|
inline |
Return the local dictionary name (final part of scoped name)
Definition at line 116 of file dictionaryEntry.H.
References dictionaryName::dictName().
|
inlinevirtual |
Return the dictionary name (scoped, e.g. dictA::dictB::dictC)
Implements entry.
Definition at line 122 of file dictionaryEntry.H.
References dictionaryName::name().
Referenced by motionSolver::iNew::operator()().
|
inlinevirtual |
Return the dictionary name (scoped, e.g. dictA::dictB::dictC)
Implements entry.
Definition at line 128 of file dictionaryEntry.H.
References dictionaryEntry::endLineNumber(), dictionaryName::name(), dictionaryEntry::startLineNumber(), and dictionaryEntry::stream().
|
virtual |
Return line number of first token in dictionary.
Implements entry.
Definition at line 55 of file dictionaryEntry.C.
References UILList< LListBase, T >::first().
Referenced by dictionaryEntry::name().
|
virtual |
Return line number of last token in dictionary.
Implements entry.
Definition at line 68 of file dictionaryEntry.C.
References UILList< LListBase, T >::last().
Referenced by dictionaryEntry::name().
|
virtual |
This entry is not a primitive,.
calling this function generates a FatalError
Implements entry.
Definition at line 81 of file dictionaryEntry.C.
References Foam::abort(), Foam::FatalIOError, FatalIOErrorInFunction, and dictionary::lookup().
Referenced by dictionaryEntry::name().
|
inlinevirtual |
Return true because this entry is a dictionary.
Reimplemented from entry.
Definition at line 144 of file dictionaryEntry.H.
References dictionaryEntry::dict(), dictionaryEntry::info(), dictionaryEntry::operator<<, and dictionaryEntry::write().
|
virtual |
Return dictionary.
Implements entry.
Definition at line 91 of file dictionaryEntry.C.
Referenced by dictionaryEntry::isDict().
|
virtual |
Return non-const access to dictionary.
Implements entry.
Definition at line 97 of file dictionaryEntry.C.
|
virtual |
Write.
Implements entry.
Reimplemented in dictionaryListEntry.
Definition at line 69 of file dictionaryEntryIO.C.
References Ostream::indent(), entry::keyword(), Ostream::write(), and dictionary::write().
Referenced by dictionaryEntry::isDict(), and Foam::operator<<().
|
inline |
Return info proxy.
Used to print token information to a stream
Definition at line 160 of file dictionaryEntry.H.
Referenced by dictionaryEntry::isDict().
|
friend |
Referenced by dictionaryEntry::isDict().
1.8.13
