simpleObjectRegistry Class Reference

Object registry for simpleRegIOobject. Maintains ordering. More...

Inheritance diagram for simpleObjectRegistry:
Collaboration diagram for simpleObjectRegistry:

Public Member Functions

 simpleObjectRegistry ()=default
 Default construct: empty without allocation (capacity=0). More...
 
 simpleObjectRegistry (const label initialCapacity)
 Construct empty with initial table capacity. More...
 
void setValues (const dictionary &dict, bool report=false)
 Set values (invoke callbacks) from dictionary entries. More...
 
void setNamedValue (std::string name, int val, bool report=false)
 Set named value, but also handle embedded 'name=value' syntax. More...
 
void setNamedInt (std::string name, int val, bool report=false)
 Deprecated(2021-09) renamed to setNamedValue. More...
 
- Public Member Functions inherited from Dictionary< simpleObjectRegistryEntry >
 Dictionary (const label initialCapacity=128)
 Default construct, or with initial table capacity. More...
 
 Dictionary (const Dictionary &dict)
 Copy construct. More...
 
bool erase (const word &keyword)
 Remove an entry specified by keyword and delete the pointer. More...
 
- Public Member Functions inherited from DictionaryBase< IDLList< simpleObjectRegistryEntry >, simpleObjectRegistryEntry >
 DictionaryBase ()=default
 Default construct: empty without allocation (capacity=0). More...
 
 DictionaryBase (const label initialCapacity)
 Construct empty with initial table capacity. More...
 
 DictionaryBase (const DictionaryBase &dict)
 Copy construct. More...
 
 DictionaryBase (Istream &is, const INew &inew)
 Construct from Istream using given Istream constructor class. More...
 
 DictionaryBase (Istream &is)
 Construct from Istream using default Istream constructor class. More...
 
bool contains (const word &keyword) const
 Search for given keyword. More...
 
const simpleObjectRegistryEntrycfind (const word &keyword) const
 Find and return an entry, nullptr on failure. More...
 
simpleObjectRegistryEntryfind (const word &keyword)
 Find and return an entry, nullptr on failure. More...
 
const simpleObjectRegistryEntrylookup (const word &keyword) const
 Find and return entry, FatalError on failure. More...
 
simpleObjectRegistryEntrylookup (const word &keyword)
 Find and return entry, FatalError on failure. More...
 
wordList toc () const
 The table of contents (as a sorted list) More...
 
wordList sortedToc () const
 The table of contents as a sorted list. More...
 
wordList sortedToc (const Compare &comp) const
 The table of contents sorted using the specified comparator. More...
 
void push_front (const word &keyword, simpleObjectRegistryEntry *ptr)
 Add to front of dictionary. More...
 
void push_back (const word &keyword, simpleObjectRegistryEntry *ptr)
 Add to back of dictionary. More...
 
simpleObjectRegistryEntryremove (const word &keyword)
 Remove and return entry specified by keyword. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (DictionaryBase< IDLList< simpleObjectRegistryEntry >, simpleObjectRegistryEntry > &dict)
 Transfer the contents of the argument into this DictionaryBase. More...
 
void operator= (const DictionaryBase &)
 Copy assignment. More...
 
const simpleObjectRegistryEntryoperator[] (const word &key) const
 Find and return entry. More...
 
simpleObjectRegistryEntryoperator[] (const word &key)
 Find and return entry. More...
 
bool found (const word &key) const
 Same as contains() More...
 
const simpleObjectRegistryEntrylookupPtr (const word &k) const
 Deprecated(2020-03) use cfind() More...
 
simpleObjectRegistryEntrylookupPtr (const word &k)
 Deprecated(2020-03) use find() More...
 
void insert (const word &k, simpleObjectRegistryEntry *ptr)
 Add to front of dictionary. More...
 
void prepend (const word &k, simpleObjectRegistryEntry *ptr)
 Add to front of dictionary. More...
 
void append (const word &k, simpleObjectRegistryEntry *ptr)
 Add to back of dictionary. More...
 
- Public Member Functions inherited from ILList< LListBase, T >
 ILList ()=default
 Default construct. More...
 
 ILList (T *item)
 Construct and add initial item pointer. More...
 
 ILList (Istream &is)
 Construct from Istream. More...
 
 ILList (const ILList< LListBase, T > &lst)
 Copy construct using the 'clone()' method for each element. More...
 
 ILList (ILList< LListBase, T > &&lst)
 Move construct. More...
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone 'clone()'. More...
 
template<class INew >
 ILList (Istream &is, const INew &inew)
 Construct from Istream using given Istream constructor class. More...
 
 ~ILList ()
 Destructor. Calls clear() More...
 
void clear ()
 Clear the contents of the list. More...
 
void pop_front (label n=1)
 Remove first element(s) from the list (deletes pointers) More...
 
bool erase (T *item)
 Remove the specified element from the list and delete it. More...
 
void transfer (ILList< LListBase, T > &lst)
 Transfer the contents of the argument into this List and annul the argument list. More...
 
void operator= (const ILList< LListBase, T > &lst)
 Copy assignment using the 'clone()' method for each element. More...
 
void operator= (ILList< LListBase, T > &&lst)
 Move assignment. More...
 
- Public Member Functions inherited from UILList< LListBase, T >
 UILList ()=default
 Default construct. More...
 
 UILList (T *item)
 Construct and add initial item pointer. More...
 
 UILList (const UILList< LListBase, T > &list)
 Construct as copy. More...
 
