OpenFOAM logo
Open Source CFD Toolkit

dictionaryEntry Class Reference

Inheritance diagram for dictionaryEntry:

Inheritance graph
[legend]
Collaboration diagram for dictionaryEntry:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 dictionaryEntry (Istream &)
 Construct from Istream.
 dictionaryEntry (const word &keyword, Istream &)
 Construct from keyword and a Istream.
 dictionaryEntry (const word &keyword, const dictionary &)
 Construct from keyword and a dictionary.
autoPtr< entryclone () const
 Construct and return clone.
const fileNamename () const
 Return the dictionary name.
fileNamename ()
 Return the dictionary name.
label startLineNumber () const
 Return line number of first token in dictionary.
label endLineNumber () const
 Return line number of last token in dictionary.
ITstreamstream () const
 Return token stream if this entry is a dictionary entry.
bool isDict () const
 Return true because this entry is a dictionary.
const dictionarydict () const
 Return token stream if this entry is a dictionary entry.
void write (Ostream &) const
 Write.
InfoProxy< dictionaryEntryinfo () const
 Return info proxy.

Friends

Ostreamoperator<< (Ostream &, const dictionaryEntry &)

Constructor & Destructor Documentation

dictionaryEntry Istream  ) 
 

Construct from Istream.

dictionaryEntry const word keyword,
Istream
 

Construct from keyword and a Istream.

dictionaryEntry const word keyword,
const dictionary
 

Construct from keyword and a dictionary.


Member Function Documentation

autoPtr<entry> clone  )  const [inline]
 

Construct and return clone.

Reimplemented from dictionary.

Definition at line 88 of file dictionaryEntry.H.

References Foam::name().

Here is the call graph for this function:

const dictionary& dict  )  const [virtual]
 

Return token stream if this entry is a dictionary entry.

Implements entry.

label endLineNumber  )  const
 

Return line number of last token in dictionary.

Reimplemented from dictionary.

InfoProxy<dictionaryEntry> info  )  const [inline]
 

Return info proxy.

Used to print token information to a stream

Definition at line 133 of file dictionaryEntry.H.

bool isDict  )  const [inline, virtual]
 

Return true because this entry is a dictionary.

Reimplemented from entry.

Definition at line 118 of file dictionaryEntry.H.

fileName& name  )  [inline]
 

Return the dictionary name.

Reimplemented from dictionary.

Definition at line 103 of file dictionaryEntry.H.

References Foam::label.

const fileName& name  )  const [inline]
 

Return the dictionary name.

Reimplemented from dictionary.

Definition at line 97 of file dictionaryEntry.H.

References Foam::name().

Here is the call graph for this function:

label startLineNumber  )  const
 

Return line number of first token in dictionary.

Reimplemented from dictionary.

ITstream& stream  )  const [virtual]
 

Return token stream if this entry is a dictionary entry.

Implements entry.

void write Ostream  )  const [virtual]
 

Write.

Implements entry.


Friends And Related Function Documentation

Ostream& operator<< Ostream ,
const dictionaryEntry
[friend]
 


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org