simpleObjectRegistry Class Reference

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

Inheritance diagram for simpleObjectRegistry:
[legend]
Collaboration diagram for simpleObjectRegistry:
[legend]

Public Member Functions

 simpleObjectRegistry (const label size=128)
 Construct with given or default (128) 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 size=128)
 Construct with given or default (128) 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 (const label size=128)
 Construct with given or default (128) 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 found (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
 Return the table of contents (as a sorted list) More...
 
wordList sortedToc () const
 Return the table of contents as a sorted list. More...
 
wordList sortedToc (const Compare &comp) const
 Return table of contents sorted using the specified comparator. More...
 
Foam::wordList sortedToc (const Compare &comp) const
 
void insert (const word &keyword, simpleObjectRegistryEntry *)
 Add at head of dictionary. More...
 
void append (const word &keyword, simpleObjectRegistryEntry *)
 Add at tail 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...
 
const simpleObjectRegistryEntrylookupPtr (const word &keyword) const
 Deprecated(2020-03) use cfind() More...
 
simpleObjectRegistryEntrylookupPtr (const word &keyword)
 Deprecated(2020-03) use find() More...
 

Additional Inherited Members

- Protected Member Functions inherited from DictionaryBase< IDLList< simpleObjectRegistryEntry >, simpleObjectRegistryEntry >
void addEntries ()
 
- 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()

simpleObjectRegistry ( const label  size = 128)
inlineexplicit

Construct with given or default (128) table capacity.

Definition at line 90 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 38 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 92 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().

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 112 of file simpleObjectRegistry.H.


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