Public Member Functions | Friends | List of all members
dictionaryEntry Class Reference

A keyword and a list of tokens is a 'dictionaryEntry'. More...

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

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< entryclone (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 fileNamename () const
 Return the dictionary name (scoped, e.g. dictA::dictB::dictC) More...
 
fileNamename ()
 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...
 
ITstreamstream () const
 This entry is not a primitive,. More...
 
bool isDict () const
 Return true because this entry is a dictionary. More...
 
const dictionarydict () const
 Return dictionary. More...
 
dictionarydict ()
 Return non-const access to dictionary. More...
 
void write (Ostream &) const
 Write. More...
 
InfoProxy< dictionaryEntryinfo () 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< entryclone () const
 Construct on freestore as copy. More...
 
virtual ~entry ()
 Destructor. More...
 
const keyTypekeyword () const
 Return keyword. More...
 
keyTypekeyword ()
 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 DLListBase::link
 link ()
 Null construct. More...
 
bool registered () const
 Check if the link is registered with the DLListBase. More...
 
void deregister ()
 Deregister the link after removal. More...
 
- 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< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. More...
 
const dictionaryparent () const
 Return the parent dictionary. More...
 
const dictionarytopDict () 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 entrylookupEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present. More...
 
entrylookupEntryPtr (const word &, bool recursive, bool patternMatch)
 Find and return an entry data stream pointer for manipulation. More...
 
const entrylookupEntry (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present otherwise error. More...
 
ITstreamlookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return an entry data stream. 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 entrylookupScopedEntryPtr (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 dictionarysubDictPtr (const word &) const
 Find and return a sub-dictionary pointer if present. More...
 
const dictionarysubDict (const word &) const
 Find and return a sub-dictionary. More...
 
dictionarysubDict (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...
 
wordList toc () const
 Return the table of contents. More...
 
List< keyTypekeys (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< dictionaryxfer ()
 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...
 
ITstreamoperator[] (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 fileNamename () const
 Return the dictionary name. More...
 
fileNamename ()
 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 IDLList< entry >
 IDLList ()
 Null construct. More...
 
 IDLList (const entry &a)
 Construct given initial T. More...
 
 IDLList (Istream &is, const INew &inewt)
 Construct from Istream using given Istream constructor class. More...
 
 IDLList (Istream &is)
 Construct from Istream. More...
 
 IDLList (const IDLList< entry > &idll, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
- Public Member Functions inherited from ILList< DLListBase, entry >
 ILList ()
 Null construct. More...
 
 ILList (entry *a)
 Construct given initial T. More...
 
 ILList (Istream &)
 Construct from Istream. More...
 
 ILList (const ILList< DLListBase, entry > &)
 Construct as copy. More...
 
 ILList (const ILList< DLListBase, entry > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
 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 (entry *p)
 Remove the specified element from the list and delete it. More...
 
void clear ()
 Clear the contents of the list. More...
 
void transfer (ILList< DLListBase, entry > &)
 Transfer the contents of the argument into this List. More...
 
void operator= (const ILList< DLListBase, entry > &)
 
- Public Member Functions inherited from UILList< DLListBase, entry >
 UILList ()
 Null construct. More...
 
 UILList (entry *a)
 Construct given initial T. More...
 
 UILList (const UILList< DLListBase, entry > &)
 Construct as copy. More...
 
entryfirst ()
 Return the first entry. More...
 
const entryfirst () const
 Return the first entry. More...
 
entrylast ()
 Return the last entry. More...
 
const entrylast () const
 Return the last entry. More...
 
entryremoveHead ()
 Remove and return head. More...
 
entryremove (entry *p)
 Remove and return element. More...
 
entryremove (iterator &it)
 Remove and return specified by iterator. More...
 
void operator= (const UILList< DLListBase, entry > &)
 
iterator begin ()
 
const_iterator begin () const
 
const iteratorend ()
 
const const_iteratorend () const
 
const_iterator cbegin () const
 
const const_iteratorcend () const
 
const_reverse_iterator crbegin () const
 
const const_reverse_iteratorcrend () const
 
const_reverse_iterator rbegin () const
 
const const_reverse_iteratorrend () const
 
bool operator== (const UILList< DLListBase, entry > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UILList< DLListBase, entry > &) const
 The opposite of the equality operation. Takes linear time. More...
 
- Public Member Functions inherited from DLListBase
 DLListBase ()
 Null construct. More...
 
 DLListBase (link *)
 Construct given initial entry. More...
 
 ~DLListBase ()
 Destructor. More...
 
label size () const
 Return number of elements in list. More...
 
bool empty () const
 Return true if the list is empty. More...
 
linkfirst ()
 Return first entry. More...
 
const linkfirst () const
 Return const access to first entry. More...
 
linklast ()
 Return last entry. More...
 
const linklast () const
 Return const access to last entry. More...
 
void insert (link *)
 Add at head of list. More...
 
void append (link *)
 Add at tail of list. More...
 
bool swapUp (link *)
 Swap this element with the one above unless it is at the top. More...
 
bool swapDown (link *)
 Swap this element with the one below unless it is at the bottom. More...
 
linkremoveHead ()
 Remove and return head. More...
 
linkremove (link *)
 Remove and return element. More...
 
linkremove (iterator &)
 
linkreplace (link *oldLink, link *newLink)
 Replace oldLink with newLink and return element. More...
 
linkreplace (iterator &oldIter, link *newLink)
 Replace oldIter with newLink and return element. More...
 
void clear ()
 Clear the list. More...
 
void transfer (DLListBase &)
 Transfer the contents of the argument into this List. More...
 
iterator begin ()
 
const iteratorend ()
 
const_iterator cbegin () const
 
const const_iteratorcend () const
 
const_iterator begin () const
 
const const_iteratorend () const
 
const_reverse_iterator crbegin () const
 
const const_reverse_iteratorcrend () const
 
const_reverse_iterator rbegin () const
 
const const_reverse_iteratorrend () const
 

Friends

Ostreamoperator<< (Ostream &, const dictionaryEntry &)
 

Additional Inherited Members

- Public Types inherited from UILList< DLListBase, entry >
typedef entry value_type
 Type of values the DLList contains. More...
 
typedef entryreference
 Type that can be used for storing into DLList::value_type. More...
 
typedef const entryconst_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 DLListBase::iterator LListBase_iterator
 
typedef DLListBase::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< entryNew (Istream &is)
 Construct on freestore from Istream and return. More...
 
- Static Public Member Functions inherited from dictionary
static autoPtr< dictionaryNew (Istream &)
 Construct top-level dictionary on freestore from Istream. More...
 
- Public Attributes inherited from DLListBase::link
linkprev_
 Pointer to next entry in list. More...
 
linknext_
 
- Static Public Attributes inherited from entry
static int disableFunctionEntries
 
- Static Public Attributes inherited from dictionary
static const dictionary null
 Null dictionary. More...
 

Detailed Description

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.

Source files

Definition at line 57 of file dictionaryEntry.H.

Constructor & Destructor Documentation

dictionaryEntry ( const dictionary parentDict,
Istream is 
)

Construct from the parent dictionary and Istream.

Definition at line 33 of file dictionaryEntryIO.C.

References IOstream::fatalCheck().

Here is the call graph for this function:

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().

Here is the call graph for this function:

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.

Member Function Documentation

autoPtr<entry> clone ( const dictionary parentDict) const
inlinevirtual

Construct on freestore as copy with reference to the.

dictionary the copy belongs to

Implements entry.

Definition at line 100 of file dictionaryEntry.H.

const word dictName ( ) const
inline

Return the local dictionary name (final part of scoped name)

Definition at line 109 of file dictionaryEntry.H.

References dictionaryName::dictName().

Here is the call graph for this function:

const fileName& name ( ) const
inlinevirtual

Return the dictionary name (scoped, e.g. dictA::dictB::dictC)

Implements entry.

Definition at line 115 of file dictionaryEntry.H.

References dictionaryName::name().

Here is the call graph for this function:

fileName& name ( )
inlinevirtual

Return the dictionary name (scoped, e.g. dictA::dictB::dictC)

Implements entry.

Definition at line 121 of file dictionaryEntry.H.

References dictionaryEntry::endLineNumber(), dictionaryName::name(), dictionaryEntry::startLineNumber(), and dictionaryEntry::stream().

Here is the call graph for this function:

Foam::label startLineNumber ( ) const
virtual

Return line number of first token in dictionary.

Implements entry.

Definition at line 55 of file dictionaryEntry.C.

References UILList< DLListBase, entry >::first(), DLListBase::size(), and entry::startLineNumber().

Referenced by dictionaryEntry::name().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label endLineNumber ( ) const
virtual

Return line number of last token in dictionary.

Implements entry.

Definition at line 68 of file dictionaryEntry.C.

References entry::endLineNumber(), UILList< DLListBase, entry >::last(), and DLListBase::size().

Referenced by dictionaryEntry::name().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::ITstream & stream ( ) const
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, FatalIOErrorIn, and dictionary::lookup().

Referenced by dictionaryEntry::name().

Here is the call graph for this function:

Here is the caller graph for this function:

bool isDict ( ) const
inlinevirtual

Return true because this entry is a dictionary.

Reimplemented from entry.

Definition at line 137 of file dictionaryEntry.H.

References dictionaryEntry::dict(), dictionaryEntry::info(), dictionaryEntry::operator<<, and dictionaryEntry::write().

Here is the call graph for this function:

const Foam::dictionary & dict ( ) const
virtual

Return dictionary.

Implements entry.

Definition at line 91 of file dictionaryEntry.C.

Referenced by dictionaryEntry::isDict().

Here is the caller graph for this function:

Foam::dictionary & dict ( )
virtual

Return non-const access to dictionary.

Implements entry.

Definition at line 97 of file dictionaryEntry.C.

void write ( Ostream os) const
virtual

Write.

Implements entry.

Definition at line 69 of file dictionaryEntryIO.C.

References Foam::e, Foam::endl(), Ostream::indent(), entry::keyword(), Foam::operator<<(), Ostream::write(), dictionaryEntry::write(), and dictionary::write().

Referenced by dictionaryEntry::isDict(), and dictionaryEntry::write().

Here is the call graph for this function:

Here is the caller graph for this function:

InfoProxy<dictionaryEntry> info ( ) const
inline

Return info proxy.

Used to print token information to a stream

Definition at line 153 of file dictionaryEntry.H.

Referenced by dictionaryEntry::isDict().

Here is the caller graph for this function:

Friends And Related Function Documentation

Ostream& operator<< ( Ostream ,
const dictionaryEntry  
)
friend

Referenced by dictionaryEntry::isDict().


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