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... | |
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 140 of file dictionary.H.
typedef std::conditional<Const, const dictionary, dictionary>::type dict_type |
The const/non-const type for the context and sub-dictionaries.
Definition at line 149 of file dictionary.H.
typedef std::conditional<Const, const entry, entry>::type value_type |
The const/non-const type for entries.
Definition at line 155 of file dictionary.H.
typedef dict_type* dict_pointer |
A pointer to a const/non-const dictionary.
Definition at line 160 of file dictionary.H.
typedef dict_type& dict_reference |
A reference to a const/non-const dictionary.
Definition at line 165 of file dictionary.H.
typedef value_type* pointer |
A pointer to a const/non-const entry.
Definition at line 170 of file dictionary.H.
typedef value_type& reference |
A reference to a const/non-const entry.
Definition at line 175 of file dictionary.H.
|
inlineprotectednoexcept |
Construct for the given dictionary context.
Allow implicit conversion
Definition at line 196 of file dictionary.H.
|
inlinenoexcept |
Default construct.
Definition at line 216 of file dictionary.H.
|
inlineprotectednoexcept |
Assign the entry.
Definition at line 205 of file dictionary.H.
References dictionary::Searcher< Const >::eptr_.
Referenced by dictionary::csearch().
|
inlinenoexcept |
True if entry was found.
Definition at line 226 of file dictionary.H.
References dictionary::Searcher< Const >::eptr_.
Referenced by dictionary::csearchCompat(), dictionary::optionalSubDict(), dictionary::subDict(), dictionary::subDictOrAdd(), and dictionary::subOrEmptyDict().
|
inlinenoexcept |
True if entry was found.
Definition at line 231 of file dictionary.H.
References dictionary::Searcher< Const >::eptr_.
|
inline |
The containing dictionary context.
Definition at line 236 of file dictionary.H.
References dictionary::Searcher< Const >::dict_.
|
inlinenoexcept |
A pointer to the entry (nullptr if not found)
Definition at line 241 of file dictionary.H.
References dictionary::Searcher< Const >::eptr_.
|
inline |
A reference to the entry (Error if not found)
Definition at line 246 of file dictionary.H.
References dictionary::Searcher< Const >::eptr_.
|
inlinenoexcept |
True if found entry is a dictionary.
Definition at line 251 of file dictionary.H.
References dictionary::Searcher< Const >::eptr_.
|
inlinenoexcept |
Pointer to the found entry as a dictionary, nullptr otherwise.
Definition at line 259 of file dictionary.H.
References dictionary::Searcher< Const >::eptr_.
Referenced by dictionary::optionalSubDict(), dictionary::set(), dictionary::subDictOrAdd(), and dictionary::subOrEmptyDict().
|
inline |
Reference the found entry as a dictionary.
(Error if not found, or not a dictionary).
Definition at line 269 of file dictionary.H.
References dictionary::Searcher< Const >::eptr_.
Referenced by dictionary::subDict().
Permit an explicit cast to the other (const/non-const) searcher.
Definition at line 277 of file dictionary.H.
A pointer to the entry (nullptr if not found)
Definition at line 285 of file dictionary.H.
References dictionary::Searcher< Const >::eptr_.
A reference to the entry (Error if not found)
Definition at line 293 of file dictionary.H.
References dictionary::Searcher< Const >::eptr_.
friend dictionary |
Definition at line 143 of file dictionary.H.
|
protected |
The dictionary context for the entry.
Definition at line 183 of file dictionary.H.
Referenced by dictionary::Searcher< Const >::context().
|
protected |
The entry or nullptr.
Definition at line 188 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().
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.