OpenFOAM logo
Open Source CFD Toolkit

DictionaryBase Class Template Reference

Inheritance diagram for DictionaryBase:

Inheritance graph
[legend]
Collaboration diagram for DictionaryBase:

Collaboration graph
[legend]
List of all members.

template<class IDLListType, class T>
class Foam::DictionaryBase< IDLListType, T >


Public Member Functions

 DictionaryBase ()
 Null constructor.
 DictionaryBase (const DictionaryBase &)
 Copy construct.
template<class INew>
 DictionaryBase (Istream &is, const INew &inewt)
 Construct from Istream using given Istream constructor class.
 DictionaryBase (Istream &is)
 Construct from Istream.
bool found (const word &keyword) const
 Search DictionaryBase for given keyword.
const T * lookup (const word &) const
 Find and return entry.
T * lookup (const word &)
 Find and return entry.
wordList toc () const
 Return the table of contents.
void insert (const word &keyword, T *)
 Add at head of dictionary.
void append (const word &keyword, T *)
 Add at tail of dictionary.
T * remove (const word &keyword)
 Remove and return entry specified by keyword.
void clear ()
 Clear the dictionary.
void operator= (const DictionaryBase &)
const T * operator[] (const word &key) const
 Find and return entry.
T * operator[] (const word &key)
 Find and return entry.

Friends

Ostreamoperator (Ostream &, const DictionaryBase< IDLListType, T > &)

Constructor & Destructor Documentation

DictionaryBase  ) 
 

Null constructor.

DictionaryBase const DictionaryBase< IDLListType, T > &   ) 
 

Copy construct.

DictionaryBase Istream is,
const INew inewt
 

Construct from Istream using given Istream constructor class.

DictionaryBase Istream is  ) 
 

Construct from Istream.


Member Function Documentation

void append const word keyword,
T * 
 

Add at tail of dictionary.

void clear  ) 
 

Clear the dictionary.

bool found const word keyword  )  const
 

Search DictionaryBase for given keyword.

void insert const word keyword,
T * 
 

Add at head of dictionary.

T* lookup const word  ) 
 

Find and return entry.

const T* lookup const word  )  const
 

Find and return entry.

void operator= const DictionaryBase< IDLListType, T > &   ) 
 

T* operator[] const word key  )  [inline]
 

Find and return entry.

Definition at line 151 of file DictionaryBase.H.

const T* operator[] const word key  )  const [inline]
 

Find and return entry.

Definition at line 145 of file DictionaryBase.H.

T* remove const word keyword  ) 
 

Remove and return entry specified by keyword.

wordList toc  )  const
 

Return the table of contents.


Friends And Related Function Documentation

Ostream& operator Ostream ,
const DictionaryBase< IDLListType, T > & 
[friend]
 


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