Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
dictionary::Searcher< Const > Class Template Reference

Generic const/non-const dictionary entry searcher. More...

Public Types

typedef std::conditional< Const, const dictionary, dictionary >::type dict_type
 The const/non-const type for the context and sub-dictionaries. More...
 
typedef std::conditional< Const, const entry, entry >::type value_type
 The const/non-const type for entries. More...
 
typedef dict_type * dict_pointer
 A pointer to a const/non-const dictionary. More...
 
typedef dict_type & dict_reference
 A reference to a const/non-const dictionary. More...
 
typedef value_type * pointer
 A pointer to a const/non-const entry. More...
 
typedef value_type & reference
 A reference to a const/non-const entry. More...
 

Public Member Functions

constexpr Searcher () noexcept
 Default construct. More...
 
bool good () const noexcept
 True if entry was found. More...
 
bool found () const noexcept
 True if entry was found. More...
 
dict_reference context () const
 The containing dictionary context. More...
 
pointer ptr () const noexcept
 A pointer to the entry (nullptr if not found) More...
 
reference ref () const
 A reference to the entry (Error if not found) More...
 
bool isDict () const noexcept
 True if found entry is a dictionary. More...
 
dict_pointer dictPtr () const noexcept
 Pointer to the found entry as a dictionary, nullptr otherwise. More...
 
dict_reference dict () const
 Reference the found entry as a dictionary. More...
 
 operator const Searcher<!Const > & () const
 Permit an explicit cast to the other (const/non-const) searcher. More...
 
pointer operator-> () const noexcept
 A pointer to the entry (nullptr if not found) More...
 
reference operator* () const
 A reference to the entry (Error if not found) More...
 

Public Attributes

friend dictionary
 

Protected Member Functions

 Searcher (dict_pointer dict) noexcept
 Construct for the given dictionary context. More...
 
void set (pointer eptr) noexcept
 Assign the entry. More...
 

Protected Attributes

dict_pointer dict_
 The dictionary context for the entry. More...
 
pointer eptr_
 The entry or nullptr. More...
 

Detailed Description

template<bool Const>
class Foam::dictionary::Searcher< Const >

Generic const/non-const dictionary entry searcher.

A searcher provides a uniform means of finding and returning an entry pointer as well as the dictionary context in which the entry was located.

Note that the constructors and set methods are protected such that only friends of the class can set things. This safeguards against inconsistencies in context/entry.

Definition at line 149 of file dictionary.H.

Member Typedef Documentation

◆ dict_type

typedef std::conditional<Const, const dictionary, dictionary>::type dict_type

The const/non-const type for the context and sub-dictionaries.

Definition at line 158 of file dictionary.H.

◆ value_type

typedef std::conditional<Const, const entry, entry>::type value_type

The const/non-const type for entries.

Definition at line 164 of file dictionary.H.

◆ dict_pointer

typedef dict_type* dict_pointer

A pointer to a const/non-const dictionary.

Definition at line 169 of file dictionary.H.

◆ dict_reference

typedef dict_type& dict_reference

A reference to a const/non-const dictionary.

Definition at line 174 of file dictionary.H.

◆ pointer

typedef value_type* pointer

A pointer to a const/non-const entry.

Definition at line 179 of file dictionary.H.

◆ reference

typedef value_type& reference

A reference to a const/non-const entry.

Definition at line 184 of file dictionary.H.

Constructor & Destructor Documentation

◆ Searcher() [1/2]

Searcher ( dict_pointer  dict)
inlineprotectednoexcept

Construct for the given dictionary context.

Allow implicit conversion

Definition at line 205 of file dictionary.H.

◆ Searcher() [2/2]

constexpr Searcher ( )
inlinenoexcept

Default construct.

Definition at line 225 of file dictionary.H.

Member Function Documentation

◆ set()

void set ( pointer  eptr)
inlineprotectednoexcept

Assign the entry.

Definition at line 214 of file dictionary.H.

References dictionary::Searcher< Const >::eptr_.

Referenced by dictionary::csearch().

Here is the caller graph for this function:

◆ good()

bool good ( ) const
inlinenoexcept

True if entry was found.

Definition at line 235 of file dictionary.H.

References dictionary::Searcher< Const >::eptr_.

Referenced by dictionary::csearchCompat(), dictionary::optionalSubDict(), dictionary::subDict(), dictionary::subDictOrAdd(), and dictionary::subOrEmptyDict().

Here is the caller graph for this function:

◆ found()

bool found ( ) const
inlinenoexcept

True if entry was found.

Definition at line 240 of file dictionary.H.

References dictionary::Searcher< Const >::eptr_.

◆ context()

dict_reference context ( ) const
inline

The containing dictionary context.

Definition at line 245 of file dictionary.H.

References dictionary::Searcher< Const >::dict_.

◆ ptr()

pointer ptr ( ) const
inlinenoexcept

A pointer to the entry (nullptr if not found)

Definition at line 250 of file dictionary.H.

References dictionary::Searcher< Const >::eptr_.

◆ ref()

reference ref ( ) const
inline

A reference to the entry (Error if not found)

Definition at line 255 of file dictionary.H.

References dictionary::Searcher< Const >::eptr_.

◆ isDict()

bool isDict ( ) const
inlinenoexcept

True if found entry is a dictionary.

Definition at line 260 of file dictionary.H.

References dictionary::Searcher< Const >::eptr_.

◆ dictPtr()

dict_pointer dictPtr ( ) const
inlinenoexcept

Pointer to the found entry as a dictionary, nullptr otherwise.

Definition at line 268 of file dictionary.H.

References dictionary::Searcher< Const >::eptr_.

Referenced by dictionary::optionalSubDict(), dictionary::set(), dictionary::subDictOrAdd(), and dictionary::subOrEmptyDict().

Here is the caller graph for this function:

◆ dict()

dict_reference dict ( ) const
inline

Reference the found entry as a dictionary.

(Error if not found, or not a dictionary).

Definition at line 278 of file dictionary.H.

References dictionary::Searcher< Const >::eptr_.

Referenced by dictionary::subDict().

Here is the caller graph for this function:

◆ operator const Searcher<!Const > &()

operator const Searcher<!Const > & ( ) const
inlineexplicit

Permit an explicit cast to the other (const/non-const) searcher.

Definition at line 286 of file dictionary.H.

◆ operator->()

pointer operator-> ( ) const
inlinenoexcept

A pointer to the entry (nullptr if not found)

Definition at line 294 of file dictionary.H.

References dictionary::Searcher< Const >::eptr_.

◆ operator*()

reference operator* ( ) const
inline

A reference to the entry (Error if not found)

Definition at line 302 of file dictionary.H.

References dictionary::Searcher< Const >::eptr_.

Member Data Documentation

◆ dictionary

friend dictionary

Definition at line 152 of file dictionary.H.

◆ dict_

dict_pointer dict_
protected

The dictionary context for the entry.

Definition at line 192 of file dictionary.H.

Referenced by dictionary::Searcher< Const >::context().

◆ eptr_

pointer eptr_
protected

The entry or nullptr.

Definition at line 197 of file dictionary.H.

Referenced by dictionary::Searcher< Const >::dict(), dictionary::Searcher< Const >::dictPtr(), dictionary::Searcher< Const >::found(), dictionary::Searcher< Const >::good(), dictionary::Searcher< Const >::isDict(), dictionary::Searcher< Const >::operator*(), dictionary::Searcher< Const >::operator->(), dictionary::Searcher< Const >::ptr(), dictionary::Searcher< Const >::ref(), and dictionary::Searcher< Const >::set().

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