namedDictionary Class Reference

A tuple of keyType and dictionary, which can be used when reading named or unnamed dictionary entries or simply a name. More...

#include <namedDictionary.H>

Inheritance diagram for namedDictionary:

Collaboration diagram for namedDictionary:

Public Member Functions
	namedDictionary ()=default
	Default construct.
	namedDictionary (Istream &is)
	Construct from Istream.
	~namedDictionary ()=default
	Destructor.
void	clear ()
	Clear keyword and dictionary.
bool	empty () const noexcept
	Empty if both keyword and dictionary are empty.
const keyType &	keyword () const noexcept
	Return keyword.
keyType &	keyword () noexcept
	Return non-const access to keyword.
const dictionary &	dict () const noexcept
	Read-access to the dictionay.
dictionary &	dict () noexcept
	Write access to the dictionay.
Public Member Functions inherited from Tuple2< keyType, dictionary >
	Tuple2 ()=default
	Default construct.
const keyType &	first () const noexcept
	Access the first element.
const dictionary &	second () const noexcept
	Access the second element.

Friends
Istream &	operator>> (Istream &, namedDictionary &)
Ostream &	operator<< (Ostream &, const namedDictionary &)

Additional Inherited Members
Public Types inherited from Tuple2< keyType, dictionary >
typedef keyType	first_type
	Type of member first, the first template parameter (T1).
typedef dictionary	second_type
	Type of member second, the second template parameter (T2).

Detailed Description

A tuple of keyType and dictionary, which can be used when reading named or unnamed dictionary entries or simply a name.

For example,

fields
(
    U
    T { relax  false; }
);

The namedDictionary can also be used in situations where an individual dictionary entry should be read. The keyword() and dict() methods correspond to Foam::entry naming conventions.

actions
(
    testing { action new; ... }   // An action with a name
    { action subset;  }           // Unnamed action
);

Normal dictionary reading would fail for this type of input since the leading 'testing' keyword would cause the entire content to be considered a single dictionary.

Note

No distinction currently made between a missing and an empty dictionary.

Source files

• namedDictionary.H
• namedDictionary.C

Definition at line 81 of file namedDictionary.H.

Constructor & Destructor Documentation

namedDictionary() [1/2]

namedDictionary ( )

default

Default construct.

Referenced by operator<<, and operator>>.

Here is the caller graph for this function:

namedDictionary() [2/2]

namedDictionary ( Istream & is )

explicit

Construct from Istream.

Definition at line 26 of file namedDictionary.C.

~namedDictionary()

~namedDictionary ( )

default

Destructor.

References Foam::noexcept.

Member Function Documentation

clear()

void clear

(

)

Clear keyword and dictionary.

Definition at line 34 of file namedDictionary.C.

References Tuple2< keyType, dictionary >::first(), and Tuple2< keyType, dictionary >::second().

Referenced by Foam::operator>>().

Here is the call graph for this function:

Here is the caller graph for this function:

empty()

bool empty ( ) const

noexcept

Empty if both keyword and dictionary are empty.

Definition at line 41 of file namedDictionary.C.

References empty(), Tuple2< keyType, dictionary >::first(), Foam::noexcept, and Tuple2< keyType, dictionary >::second().

Referenced by empty().

Here is the call graph for this function:

Here is the caller graph for this function:

keyword() [1/2]

const keyType & keyword ( ) const

inlinenoexcept

Return keyword.

Definition at line 126 of file namedDictionary.H.

References Tuple2< keyType, dictionary >::first(), keyword(), and Foam::noexcept.

Referenced by keyword(), Foam::operator<<(), and Foam::operator>>().

Here is the call graph for this function:

Here is the caller graph for this function:

keyword() [2/2]

keyType & keyword ( )

inlinenoexcept

Return non-const access to keyword.

Definition at line 131 of file namedDictionary.H.

References Tuple2< keyType, dictionary >::first(), and Foam::noexcept.

Here is the call graph for this function:

dict() [1/2]

const dictionary & dict ( ) const

inlinenoexcept

Read-access to the dictionay.

Definition at line 136 of file namedDictionary.H.

References Foam::noexcept, and Tuple2< keyType, dictionary >::second().

Referenced by Foam::operator<<(), and Foam::operator>>().

Here is the call graph for this function:

Here is the caller graph for this function:

dict() [2/2]

dictionary & dict ( )

inlinenoexcept

Write access to the dictionay.

Definition at line 141 of file namedDictionary.H.

References Foam::noexcept, and Tuple2< keyType, dictionary >::second().

Here is the call graph for this function:

Friends And Related Symbol Documentation

operator>>

Istream & operator>> ( Istream & , namedDictionary &  )

friend

References namedDictionary().

operator<<

Ostream & operator<< ( Ostream & , const namedDictionary &  )

friend

References namedDictionary().

---

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

• src/OpenFOAM/db/dictionary/namedDictionary/namedDictionary.H
• src/OpenFOAM/db/dictionary/namedDictionary/namedDictionary.C