Public Member Functions | Static Public Member Functions | List of all members
printDictionary Class Reference

Enables the printing of a dictionary and subsequently looked-up defaulted entries. More...

Public Member Functions

template<class ... Args>
 printDictionary (const dictionary &dict, const Args &... args)
 Construct adding a dictionary to the list to be printed. More...
 
template<class ... Args>
 printDictionary (const fileName &dictName, const Args &... args)
 Construct adding a dictionary name to the list to be printed. More...
 
 ~printDictionary ()
 Destructor. More...
 

Static Public Member Functions

static void set (const dictionary &dict)
 Set the dictionary to be printed. More...
 
static bool prints (const dictionary &dict)
 Return if a dictionary is marked to be printed. More...
 
static bool prints (const fileName &dictName)
 Return if a dictionary is marked to be printed. More...
 
static bool haveDefaults (const dictionary &dict)
 Return if a dictionary exists to add defaults to for a given. More...
 
static dictionary & defaults (const dictionary &dict)
 Return the dictionary to add defaults to for a given dictionary. More...
 

Detailed Description

Enables the printing of a dictionary and subsequently looked-up defaulted entries.

Source files

Definition at line 53 of file printDictionary.H.

Constructor & Destructor Documentation

◆ printDictionary() [1/2]

printDictionary ( const dictionary &  dict,
const Args &...  args 
)
inline

Construct adding a dictionary to the list to be printed.

Definition at line 133 of file printDictionary.H.

References Foam::add(), and dict.

Here is the call graph for this function:

◆ printDictionary() [2/2]

printDictionary ( const fileName &  dictName,
const Args &...  args 
)
inline

Construct adding a dictionary name to the list to be printed.

Definition at line 142 of file printDictionary.H.

References Foam::add().

Here is the call graph for this function:

◆ ~printDictionary()

~printDictionary ( )

Destructor.

Definition at line 242 of file printDictionary.C.

References Foam::count(), Foam::decrIndent(), Tuple2< Type1, Type2 >::first(), forAll, Foam::indent(), Foam::Info, dictionaryName::name(), fileName::relativePath(), and Tuple2< Type1, Type2 >::second().

Here is the call graph for this function:

Member Function Documentation

◆ set()

void set ( const dictionary &  dict)
static

Set the dictionary to be printed.

Definition at line 274 of file printDictionary.C.

References Foam::count(), dict, and dictionaryName::name().

Referenced by printEntry::execute(), and Foam::readConfigFile().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ prints() [1/2]

static bool prints ( const dictionary &  dict)
inlinestatic

Return if a dictionary is marked to be printed.

Definition at line 160 of file printDictionary.H.

References dict.

◆ prints() [2/2]

static bool prints ( const fileName &  dictName)
inlinestatic

Return if a dictionary is marked to be printed.

Definition at line 166 of file printDictionary.H.

◆ haveDefaults()

static bool haveDefaults ( const dictionary &  dict)
inlinestatic

Return if a dictionary exists to add defaults to for a given.

dictionary

Definition at line 173 of file printDictionary.H.

Referenced by dimensioned< Type >::dimensioned().

Here is the caller graph for this function:

◆ defaults()

static dictionary& defaults ( const dictionary &  dict)
inlinestatic

Return the dictionary to add defaults to for a given dictionary.

Definition at line 179 of file printDictionary.H.

References dict.

Referenced by dimensioned< Type >::dimensioned(), and NamedEnum< vtkPolyhedra, 3 >::lookupOrDefault().

Here is the caller graph for this function:
The documentation for this class was generated from the following files: