OpenFOAM logo
Open Source CFD Toolkit

entry Class Reference

Inheritance diagram for entry:

Inheritance graph
[legend]
Collaboration diagram for entry:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 entry (const word &keyword)
 Construct from keyword.
 entry (const entry &)
 Construct as copy.
virtual autoPtr< entryclone () const =0
virtual ~entry ()
const wordkeyword () const
 Return keyword.
virtual const fileNamename () const =0
 Return the dictionary name.
virtual fileNamename ()=0
 Return the dictionary name.
virtual label startLineNumber () const =0
 Return line number of first token in dictionary.
virtual label endLineNumber () const =0
 Return line number of last token in dictionary.
virtual bool isStream () const
 Return true if this entry is a stream.
virtual ITstreamstream () const =0
 Return token stream if this entry is a primitive entry.
virtual bool isDict () const
 Return true if this entry is a dictionary.
virtual const dictionarydict () const =0
 Return token stream if this entry is a primitive entry.
virtual void write (Ostream &) const =0
 Write.
void operator= (const entry &)

Static Public Member Functions

autoPtr< entryNew (Istream &is)
 Construct on freestore from Istream.

Friends

Ostreamoperator<< (Ostream &, const entry &)

Constructor & Destructor Documentation

entry const word keyword  ) 
 

Construct from keyword.

entry const entry  ) 
 

Construct as copy.

virtual ~entry  )  [inline, virtual]
 

Definition at line 95 of file entry.H.


Member Function Documentation

virtual autoPtr<entry> clone  )  const [pure virtual]
 

Implemented in dictionaryEntry, and primitiveEntry.

virtual const dictionary& dict  )  const [pure virtual]
 

Return token stream if this entry is a primitive entry.

Implemented in dictionaryEntry, and primitiveEntry.

virtual label endLineNumber  )  const [pure virtual]
 

Return line number of last token in dictionary.

Implemented in dictionaryEntry, and primitiveEntry.

virtual bool isDict  )  const [inline, virtual]
 

Return true if this entry is a dictionary.

Reimplemented in dictionaryEntry.

Definition at line 129 of file entry.H.

virtual bool isStream  )  const [inline, virtual]
 

Return true if this entry is a stream.

Reimplemented in primitiveEntry.

Definition at line 120 of file entry.H.

const word& keyword  )  const [inline]
 

Return keyword.

Definition at line 102 of file entry.H.

References Foam::label.

virtual fileName& name  )  [pure virtual]
 

Return the dictionary name.

Implemented in dictionaryEntry, and primitiveEntry.

virtual const fileName& name  )  const [pure virtual]
 

Return the dictionary name.

Implemented in dictionaryEntry, and primitiveEntry.

autoPtr<entry> New Istream is  )  [static]
 

Construct on freestore from Istream.

void operator= const entry  ) 
 

virtual label startLineNumber  )  const [pure virtual]
 

Return line number of first token in dictionary.

Implemented in dictionaryEntry, and primitiveEntry.

virtual ITstream& stream  )  const [pure virtual]
 

Return token stream if this entry is a primitive entry.

Implemented in dictionaryEntry, and primitiveEntry.

virtual void write Ostream  )  const [pure virtual]
 

Write.

Implemented in dictionaryEntry, and primitiveEntry.


Friends And Related Function Documentation

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


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