Tfront ()
 The first entry in the list. More...
 
const Tfront () const
 The first entry in the list (const access) More...
 
Tback ()
 The last entry in the list. More...
 
const Tback () const
 The last entry in the list (const access) More...
 
TremoveHead ()
 Remove and return head. More...
 
Tremove (T *item)
 Remove and return element. More...
 
Tremove (iterator &iter)
 Remove and return item specified by iterator. More...
 
void operator= (const UILList< LListBase, T > &lst)
 Copy assignment. More...
 
bool operator== (const UILList< LListBase, T > &lst) const
 Equality. True both lists are element-wise equal. More...
 
bool operator!= (const UILList< LListBase, T > &lst) const
 The opposite of the equality operation. Takes linear time. More...
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write UILList with line-breaks when length exceeds shortLen. More...
 
iterator begin ()
 Iterator to first item in list with non-const access. More...
 
const_iterator cbegin () const
 Iterator to first item in list with const access. More...
 
reverse_iterator rbegin ()
 Iterator to last item in list with non-const access. More...
 
const_reverse_iterator crbegin () const
 Iterator to last item in list with const access. More...
 
const_iterator begin () const
 Iterator to first item in list with const access. More...
 
const_reverse_iterator rbegin () const
 Iterator to last item in list with const access. More...
 
const iteratorend ()
 End of list for forward iterators. More...
 
const const_iteratorcend () const
 End of list for forward iterators. More...
 
const reverse_iteratorrend ()
 End of list for reverse iterators. More...
 
const const_reverse_iteratorcrend () const
 End of list for reverse iterators. More...
 
const const_iteratorend () const
 End of list for forward iterators. More...
 
const const_reverse_iteratorrend () const
 End of list for reverse iterators. More...
 
Tfirst ()
 The first entry in the list. More...
 
const Tfirst () const
 The first entry in the list (const access) More...
 
Tlast ()
 The last entry in the list. More...
 
const Tlast () const
 The last entry in the list (const access) More...
 

Additional Inherited Members

- Public Types inherited from Dictionary< simpleObjectRegistryEntry >
typedef DictionaryBase< IDLList< simpleObjectRegistryEntry >, simpleObjectRegistryEntrydict_type
 The template instance used for the dictionary content. More...
 
- Public Types inherited from UILList< LListBase, T >
typedef T value_type
 Type of values stored. More...
 
typedef Tpointer
 Pointer for value_type. More...
 
typedef const Tconst_pointer
 Const pointer for value_type. More...
 
typedef Treference
 Reference for value_type. More...
 
typedef const Tconst_reference
 Const reference for value_type. More...
 
typedef label size_type
 The type that can represent the container size. More...
 
typedef label difference_type
 The difference between iterator objects. More...
 
using base_iterator = typename LListBase::iterator
 
using const_base_iterator = typename LListBase::const_iterator
 
- Protected Member Functions inherited from DictionaryBase< IDLList< simpleObjectRegistryEntry >, simpleObjectRegistryEntry >
bool addHashEntry (const word &key, simpleObjectRegistryEntry *ptr)
 Add an entry to the HashTable. More...
 
void addEntries ()
 Add the IDLListType entries into the HashTable. More...
 
- Protected Attributes inherited from DictionaryBase< IDLList< simpleObjectRegistryEntry >, simpleObjectRegistryEntry >
HashTable< simpleObjectRegistryEntry *> hashedTs_
 HashTable of the entries held on the IDLListType for quick lookup. More...
 

Detailed Description

Object registry for simpleRegIOobject. Maintains ordering.

Source files

Definition at line 81 of file simpleObjectRegistry.H.

Constructor & Destructor Documentation

◆ simpleObjectRegistry() [1/2]

simpleObjectRegistry ( )
default

Default construct: empty without allocation (capacity=0).

◆ simpleObjectRegistry() [2/2]

simpleObjectRegistry ( const label  initialCapacity)
inlineexplicit

Construct empty with initial table capacity.

Definition at line 97 of file simpleObjectRegistry.H.

Member Function Documentation

◆ setValues()

void setValues ( const dictionary dict,
bool  report = false 
)

Set values (invoke callbacks) from dictionary entries.

Reporting honours the infoDetailLevel

Definition at line 31 of file simpleObjectRegistry.C.

References dict, Foam::ListOps::find(), Foam::infoDetailLevel, Log, Foam::log(), Foam::name(), Foam::nl, os(), and ISstream::rewind().

Referenced by Time::readDict().

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

◆ setNamedValue()

void setNamedValue ( std::string  name,
int  val,
bool  report = false 
)

Set named value, but also handle embedded 'name=value' syntax.

Treats 'name=' and 'name' identically.

Will also accept a floating point value, but the called objects need to handle that. Reporting honours the infoDetailLevel

Definition at line 85 of file simpleObjectRegistry.C.

References Foam::ListOps::find(), Foam::infoDetailLevel, Log, Foam::log(), Foam::name(), Foam::nl, Foam::readInt(), and ITstream::rewind().

Referenced by argList::argList(), and simpleObjectRegistry::setNamedInt().

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

◆ setNamedInt()

void setNamedInt ( std::string  name,
int  val,
bool  report = false 
)
inline

Deprecated(2021-09) renamed to setNamedValue.

Deprecated:
(2021-09) renamed to setNamedValue

Definition at line 128 of file simpleObjectRegistry.H.

References simpleObjectRegistry::setNamedValue().

Here is the call graph for this function:

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