objectRegistry Class Reference

Registry of regIOobjects. More...

Inheritance diagram for objectRegistry:
Collaboration diagram for objectRegistry:

Public Member Functions

 TypeName ("objectRegistry")
 Declare type name for this IOobject. More...
 
 objectRegistry (const Time &db, const label initialCapacity=128)
 Construct the time objectRegistry, with estimated table capacity (default: 128) More...
 
 objectRegistry (const IOobject &io, const label initialCapacity=128)
 Construct sub-registry given an IObject to describe the registry, with estimated table capacity (default: 128) More...
 
virtual ~objectRegistry ()
 Destructor, with checkOut() for all objects that are ownedByRegistry. More...
 
const objectRegistrythisDb () const noexcept
 Return the object registry. More...
 
const objectRegistryparent () const noexcept
 Return the parent objectRegistry. More...
 
const Timetime () const noexcept
 Return time registry. More...
 
bool isTimeDb () const noexcept
 True if the registry is Time. More...
 
virtual const fileNamedbDir () const
 Local directory path of this objectRegistry relative to the time. More...
 
HashTable< wordHashSetclasses () const
 A summary hash of classes used and their associated object names. More...
 
template<class MatchPredicate >
HashTable< wordHashSetclasses (const MatchPredicate &matchName) const
 A summary hash of classes used and their associated object names, restricted to objects that have a matching object name. More...
 
template<class Type , bool Strict = false>
UPtrList< const Type > cobjects () const
 Return unsorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict) More...
 
template<class Type , bool Strict = false>
UPtrList< Type > objects ()
 Return unsorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict) More...
 
template<class Type , class MatchPredicate >
UPtrList< const Type > cobjects (const MatchPredicate &matchName) const
 Return unsorted list of objects with a class satisfying isA<Type> that also have a matching object name. More...
 
template<class Type , class MatchPredicate >
UPtrList< Type > objects (const MatchPredicate &matchName)
 Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name. More...
 
template<class Type , bool Strict = false>
UPtrList< const Type > csorted () const
 Return sorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict) More...
 
template<class Type , bool Strict = false>
UPtrList< Type > sorted ()
 Return sorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict) More...
 
UPtrList< const regIOobjectcsorted () const
 Return sorted list of objects. More...
 
UPtrList< regIOobjectsorted ()
 Return sorted list of objects. More...
 
template<class Type , class MatchPredicate >
UPtrList< const Type > csorted (const MatchPredicate &matchName) const
 Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name. More...
 
template<class Type , class MatchPredicate >
UPtrList< Type > sorted (const MatchPredicate &matchName)
 Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name. More...
 
label count (const char *clsName) const
 The number of objects of the given class name. More...
 
template<class MatchPredicate >
label count (const MatchPredicate &matchClass) const
 The number of objects of the given class name. More...
 
template<class MatchPredicate1 , class MatchPredicate2 >
label count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
 The number of objects of the given class name. More...
 
template<class Type >
label count (const bool strict=false) const
 The names of objects with a class satisfying isA<Type> More...
 
template<class Type , class MatchPredicate >
label count (const MatchPredicate &matchName) const
 The names of objects with a class satisfying isA<Type> that also have a matching object name. More...
 
wordList names () const
 The unsorted names of all objects. More...
 
wordList names (const char *clsName) const
 The unsorted names of objects with the given class name. More...
 
template<class MatchPredicate >
wordList names (const MatchPredicate &matchClass) const
 The unsorted names of objects with a matching class name. More...
 
template<class MatchPredicate1 , class MatchPredicate2 >
wordList names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
 The unsorted names of objects with a matching class name that also have a matching object name. More...
 
template<class Type >
wordList names () const
 The unsorted names of objects with a class satisfying isA<Type> More...
 
template<class Type , class MatchPredicate >
wordList names (const MatchPredicate &matchName) const
 The unsorted names of objects with a class satisfying isA<Type> that also have a matching object name. More...
 
wordList sortedNames () const
 The sorted names of all objects. More...
 
wordList sortedNames (const char *clsName) const
 The sorted names of objects with the given class name. More...
 
template<class MatchPredicate >
wordList sortedNames (const MatchPredicate &matchClass) const
 The sorted names objects with a matching class name. More...
 
template<class MatchPredicate1 , class MatchPredicate2 >
wordList sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
 The sorted names of objects with a matching class name that also have a matching object name. More...
 
template<class Type >
wordList sortedNames () const
 The sorted names of objects with a class satisfying isA<Type> More...
 
template<class Type , class MatchPredicate >
wordList sortedNames (const MatchPredicate &matchName) const
 The sorted names of objects with a class satisfying isA<Type> that also have a matching object name. More...
 
const objectRegistrysubRegistry (const word &name, const bool forceCreate=false, const bool recursive=false) const
 Lookup and return a const sub-objectRegistry. More...
 
template<class Type , bool Strict = false>
HashTable< const Type * > lookupClass () const
 Return all objects with a class satisfying isA<Type> or isType<Type> (with Strict) More...
 
template<class Type , bool Strict = false>
HashTable< Type * > lookupClass ()
 Return all objects with a class satisfying isA<Type> or isType<Type> (with Strict) More...
 
template<class Type >
HashTable< const Type * > lookupClass (const bool strict) const
 Return all objects with a class satisfying isA<Type> More...
 
template<class Type >
HashTable< Type * > lookupClass (const bool strict)
 Return all objects with a class satisfying isA<Type> More...
 
const regIOobjectcfindIOobject (const word &name, const bool recursive=false) const
 Return const pointer to the regIOobject. More...
 
bool contains (const word &name, const bool recursive=false) const
 Does the registry contain the regIOobject object (by name). More...
 
template<class Type >
bool foundObject (const word &name, const bool recursive=false) const
 Is the named Type found? More...
 
template<class Type >
const Type * cfindObject (const word &name, const bool recursive=false) const
 Return const pointer to the object of the given Type. More...
 
template<class Type >
const Type * findObject (const word &name, const bool recursive=false) const
 Return const pointer to the object of the given Type. More...
 
template<class Type >
Type * findObject (const word &name, const bool recursive=false)
 Return non-const pointer to the object of the given Type. More...
 
template<class Type >
Type * getObjectPtr (const word &name, const bool recursive=false) const
 Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable. More...
 
template<class Type >
const Type & lookupObject (const word &name, const bool recursive=false) const
 Lookup and return const reference to the object of the given Type. Fatal if not found or the wrong type. More...
 
template<class Type >
Type & lookupObjectRef (const word &name, const bool recursive=false) const
 Lookup and return non-const reference to the object of the given Type. Fatal if not found or the wrong type. More...
 
label getEvent () const
 Return new event number. More...
 
bool checkIn (regIOobject *io) const
 Add a regIOobject to registry. A nullptr is ignored. More...
 
bool checkIn (regIOobject &io) const
 Add a regIOobject to registry. More...
 
bool checkOut (regIOobject *io) const
 Remove a regIOobject from registry and free memory if the object is ownedByRegistry. A nullptr is ignored. More...
 
bool checkOut (regIOobject &io) const
 Remove a regIOobject from registry and free memory if the object is ownedByRegistry. More...
 
bool checkOut (const word &key) const
 Remove a regIOobject by name from registry and free memory if the object is ownedByRegistry. More...
 
void clear ()
 Clear all entries from the registry. More...
 
void clearStorage ()
 Clear all entries from the registry and the table itself. More...
 
bool erase (const iterator &iter)
 Erase an entry specified by the given iterator. More...
 
bool erase (const word &key)
 Erase an entry specified by the given key. More...
 
label erase (std::initializer_list< word > keys)
 Remove entries given by the listed keys. More...
 
label erase (const UList< word > &keys)
 Remove entries given by the listed keys. More...
 
virtual void rename (const word &newName)
 Rename. More...
 
bool is_cacheTemporaryObject (const word &name) const
 True if given name is in the cacheTemporaryObjects set. More...
 
bool is_cacheTemporaryObject (const regIOobject *io) const
 True if name of object is in the cacheTemporaryObjects set. More...
 
bool is_cacheTemporaryObject (const regIOobject &io) const
 True if name of object is in the cacheTemporaryObjects set. More...
 
template<class Type >
bool cacheTemporaryObject (Type &obj) const
 Cache the given object. Moves content and stores. More...
 
void resetCacheTemporaryObject (const regIOobject *io) const
 Reset the cache state of the given object (nullptr is ignored) More...
 
void resetCacheTemporaryObject (const regIOobject &io) const
 Reset the cache state of the given object in the cacheTemporaryObjects set. More...
 
bool checkCacheTemporaryObjects () const
 Check that all objects specified in the cacheTemporaryObjects were also cached. More...
 
virtual bool modified () const
 Return true if any of the object's files have been modified. More...
 
void readModifiedObjects ()
 Read the objects that have been modified. More...
 
virtual bool readIfModified ()
 Read object if modified. More...
 
virtual bool writeData (Ostream &) const
 The writeData function is required by regIOobject but not used. More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool writeOnProc) const
 Write the objects using stream options. More...
 
bool found (const word &name, bool recursive=false) const
 Same as contains() More...
 
template<class Type >
const Type * lookupObjectPtr (const word &name, bool recursive=false) const
 Deprecated(2018-10) find object. More...
 
template<class Type >
Type * lookupObjectRefPtr (const word &name, bool recursive=false) const
 Deprecated(2018-10) get object pointer, ignoring constness. More...
 
template<class Type >
UPtrList< const Type > sorted () const
 Deprecated(2023-07) use csorted() method. More...
 
UPtrList< const regIOobjectsorted () const
 Deprecated(2023-07) use csorted() method. More...
 
template<class Type , class MatchPredicate >
UPtrList< const Type > sorted (const MatchPredicate &matchName) const
 Deprecated(2023-07) use csorted() method. More...
 
template<class MatchPredicate >
Foam::HashTable< Foam::wordHashSetclassesImpl (const objectRegistry &list, const MatchPredicate &matchName)
 
template<class MatchPredicate1 , class MatchPredicate2 >
Foam::label countImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName)
 
template<class Type , class MatchPredicate >
Foam::label countTypeImpl (const objectRegistry &list, const MatchPredicate &matchName)
 
template<class MatchPredicate1 , class MatchPredicate2 >
Foam::wordList namesImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName, const bool doSort)
 
template<class Type , class MatchPredicate >
Foam::wordList namesTypeImpl (const objectRegistry &list, const MatchPredicate &matchName, const bool doSort)
 
template<class Type , class MatchPredicate >
Foam::UPtrList< Type > objectsTypeImpl (const bool strict, const objectRegistry &list, const MatchPredicate &matchName, const bool doSort)
 
template<class Type >
Foam::HashTable< Type * > lookupClassTypeImpl (const bool strict, const objectRegistry &list)
 
template<class MatchPredicate >
Foam::HashTable< Foam::wordHashSetclasses (const MatchPredicate &matchName) const
 
template<class MatchPredicate >
Foam::label count (const MatchPredicate &matchClass) const
 
template<class MatchPredicate1 , class MatchPredicate2 >
Foam::label count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
 
template<class Type , class MatchPredicate >
Foam::label count (const MatchPredicate &matchName) const
 
template<class Type >
Foam::label count (const bool strict) const
 
template<class Type , bool Strict>
Foam::UPtrList< const Type > cobjects () const
 
template<class Type , bool Strict>
Foam::UPtrList< Type > objects ()
 
template<class Type , bool Strict>
Foam::UPtrList< const Type > csorted () const
 
template<class Type , bool Strict>
Foam::UPtrList< Type > sorted ()
 
template<class Type , class MatchPredicate >
Foam::UPtrList< const Type > cobjects (const MatchPredicate &matchName) const
 
template<class Type , class MatchPredicate >
Foam::UPtrList< Type > objects (const MatchPredicate &matchName)
 
template<class Type , class MatchPredicate >
Foam::UPtrList< const Type > csorted (const MatchPredicate &matchName) const
 
template<class Type , class MatchPredicate >
Foam::UPtrList< Type > sorted (const MatchPredicate &matchName)
 
template<class MatchPredicate >
Foam::wordList names (const MatchPredicate &matchClass) const
 
template<class MatchPredicate1 , class MatchPredicate2 >
Foam::wordList names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
 
template<class Type >
Foam::wordList names () const
 
template<class Type , class MatchPredicate >
Foam::wordList names (const MatchPredicate &matchName) const
 
template<class MatchPredicate >
Foam::wordList sortedNames (const MatchPredicate &matchClass) const
 
template<class MatchPredicate1 , class MatchPredicate2 >
Foam::wordList sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
 
template<class Type >
Foam::wordList sortedNames () const
 
template<class Type , class MatchPredicate >
Foam::wordList sortedNames (const MatchPredicate &matchName) const
 
template<class Type , bool Strict>
Foam::HashTable< const Type * > lookupClass () const
 
template<class Type , bool Strict>
Foam::HashTable< Type * > lookupClass ()
 
template<class Type >
Foam::HashTable< const Type * > lookupClass (const bool strict) const
 
template<class Type >
Foam::HashTable< Type * > lookupClass (const bool strict)
 
- Public Member Functions inherited from regIOobject
void operator= (const regIOobject &)=delete
 No copy assignment. More...
 
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &io, const bool isTimeObject=false)
 Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). More...
 
 regIOobject (const regIOobject &rio)
 Copy construct. More...
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 Copy construct, transferring registry registration to the copy if registerCopy is true. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy construct with new name, transferring registry registration to the copy if registerCopy is true. More...
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 Copy construct with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry, if not already registered. More...
 
bool checkOut ()
 Remove all file watches and remove object from registry. More...
 
virtual void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool registered () const noexcept
 Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. More...
 
bool ownedByRegistry () const noexcept
 Is this object owned by the registry? More...
 
bool store ()
 Register object with its registry and transfer ownership to the registry. More...
 
void release (const bool unregister=false) noexcept
 Set object as not ownedByRegistry. More...
 
label eventNo () const noexcept
 Event number at last update. More...
 
label & eventNo () noexcept
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set as up-to-date. More...
 
const dictionaryfindMetaData () const noexcept
 Return pointer to meta-data or nullptr. More...
 
dictionarygetMetaData () noexcept
 Get or create meta-data. More...
 
void removeMetaData ()
 Remove meta-data. More...
 
virtual void updateMetaData ()
 Update internal meta-data (eg, prior to writing) More...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool headerOk ()
 Read and check header info. Does not check the headerClassName. More...
 
IstreamreadStream (const word &, const bool readOnProc=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
virtual bool read ()
 Read object. More...
 
virtual label addWatch (const fileName &)
 Add file watch for fileName on object if not yet watched. More...
 
const labelListwatchIndices () const noexcept
 Read access to file-monitoring handles. More...
 
labelListwatchIndices () noexcept
 Write access to file-monitoring handles. More...
 
virtual bool write (const bool writeOnProc=true) const
 Write using setting from DB. More...
 
virtual bool global () const
 Is object global. More...
 
void operator= (const IOobject &io)
 Copy assignment. More...
 
virtual bool writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const
 Write using given format, version and compression. More...
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Declare type-name, virtual type (with debug switch) More...
 
 IOobject (const IOobject &)=default
 Copy construct. More...
 
virtual ~IOobject ()=default
 Destructor. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
 Construct from path, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Copy construct, resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Copy construct, resetting name. More...
 
 IOobject (const IOobject &io, const word &name, const fileName &local)
 Copy construct, resetting name and local component. More...
 
 IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt)
 Copy construct, resetting read/write options. More...
 
 IOobject (const IOobject &io, IOobjectOption::registerOption regOpt)
 Copy construct, resetting register option. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
const objectRegistrydb () const noexcept
 Return the local objectRegistry. More...
 
const Timetime () const noexcept
 Return Time associated with the objectRegistry. More...
 
const wordname () const noexcept
 Return the object name. More...
 
const wordheaderClassName () const noexcept
 Return name of the class name read from header. More...
 
wordheaderClassName () noexcept
 Return non-constant access to the class name read from header. More...
 
const stringnote () const noexcept
 Return the optional note. More...
 
stringnote () noexcept
 Modifiable access to the optional note. More...
 
unsigned labelByteSize () const noexcept
 The sizeof (label) in bytes, possibly read from the header. More...
 
unsigned scalarByteSize () const noexcept
 The sizeof (scalar) in bytes, possibly read from the header. More...
 
void resetHeader (const word &newName=word::null)
 Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. More...
 
bool hasHeaderClass () const noexcept
 True if headerClassName() is non-empty (after reading) More...
 
template<class Type >
bool isHeaderClass () const
 Check if headerClassName() equals Type::typeName. More...
 
template<class Type >
bool isHeaderClassName () const
 Same as isHeaderClass() More...
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const noexcept
 Return the Time::rootPath() More...
 
const fileNamecaseName () const noexcept
 Return the Time::caseName() More...
 
const fileNameglobalCaseName () const noexcept
 Return the Time::globalCaseName() More...
 
const fileNameinstance () const noexcept
 Read access to instance path component. More...
 
fileNameinstance () noexcept
 Write access to instance path component. More...
 
const fileNamelocal () const noexcept
 Read access to local path component. More...
 
fileName path () const
 The complete path for the object (with instance, local,...). More...
 
fileName globalPath () const
 The complete global path for the object (with instance, local,...) More...
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 The complete path with alternative instance and local. More...
 
fileName globalPath (const word &instance, const fileName &local=fileName::null) const
 The complete global path with alternative instance and local. More...
 
fileName objectPath () const
 The complete path + object name. More...
 
fileName globalObjectPath () const
 The complete global path + object name. More...
 
fileName objectRelPath () const
 The object path relative to the root. More...
 
fileName localFilePath (const word &typeName, const bool search=true) const
 Redirect to fileHandler filePath, searching locally. More...
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 Redirect to fileHandler filePath, searching up if in parallel. More...
 
IOstreamOption parseHeader (const dictionary &headerDict)
 Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More...
 
bool readHeader (Istream &is)
 Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More...
 
bool readHeader (dictionary &headerDict, Istream &is)
 Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 Read header (respects is_globalIOobject trait) and check its info. More...
 
template<class Type >
fileName typeFilePath (const bool search=true) const
 Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &os) const
 Write header with current type() More...
 
bool writeHeader (Ostream &os, const word &objectType) const
 Write header with override of type. More...
 
void writeHeader (dictionary &dict, IOstreamOption streamOpt) const
 Write header into a dictionary with current type() and given output format. More...
 
void writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
 Write header into a dictionary with override of type and given output format. More...
 
bool good () const noexcept
 Did last readHeader() succeed? More...
 
bool bad () const noexcept
 Did last readHeader() fail? More...
 
InfoProxy< IOobjectinfo () const noexcept
 Return info proxy, for printing information to a stream. More...
 
void operator= (const IOobject &io)
 Copy assignment, copies all values (except the registry) More...
 
template<>
bool isHeaderClass () const
 Specialization for void always returns true (no headerClassName check). More...
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 
template<class Type >
Foam::fileName typeFilePath (const bool search) const
 
- Public Member Functions inherited from IOobjectOption
constexpr IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
 Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options. More...
 
constexpr IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
 Construct NO_WRITE with specified read/register options. More...
 
constexpr IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
 Construct NO_READ with specified write/register options. More...
 
constexpr IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept
 Construct (NO_READ, NO_WRITE) with specified register option. More...
 
constexpr IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept
 Construct from components with specified register option as bool. More...
 
constexpr IOobjectOption (bool registerObject, bool globalObject=false) noexcept
 Construct (NO_READ, NO_WRITE) with specified register option as bool. More...
 
readOption readOpt () const noexcept
 Get the read option. More...
 
readOption readOpt (readOption opt) noexcept
 Set the read option. More...
 
writeOption writeOpt () const noexcept
 Get the write option. More...
 
writeOption writeOpt (writeOption opt) noexcept
 Set the write option. More...
 
bool registerObject () const noexcept
 Should objects created with this IOobject be registered? More...
 
bool registerObject (bool on) noexcept
 Change registration preference. More...
 
bool globalObject () const noexcept
 True if object is treated the same for all processors. More...
 
bool globalObject (bool on) noexcept
 Change global-object status. More...
 
bool isAnyRead () const noexcept
 True if any reading may be required (ie, != NO_READ) More...
 
bool isReadRequired () const noexcept
 True if (MUST_READ | READ_MODIFIED) bits are set. More...
 
bool isReadOptional () const noexcept
 True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More...
 
readOptionreadOpt () noexcept
 Access to the read option. More...
 
writeOptionwriteOpt () noexcept
 Access to the write option. More...
 
bool & registerObject () noexcept
 Access to the register object option. More...
 
bool & globalObject () noexcept
 Access to the global object option. More...
 
- Public Member Functions inherited from HashTable< regIOobject *>
 HashTable () noexcept
 Default construct: empty without allocation (capacity=0) More...
 
 HashTable (const Foam::zero) noexcept
 Construct empty without allocation (capacity=0) More...
 
 HashTable (const label initialCapacity)
 Construct empty with initial table capacity. More...
 
 HashTable (Istream &is)
 Construct from Istream. More...
 
 HashTable (const this_type &ht)
 Copy construct. More...
 
 HashTable (this_type &&rhs) noexcept
 Move construct. More...
 
 HashTable (std::initializer_list< std::pair< word, regIOobject * >> list)
 Construct from an initializer list. More...
 
 ~HashTable ()
 Destructor. More...
 
bool empty () const noexcept
 True if the hash table is empty. More...
 
label size () const noexcept
 The number of elements in table. More...
 
label capacity () const noexcept
 The size of the underlying table (the number of buckets) More...
 
regIOobject * & at (const word &key)
 Find and return a hashed entry. FatalError if it does not exist. More...
 
const regIOobject * & at (const word &key) const
 Find and return a hashed entry. FatalError if it does not exist. More...
 
bool contains (const word &key) const
 True if hashed key is contained (found) in table. More...
 
iterator find (const word &key)
 Find and return an iterator set at the hashed entry. More...
 
const_iterator find (const word &key) const
 Find and return an const_iterator set at the hashed entry. More...
 
const_iterator cfind (const word &key) const
 Find and return an const_iterator set at the hashed entry. More...
 
const regIOobject * & lookup (const word &key, const regIOobject * &deflt) const
 Return hashed entry if it exists, or return the given default. More...
 
List< wordtoc () const
 The table of contents (the keys) in unsorted order. More...
 
List< wordsortedToc () const
 The table of contents (the keys) in sorted order. More...
 
List< wordsortedToc (const Compare &comp) const
 The table of contents (the keys) sorted according to the specified comparator. More...
 
Foam::List< wordsortedToc (const Compare &comp) const
 
List< wordtocKeys (const UnaryPredicate &pred, const bool invert=false) const
 The table of contents (the keys) selected according to the unary predicate applied to the keys. More...
 
Foam::List< wordtocKeys (const UnaryPredicate &pred, const bool invert) const
 
List< wordtocValues (const UnaryPredicate &pred, const bool invert=false) const
 The table of contents (the keys) selected according to the unary predicate applied to the values. More...
 
Foam::List< wordtocValues (const UnaryPredicate &pred, const bool invert) const
 
List< wordtocEntries (const BinaryPredicate &pred, const bool invert=false) const
 The table of contents (the keys) selected according to the binary predicate applied to the keys and values. More...
 
Foam::List< wordtocEntries (const BinaryPredicate &pred, const bool invert) const
 
UPtrList< const node_typecsorted () const
 Const access to the hash-table contents in sorted order (sorted by keys). More...
 
UPtrList< node_typesorted ()
 Non-const access to the hash-table contents in sorted order (sorted by keys). More...
 
UPtrList< const node_typesorted () const
 Deprecated(2023-07) use csorted() method. More...
 
label countKeys (const UnaryPredicate &pred, const bool invert=false) const
 Count the number of keys that satisfy the unary predicate. More...
 
Foam::label countKeys (const UnaryPredicate &pred, const bool invert) const
 
label countValues (const UnaryPredicate &pred, const bool invert=false) const
 Count the number of values that satisfy the unary predicate. More...
 
Foam::label countValues (const UnaryPredicate &pred, const bool invert) const
 
label countEntries (const BinaryPredicate &pred, const bool invert=false) const
 Count the number of entries that satisfy the binary predicate. More...
 
Foam::label countEntries (const BinaryPredicate &pred, const bool invert) const
 
bool emplace (const word &key, Args &&... args)
 Emplace insert a new entry, not overwriting existing entries. More...
 
bool emplace_set (const word &key, Args &&... args)
 Emplace set an entry, overwriting any existing entries. More...
 
bool insert (const word &key, const regIOobject * &obj)
 Copy insert a new entry, not overwriting existing entries. More...
 
bool insert (const word &key, regIOobject * &&obj)
 Move insert a new entry, not overwriting existing entries. More...
 
bool set (const word &key, const regIOobject * &obj)
 Copy assign a new entry, overwriting existing entries. More...
 
bool set (const word &key, regIOobject * &&obj)
 Move assign a new entry, overwriting existing entries. More...
 
bool erase (const iterator &iter)
 Erase an entry specified by given iterator. More...
 
bool erase (const word &key)
 Erase an entry specified by the given key. More...
 
label erase (const HashTable< AnyType, word, AnyHash > &other)
 Remove table entries given by keys of the other hash-table. More...
 
label erase (std::initializer_list< word > keys)
 Remove table entries given by the listed keys. More...
 
label erase (InputIter first, InputIter last)
 Remove multiple entries using an iterator range of keys. More...
 
label erase (const FixedList< word, N > &keys)
 Remove table entries given by the listed keys. More...
 
label erase (const UList< word > &keys)
 Remove table entries given by the listed keys. More...
 
Foam::label erase (InputIter first, InputIter last)
 
Foam::label erase (const FixedList< word, N > &keys)
 
Foam::label erase (const HashTable< AnyType, word, AnyHash > &other)
 
label retain (const HashTable< AnyType, word, AnyHash > &other)
 Retain table entries given by keys of the other hash-table. More...
 
Foam::label retain (const HashTable< AnyType, word, AnyHash > &other)
 
label filterKeys (const UnaryPredicate &pred, const bool pruning=false)
 Generalized means to filter table entries based on their keys. More...
 
Foam::label filterKeys (const UnaryPredicate &pred, const bool pruning)
 
label filterValues (const UnaryPredicate &pred, const bool pruning=false)
 Generalized means to filter table entries based on their values. More...
 
Foam::label filterValues (const UnaryPredicate &pred, const bool pruning)
 
label filterEntries (const BinaryPredicate &pred, const bool pruning=false)
 Generalized means to filter table entries based on their key/value. More...
 
Foam::label filterEntries (const BinaryPredicate &pred, const bool pruning)
 
void clear ()
 Remove all entries from table. More...
 
void clearStorage ()
 Remove all entries from table and the table itself. More...
 
void setCapacity (label newCapacity)
 Change the hash table capacity (number of buckets). More...
 
void resize (label newCapacity)
 Rehash the hash table with new number of buckets. Currently identical to setCapacity() More...
 
void reserve (label numEntries)
 Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table. More...
 
void swap (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs) noexcept
 Swap contents into this table. More...
 
void transfer (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs)
 Transfer contents into this table. More...
 
void merge (HashTable< regIOobject *, word, Foam::Hash< word > > &source)
 Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged. More...
 
void merge (HashTable< regIOobject *, word, Foam::Hash< word > > &&source)
 Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged. More...
 
regIOobject * & operator[] (const word &key)
 Find and return a hashed entry. FatalError if it does not exist. More...
 
const regIOobject * & operator[] (const word &key) const
 Find and return a hashed entry. FatalError if it does not exist. More...
 
regIOobject * & operator() (const word &key)
 Return existing entry or create a new entry. More...
 
regIOobject * & operator() (const word &key, const regIOobject * &deflt)
 Return existing entry or insert a new entry. More...
 
void operator= (const this_type &rhs)
 Copy assign. More...
 
void operator= (std::initializer_list< std::pair< word, regIOobject * >> rhs)
 Copy assign from an initializer list. More...
 
void operator= (this_type &&rhs)
 Move assign. More...
 
bool operator== (const this_type &rhs) const
 Equality. Tables are equal if all keys and values are equal, independent of order or underlying storage size. More...
 
bool operator!= (const this_type &rhs) const
 The opposite of the equality operation. More...
 
this_typeoperator+= (const this_type &rhs)
 Add entries into this HashTable. More...
 
const_iterator_pair< const_key_iterator, this_typekeys () const
 A const iterator begin/end pair for iterating over keys. More...
 
iterator begin ()
 iterator set to the beginning of the HashTable More...
 
const_iterator begin () const
 const_iterator set to the beginning of the HashTable More...
 
const_iterator cbegin () const
 const_iterator set to the beginning of the HashTable More...
 
iterator end () noexcept
 iterator to signal the end (for any HashTable) More...
 
const_iterator end () const noexcept
 const_iterator to signal the end (for any HashTable) More...
 
constexpr const_iterator cend () const noexcept
 const_iterator to signal the end (for any HashTable) More...
 
OstreamprintInfo (Ostream &os) const
 Print information. More...
 
OstreamwriteKeys (Ostream &os, const label shortLen=0) const
 Write unordered keys (list), with line-breaks when length exceeds shortLen. More...
 
bool found (const word &key) const
 Same as contains() More...
 
- Public Member Functions inherited from HashTableCore
 ClassName ("HashTable")
 Declare type-name (with debug switch) More...
 
 HashTableCore () noexcept=default
 Default construct. More...
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState : char { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Public Types inherited from IOobjectOption
enum  readOption : unsigned char {
  NO_READ = 0, MUST_READ = 0x1, READ_MODIFIED = 0x3, MUST_READ_IF_MODIFIED = 0x3,
  LAZY_READ = 0x4, READ_IF_PRESENT = 0x4
}
 Enumeration defining read preferences. More...
 
enum  writeOption : unsigned char { NO_WRITE = 0, AUTO_WRITE = 0x10 }
 Enumeration defining write preferences. More...
 
enum  registerOption : unsigned char { NO_REGISTER = 0, REGISTER = 1, LEGACY_REGISTER = 2 }
 Enumeration for use with registerObject(). Values map to bool (false/true) More...
 
- Public Types inherited from HashTable< regIOobject *>
typedef HashTable< regIOobject *, word, Foam::Hash< word > > this_type
 The template instance used for this HashTable. More...
 
typedef std::conditional< std::is_same< Foam::zero, typename std::remove_cv< regIOobject * >::type >::value, Detail::HashTableSingle< word >, Detail::HashTablePair< word, regIOobject * > >::type node_type
 A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions. More...
 
typedef word key_type
 The second template parameter, type of keys used. More...
 
typedef regIOobjectmapped_type
 The first template parameter, type of objects contained. More...
 
typedef regIOobjectvalue_type
 Same as mapped_type for OpenFOAM HashTables. More...
 
typedef Foam::Hash< wordhasher
 The third template parameter, the hash index method. More...
 
typedef regIOobject * * pointer
 Pointer type for storing into value_type objects. More...
 
typedef regIOobject * & reference
 Reference to the stored value_type. More...
 
typedef const regIOobject * * const_pointer
 Const pointer type for the stored value_type. More...
 
typedef const regIOobject * & const_reference
 Const reference to the stored value_type. More...
 
typedef label difference_type
 The type to represent the difference between two iterators. More...
 
typedef label size_type
 The type that can represent the size of a HashTable. More...
 
using key_iterator = key_iterator_base< iterator >
 Forward iterator returning the key. More...
 
using const_key_iterator = key_iterator_base< const_iterator >
 Forward const iterator returning the key. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (refPtr< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &ptr)
 Transfer pointer ownership to its registry. More...
 
template<class Type >
static Type & store (tmp< Type > &&ptr)
 Transfer pointer ownership to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool bannerEnabled () noexcept
 Status of output file banner. More...
 
static bool bannerEnabled (bool on) noexcept
 Enable/disable output file banner. More...
 
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class StringType >
static word groupName (StringType base, const word &group)
 Create dot-delimited name.group string. More...
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
static word scopedName (const std::string &scope, const word &name)
 Create scope:name or scope_name string. More...
 
static word scopedName (const std::string &scope, const word &name1, const word &name2)
 Create scope:name1:name2 or scope_name1_name2 string. More...
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 Return the IOobject, but also consider an alternative file name. More...
 
static OstreamwriteBanner (Ostream &os, const bool noSyntaxHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
static OstreamwriteDivider (Ostream &os)
 Write the standard file section divider. More...
 
static OstreamwriteEndDivider (Ostream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from IOobjectOption
static bool isAnyRead (readOption opt) noexcept
 True if any reading may be required (ie, != NO_READ) More...
 
static bool isReadRequired (readOption opt) noexcept
 True if (MUST_READ | READ_MODIFIED) bits are set. More...
 
static bool isReadOptional (readOption opt) noexcept
 True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More...
 
static readOption lazierRead (readOption opt) noexcept
 Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. More...
 
- Static Public Member Functions inherited from HashTableCore
static label canonicalSize (const label requested_size)
 Return a canonical (power-of-two) of the requested size. More...
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 Names for the fileCheckTypes. More...
 
static char scopeSeparator
 Character for scoping object names (':' or '_') More...
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
static float fileModificationSkew
 Time skew (seconds) for file modification checks. More...
 
static int maxFileModificationPolls
 Max number of times to poll for file modification changes. More...
 
- Static Public Attributes inherited from HashTableCore
static const label maxTableSize
 Maximum allowable internal table size. Approximately labelMax/4. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 Set the object state to bad. More...
 
- Static Protected Member Functions inherited from IOobject
static void writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
 Helper: write content for FoamFile IOobject header with optional meta information. More...
 
static void writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
 Helper: write dictionary content for FoamFile header with optional meta information. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Registry of regIOobjects.

Source files

Definition at line 58 of file objectRegistry.H.

Constructor & Destructor Documentation

◆ objectRegistry() [1/2]

objectRegistry ( const Time db,
const label  initialCapacity = 128 
)
explicit

Construct the time objectRegistry, with estimated table capacity (default: 128)

Definition at line 76 of file objectRegistry.C.

◆ objectRegistry() [2/2]

objectRegistry ( const IOobject io,
const label  initialCapacity = 128 
)
explicit

Construct sub-registry given an IObject to describe the registry, with estimated table capacity (default: 128)

Definition at line 106 of file objectRegistry.C.

References IOobjectOption::AUTO_WRITE.

◆ ~objectRegistry()

~objectRegistry ( )
virtual

Destructor, with checkOut() for all objects that are ownedByRegistry.

Definition at line 127 of file objectRegistry.C.

References objectRegistry::clear().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "objectRegistry"  )

Declare type name for this IOobject.

◆ thisDb()

const objectRegistry& thisDb ( ) const
inlinenoexcept

Return the object registry.

Definition at line 264 of file objectRegistry.H.

Referenced by fvsPatchFieldBase::db(), faePatchFieldBase::db(), faPatchFieldBase::db(), pointPatchFieldBase::db(), and fvPatchFieldBase::db().

Here is the caller graph for this function:

◆ parent()

const objectRegistry& parent ( ) const
inlinenoexcept

Return the parent objectRegistry.

Definition at line 272 of file objectRegistry.H.

Referenced by fileOperation::readObjects().

Here is the caller graph for this function:

◆ time()

const Time& time ( ) const
inlinenoexcept

Return time registry.

Definition at line 280 of file objectRegistry.H.

Referenced by mappedPatchBase::addWorldConnection(), minTimeStepCondition::apply(), equationMaxIterCondition::apply(), maxDurationCondition::apply(), SprayParcel< ParcelType >::calcAtomization(), fieldAverageItem::calculateMeanField(), fieldAverageItem::calculatePrime2MeanField(), cyclicAMIPolyPatch::canResetAMI(), codedBase::codeDict(), logFiles::createFiles(), cloud::createIOField(), exprResultGlobals::Delete(), IATEsource::Eo(), equationInitialResidualCondition::equationInitialResidualCondition(), moleculeCloud::evolve(), fieldAverageItem::evolve(), coupleGroupIdentifier::findOtherPatchID(), mappedPatchBase::getWorldCommunicator(), DSMCParcel< ParcelType >::hitWallPatch(), surfaceNoise::initialise(), codedPoints0MotionSolver::libs(), mappedPatchBase::lookupMesh(), mappedVariableThicknessWallFvPatch::makeDeltaCoeffs(), Foam::MapLagrangianFields(), Foam::MapMesh(), meshReader::mesh(), IATEsource::Mo(), triSurfaceMesh::movePoints(), lumpedPointIOMovement::New(), exprResultGlobals::New(), GAMGAgglomeration::New(), objectiveManager::objectiveManager(), motionSolver::iNew::operator()(), points0MotionSolver::points0IO(), polyMesh::polyMesh(), areaWrite::read(), uncollatedFileOperation::readObjects(), masterUncollatedFileOperation::readObjects(), polyMesh::readUpdate(), regionProperties::regionProperties(), triSurfaceMesh::setField(), twoPhaseSystem::solve(), multiphaseSystem::solve(), RASTurbulenceModel::solveIter(), patchFunction1Base::time(), fvMesh::time(), MPPICParcel< ParcelType >::trackingData::updateAverages(), KinematicParcel< ParcelType >::trackingData::updateAverages(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), velocityFilmShellFvPatchVectorField::updateCoeffs(), porousBafflePressureFvPatchField::updateCoeffs(), polyMesh::updateMesh(), FIREMeshWriter::write(), areaWrite::write(), PDRblock::writeBlockMeshDict(), and molecule::writeFields().

◆ isTimeDb()

bool isTimeDb ( ) const
noexcept

True if the registry is Time.

Definition at line 135 of file objectRegistry.C.

◆ dbDir()

virtual const fileName& dbDir ( ) const
inlinevirtual

Local directory path of this objectRegistry relative to the time.

Reimplemented in Time, and polyMesh.

Definition at line 293 of file objectRegistry.H.

Referenced by polyMesh::dbDir(), fileOperation::processorsPath(), fileOperation::readObjects(), surfMesh::surfMesh(), decomposedBlockData::writeHeader(), and IOobject::writeHeaderContent().

Here is the caller graph for this function:

◆ classes() [1/3]

Foam::HashTable< Foam::wordHashSet > classes ( ) const

A summary hash of classes used and their associated object names.

Behaviour and usage as per IOobjectList::classes

Definition at line 141 of file objectRegistry.C.

Referenced by areaWrite::write().

Here is the caller graph for this function:

◆ classes() [2/3]

HashTable<wordHashSet> classes ( const MatchPredicate &  matchName) const

A summary hash of classes used and their associated object names, restricted to objects that have a matching object name.

◆ cobjects() [1/4]

UPtrList<const Type> cobjects ( ) const

Return unsorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict)

The lifetime of the returned content cannot exceed the parent!

Referenced by coupleGroupIdentifier::findOtherPatchID(), and basicThermo::lookupThermo().

Here is the caller graph for this function:

◆ objects() [1/4]

UPtrList<Type> objects ( )

Return unsorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict)

The lifetime of the returned content cannot exceed the parent!

Referenced by Time::readDict().

Here is the caller graph for this function:

◆ cobjects() [2/4]

UPtrList<const Type> cobjects ( const MatchPredicate &  matchName) const

Return unsorted list of objects with a class satisfying isA<Type> that also have a matching object name.

The lifetime of the returned content cannot exceed the parent!

◆ objects() [2/4]

UPtrList<Type> objects ( const MatchPredicate &  matchName)

Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name.

The lifetime of the returned content cannot exceed the parent!

◆ csorted() [1/5]

UPtrList<const Type> csorted ( ) const

Return sorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict)

The lifetime of the returned content cannot exceed the parent!

Referenced by cellCellStencil::interpolate(), surfaceInterpolate::interpolateFields(), Foam::mapClouds(), vtkUnstructuredReader::printFieldStats(), vtkWrite::writeVolFieldsImpl(), and ensightWrite::writeVolFieldsImpl().

Here is the caller graph for this function:

◆ sorted() [1/8]

UPtrList<Type> sorted ( )

Return sorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict)

The lifetime of the returned content cannot exceed the parent!

◆ csorted() [2/5]

UPtrList<const regIOobject> csorted ( ) const
inline

Return sorted list of objects.

The lifetime of the returned content cannot exceed the parent!

Definition at line 380 of file objectRegistry.H.

◆ sorted() [2/8]

UPtrList<regIOobject> sorted ( )
inline

Return sorted list of objects.

The lifetime of the returned content cannot exceed the parent!

Definition at line 390 of file objectRegistry.H.

◆ csorted() [3/5]

UPtrList<const Type> csorted ( const MatchPredicate &  matchName) const

Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name.

The lifetime of the returned content cannot exceed the parent!

◆ sorted() [3/8]

UPtrList<Type> sorted ( const MatchPredicate &  matchName)

Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name.

The lifetime of the returned content cannot exceed the parent!

◆ count() [1/9]

Foam::label count ( const char *  clsName) const

The number of objects of the given class name.

Note
uses the class type() method

Definition at line 147 of file objectRegistry.C.

References Foam::BitOps::count().

Referenced by vtkWrite::write().

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

◆ count() [2/9]

label count ( const MatchPredicate &  matchClass) const

The number of objects of the given class name.

Note
uses the class type() method

◆ count() [3/9]

label count ( const MatchPredicate1 &  matchClass,
const MatchPredicate2 &  matchName 
) const

The number of objects of the given class name.

Note
uses the class type() method

◆ count() [4/9]

label count ( const bool  strict = false) const

The names of objects with a class satisfying isA<Type>

Parameters
strictuse isType<Type> instead of isA<Type>
Note
The values of count<Type>() and count(Type::typeName) may be inconsistent, since they use different mechanisms for testing the class type.
If Type is void, no isA check is used (always true).

◆ count() [5/9]

label count ( const MatchPredicate &  matchName) const

The names of objects with a class satisfying isA<Type> that also have a matching object name.

Note
If Type is void, no isA check is used (always true).

◆ names() [1/10]

Foam::wordList names ( ) const

The unsorted names of all objects.

Definition at line 154 of file objectRegistry.C.

References HashTable< T, Key, Hash >::toc().

Referenced by dynamicMultiMotionSolverFvMesh::init(), areaWrite::write(), vtkWrite::write(), and vtkCloud::writeFields().

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

◆ names() [2/10]

Foam::wordList names ( const char *  clsName) const

The unsorted names of objects with the given class name.

Note
uses the class type() method

Definition at line 166 of file objectRegistry.C.

References Foam::PtrListOps::names().

Here is the call graph for this function:

◆ names() [3/10]

wordList names ( const MatchPredicate &  matchClass) const

The unsorted names of objects with a matching class name.

Note
uses the class type() method

◆ names() [4/10]

wordList names ( const MatchPredicate1 &  matchClass,
const MatchPredicate2 &  matchName 
) const

The unsorted names of objects with a matching class name that also have a matching object name.

Note
uses the class type() method

◆ names() [5/10]

wordList names ( ) const

The unsorted names of objects with a class satisfying isA<Type>

Note
If Type is void, no isA check is used (always true).

◆ names() [6/10]

wordList names ( const MatchPredicate &  matchName) const

The unsorted names of objects with a class satisfying isA<Type> that also have a matching object name.

Note
If Type is void, no isA check is used (always true).

◆ sortedNames() [1/10]

Foam::wordList sortedNames ( ) const

The sorted names of all objects.

Definition at line 160 of file objectRegistry.C.

References HashTable< T, Key, Hash >::sortedToc().

Referenced by coupleGroupIdentifier::findOtherPatchID(), parseDriver::getField(), parseDriver::patchInternalField(), parseDriver::patchNeighbourField(), parseDriver::patchNormalField(), and multiRegion::read().

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

◆ sortedNames() [2/10]

Foam::wordList sortedNames ( const char *  clsName) const

The sorted names of objects with the given class name.

Note
uses the class type() method

Definition at line 173 of file objectRegistry.C.

◆ sortedNames() [3/10]

wordList sortedNames ( const MatchPredicate &  matchClass) const

The sorted names objects with a matching class name.

Note
uses the class type() method

◆ sortedNames() [4/10]

wordList sortedNames ( const MatchPredicate1 &  matchClass,
const MatchPredicate2 &  matchName 
) const

The sorted names of objects with a matching class name that also have a matching object name.

Note
uses the class type() method

◆ sortedNames() [5/10]

wordList sortedNames ( ) const

The sorted names of objects with a class satisfying isA<Type>

Note
If Type is void, no isA check is used (always true).

◆ sortedNames() [6/10]

wordList sortedNames ( const MatchPredicate &  matchName) const

The sorted names of objects with a class satisfying isA<Type> that also have a matching object name.

Note
If Type is void, no isA check is used (always true).

◆ subRegistry()

const Foam::objectRegistry & subRegistry ( const word name,
const bool  forceCreate = false,
const bool  recursive = false 
) const

Lookup and return a const sub-objectRegistry.

Parameters
forceCreatecreate it if it does not exist.
recursivesearch parent registries.

Definition at line 181 of file objectRegistry.C.

References Foam::name(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, IOobjectOption::REGISTER, and regIOobject::store().

Referenced by polySurface::pointData(), mappedPatchBase::readDict(), mappedPatchBase::subRegistry(), and uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs().

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

◆ lookupClass() [1/8]

HashTable<const Type*> lookupClass ( ) const

Return all objects with a class satisfying isA<Type> or isType<Type> (with Strict)

Referenced by meshObject::clear(), meshObject::clearUpto(), meshObject::movePoints(), and meshObject::updateMesh().

Here is the caller graph for this function:

◆ lookupClass() [2/8]

HashTable<Type*> lookupClass ( )

Return all objects with a class satisfying isA<Type> or isType<Type> (with Strict)

◆ lookupClass() [3/8]

HashTable<const Type*> lookupClass ( const bool  strict) const

Return all objects with a class satisfying isA<Type>

Parameters
strictuse isType<Type> instead of isA<Type>

◆ lookupClass() [4/8]

HashTable<Type*> lookupClass ( const bool  strict)

Return all objects with a class satisfying isA<Type>

Parameters
strictuse isType<Type> instead of isA<Type>

◆ cfindIOobject()

const Foam::regIOobject * cfindIOobject ( const word name,
const bool  recursive = false 
) const

Return const pointer to the regIOobject.

Parameters
recursivesearch parent registries
Returns
nullptr if the object was not found.

Definition at line 450 of file objectRegistry.C.

References Foam::name().

Referenced by parseDriver::getField(), parseDriver::patchInternalField(), parseDriver::patchNeighbourField(), and parseDriver::patchNormalField().

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

◆ contains()

bool contains ( const word name,
const bool  recursive = false 
) const

Does the registry contain the regIOobject object (by name).

Parameters
namethe object name
recursivesearch parent registries

Definition at line 471 of file objectRegistry.C.

References Foam::name().

Referenced by objectRegistry::found().

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

◆ foundObject()

◆ cfindObject()

const Type * cfindObject ( const word name,
const bool  recursive = false 
) const

◆ findObject() [1/2]

◆ findObject() [2/2]

Type * findObject ( const word name,
const bool  recursive = false 
)

Return non-const pointer to the object of the given Type.

Parameters
recursivesearch parent registries
Returns
nullptr if the object was not found or had incorrect type.

Definition at line 570 of file objectRegistryTemplates.C.

References Foam::name().

Here is the call graph for this function:

◆ getObjectPtr()

Type * getObjectPtr ( const word name,
const bool  recursive = false 
) const

Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable.

Exercise caution when using.

Parameters
recursivesearch parent registries.
Returns
nullptr if the object was not found or had incorrect type.

Definition at line 581 of file objectRegistryTemplates.C.

References Foam::name().

Referenced by Foam::calc_pTotal(), Foam::calc_rhoU(), ObukhovLength::calcOL(), codedBase::codeDict(), mappedPatchBase::constructIOField(), exprResultGlobals::Delete(), filmFlux::execute(), forces::force(), lumpedPointIOMovement::getMovementObject(), sampledSurface::getRegistrySurface(), zoneCPCStencil::New(), exprResultGlobals::New(), zoneDistribute::New(), regionModel::regionMesh(), searchableSurfaceWithGaps::searchableSurfaceWithGaps(), lduMatrix::setResidualField(), surfMesh::storeField(), polySurface::storeField(), mappedPatchBase::storeField(), regionFunctionObject::storeInDb(), areaWrite::write(), and cellCellStencil::zoneID().

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

◆ lookupObject()

const Type & lookupObject ( const word name,
const bool  recursive = false 
) const

Lookup and return const reference to the object of the given Type. Fatal if not found or the wrong type.

Parameters
recursivesearch parent registries.

Definition at line 592 of file objectRegistryTemplates.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::name(), and Foam::nl.

Referenced by solidAbsorption::a(), interRegionHeatTransferModel::addSup(), objectiveIncompressible::allocatedJdTurbulence(), DEShybrid< Type >::blendingFactor(), Foam::calc_pTotal(), Foam::calc_rhoU(), ObukhovLength::calcOL(), parcelSelection::calculateFilter(), tabulatedHeatTransfer::calculateHtc(), variableHeatTransfer::calculateHtc(), fieldAverageItem::calculateMeanField(), fieldAverageItem::calculatePrime2MeanField(), kEpsilon::computeG(), kOmegaSST::computeG(), motionDirectionalDiffusivity::correct(), isothermal::d(), filmTurbulenceModel::devRhoReff(), solidAbsorption::e(), IATEsource::Eo(), interfaceTrackingFvMesh::freeSurfacePressureJump(), interfaceTrackingFvMesh::freeSurfaceSnGradU(), topOSource::getSource(), interRegionExplicitPorositySource::initialise(), objectiveTopOSolidVolume::J(), objectiveTopOVolume::J(), objectivePowerDissipation::J(), phaseSystem::lookupBlendedSubModel(), cloud::lookupIOField(), mappedPatchBase::lookupMesh(), twoPhaseSystem::lookupSubModel(), phaseSystem::lookupSubModel(), basicThermo::lookupThermo(), mappedVariableThicknessWallFvPatch::makeDeltaCoeffs(), regionModel::mapRegionPatchField(), regionModel::mapRegionPatchInternalField(), function1Base::mesh(), faMesh::mesh(), IATEsource::Mo(), solidParticleCloud::move(), displacementMotionSolverMeshMover::move(), medialAxisMeshMover::move(), solidAbsorption::nBands(), surfaceFieldValue::obr(), enthalpySorptionFvPatchScalarField::patchSource(), pointHistory::pointHistory(), hydrostaticPressure::pRef(), particleDistribution::processField(), heatTransferCoeffModel::q(), filmTurbulenceModel::rho(), ReynoldsAnalogy::rho(), VollerPrakash::S(), interRegionOption::setMapper(), interRegionHeatTransferModel::setNbrModel(), sixDoFRigidBodyMotionSolver::solve(), rigidBodyMeshMotionSolver::solve(), rigidBodyMeshMotion::solve(), liquidFilmBase::Up(), objectivePowerDissipation::update_dJdb(), objectivePowerDissipation::update_dJdv(), objectiveNutSqr::update_dJdv(), inclinedFilmNusseltHeightFvPatchScalarField::updateCoeffs(), inclinedFilmNusseltInletVelocityFvPatchVectorField::updateCoeffs(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), vibrationShellFvPatchScalarField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), porousBafflePressureFvPatchField::updateCoeffs(), momentumError::write(), and particleDistribution::write().

Here is the call graph for this function:

◆ lookupObjectRef()

Type & lookupObjectRef ( const word name,
const bool  recursive = false 
) const

Lookup and return non-const reference to the object of the given Type. Fatal if not found or the wrong type.

Parameters
recursivesearch parent registries.

Definition at line 636 of file objectRegistryTemplates.C.

References Foam::name(), and ref().

Referenced by heatTransferCoeff::calc(), momentumError::calcMomentError(), fieldAverageItem::calculateMeanField(), fieldAverageItem::calculatePrime2MeanField(), MapFieldConstraint< Type >::constrain(), relaxedSnGrad< Type >::correction(), surfaceDistance::execute(), wallBoiling::R(), searchableSurfaceCollection::searchableSurfaceCollection(), levelSetDesignVariables::update(), and uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs().

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

◆ getEvent()

Foam::label getEvent ( ) const

Return new event number.

Definition at line 208 of file objectRegistry.C.

References Foam::ensightOutput::debug, Foam::endl(), Foam::labelMax, Foam::nl, and WarningInFunction.

Here is the call graph for this function:

◆ checkIn() [1/2]

bool checkIn ( regIOobject io) const

Add a regIOobject to registry. A nullptr is ignored.

Definition at line 234 of file objectRegistry.C.

References Foam::ensightOutput::debug, Foam::endl(), HashTable< T, Key, Hash >::find(), HashTable< T, Key, Hash >::insert(), io(), Foam::name(), IOobject::name(), Foam::Pout, and WarningInFunction.

Here is the call graph for this function:

◆ checkIn() [2/2]

bool checkIn ( regIOobject io) const

Add a regIOobject to registry.

Definition at line 339 of file objectRegistry.C.

References io().

Here is the call graph for this function:

◆ checkOut() [1/3]

bool checkOut ( regIOobject io) const

◆ checkOut() [2/3]

bool checkOut ( regIOobject io) const

Remove a regIOobject from registry and free memory if the object is ownedByRegistry.

Definition at line 345 of file objectRegistry.C.

References io().

Here is the call graph for this function:

◆ checkOut() [3/3]

bool checkOut ( const word key) const

Remove a regIOobject by name from registry and free memory if the object is ownedByRegistry.

Definition at line 351 of file objectRegistry.C.

References objectRegistry::erase(), and Foam::glTF::key().

Here is the call graph for this function:

◆ clear()

void clear ( )

Clear all entries from the registry.

Performs a checkOut() for all objects that are ownedByRegistry

Definition at line 357 of file objectRegistry.C.

References stdFoam::begin(), HashTable< T, Key, Hash >::clear(), Foam::ensightOutput::debug, stdFoam::end(), IOobject::name(), Foam::nl, regIOobject::ownedByRegistry(), Foam::Pout, and regIOobject::release().

Referenced by surfMesh::clearFields(), polySurface::clearFields(), objectRegistry::clearStorage(), extendedEdgeMesh::transfer(), objectRegistry::~objectRegistry(), and Time::~Time().

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

◆ clearStorage()

void clearStorage ( )

Clear all entries from the registry and the table itself.

Definition at line 383 of file objectRegistry.C.

References objectRegistry::clear(), and HashTable< T, Key, Hash >::clearStorage().

Here is the call graph for this function:

◆ erase() [1/4]

bool erase ( const iterator &  iter)

Erase an entry specified by the given iterator.

Performs a checkOut() if the object was ownedByRegistry.

Returns
True if the entry existed and was removed

Definition at line 390 of file objectRegistry.C.

References HashTable< T, Key, Hash >::erase(), regIOobject::ownedByRegistry(), and regIOobject::release().

Referenced by objectRegistry::checkOut(), and Foam::eraseImpl().

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

◆ erase() [2/4]

bool erase ( const word key)

Erase an entry specified by the given key.

Performs a checkOut() if the object was ownedByRegistry.

Returns
True if the entry existed and was removed

Definition at line 413 of file objectRegistry.C.

References erase(), Foam::ListOps::find(), and Foam::glTF::key().

Here is the call graph for this function:

◆ erase() [3/4]

Foam::label erase ( std::initializer_list< word keys)

Remove entries given by the listed keys.

Performs a checkOut() for all objects that are ownedByRegistry.

Returns
The number of items removed

Definition at line 419 of file objectRegistry.C.

References Foam::eraseImpl().

Here is the call graph for this function:

◆ erase() [4/4]

Foam::label erase ( const UList< word > &  keys)

Remove entries given by the listed keys.

Performs a checkOut() for all objects that are ownedByRegistry.

Returns
The number of items removed

Definition at line 425 of file objectRegistry.C.

References UList< T >::begin(), UList< T >::end(), and Foam::eraseImpl().

Here is the call graph for this function:

◆ rename()

void rename ( const word newName)
virtual

Rename.

Reimplemented from regIOobject.

Definition at line 431 of file objectRegistry.C.

References regIOobject::rename(), and string::replace().

Here is the call graph for this function:

◆ is_cacheTemporaryObject() [1/3]

bool is_cacheTemporaryObject ( const word name) const

True if given name is in the cacheTemporaryObjects set.

Definition at line 95 of file objectRegistryCache.C.

References Foam::name().

Here is the call graph for this function:

◆ is_cacheTemporaryObject() [2/3]

bool is_cacheTemporaryObject ( const regIOobject io) const

True if name of object is in the cacheTemporaryObjects set.

Definition at line 103 of file objectRegistryCache.C.

References io(), and IOobject::name().

Here is the call graph for this function:

◆ is_cacheTemporaryObject() [3/3]

bool is_cacheTemporaryObject ( const regIOobject io) const

True if name of object is in the cacheTemporaryObjects set.

Definition at line 109 of file objectRegistryCache.C.

References io(), and IOobject::name().

Here is the call graph for this function:

◆ cacheTemporaryObject()

bool cacheTemporaryObject ( Type &  obj) const

Cache the given object. Moves content and stores.

Definition at line 649 of file objectRegistryTemplates.C.

References Foam::ensightOutput::debug, Foam::endl(), Foam::Info, and regIOobject::store().

Here is the call graph for this function:

◆ resetCacheTemporaryObject() [1/2]

void resetCacheTemporaryObject ( const regIOobject io) const

Reset the cache state of the given object (nullptr is ignored)

Definition at line 116 of file objectRegistryCache.C.

References io(), and IOobject::name().

Here is the call graph for this function:

◆ resetCacheTemporaryObject() [2/2]

void resetCacheTemporaryObject ( const regIOobject io) const

Reset the cache state of the given object in the cacheTemporaryObjects set.

Definition at line 134 of file objectRegistryCache.C.

References io().

Here is the call graph for this function:

◆ checkCacheTemporaryObjects()

bool checkCacheTemporaryObjects ( ) const

Check that all objects specified in the cacheTemporaryObjects were also cached.

Definition at line 142 of file objectRegistryCache.C.

References objectRegistry::checkCacheTemporaryObjects(), Foam::endl(), forAllConstIters(), forAllIters, Foam::name(), Foam::nl, messageStream::stream(), and Foam::Warning.

Referenced by objectRegistry::checkCacheTemporaryObjects().

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

◆ modified()

bool modified ( ) const
virtual

Return true if any of the object's files have been modified.

Reimplemented from regIOobject.

Definition at line 480 of file objectRegistry.C.

References stdFoam::cbegin(), and stdFoam::cend().

Referenced by Time::readModifiedObjects().

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

◆ readModifiedObjects()

void readModifiedObjects ( )

Read the objects that have been modified.

Definition at line 494 of file objectRegistry.C.

References stdFoam::begin(), Foam::ensightOutput::debug, stdFoam::end(), Foam::endl(), Foam::name(), and Foam::Pout.

Referenced by Time::readModifiedObjects().

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

◆ readIfModified()

bool readIfModified ( )
virtual

Read object if modified.

Reimplemented from regIOobject.

Definition at line 510 of file objectRegistry.C.

◆ writeData()

virtual bool writeData ( Ostream ) const
inlinevirtual

The writeData function is required by regIOobject but not used.

For this class, write is used instead

Implements regIOobject.

Reimplemented in triSurfaceMesh.

Definition at line 911 of file objectRegistry.H.

References NotImplemented.

◆ writeObject()

◆ found()

bool found ( const word name,
bool  recursive = false 
) const
inline

Same as contains()

Definition at line 932 of file objectRegistry.H.

References objectRegistry::contains().

Referenced by simplifiedFvMesh::fvPatchFieldExists(), turbulenceFields::initialise(), surfaceInterpolate::interpolateFields(), polySurface::queryFieldAssociation(), and polySurface::whichRegistry().

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

◆ lookupObjectPtr()

const Type* lookupObjectPtr ( const word name,
bool  recursive = false 
) const
inline

Deprecated(2018-10) find object.

Deprecated:
(2018-10) - use findObject() method

Definition at line 945 of file objectRegistry.H.

References IOobject::name().

Here is the call graph for this function:

◆ lookupObjectRefPtr()

Type* lookupObjectRefPtr ( const word name,
bool  recursive = false 
) const
inline

Deprecated(2018-10) get object pointer, ignoring constness.

Deprecated:
(2018-10) - use getObjectPtr() method

Definition at line 961 of file objectRegistry.H.

References IOobject::name().

Here is the call graph for this function:

◆ sorted() [4/8]

UPtrList<const Type> sorted ( ) const
inline

Deprecated(2023-07) use csorted() method.

Deprecated:
(2023-07) - use csorted() method

Definition at line 976 of file objectRegistry.H.

◆ sorted() [5/8]

UPtrList<const regIOobject> sorted ( ) const
inline

Deprecated(2023-07) use csorted() method.

Deprecated:
(2023-07) - use csorted() method

Definition at line 987 of file objectRegistry.H.

◆ sorted() [6/8]

UPtrList<const Type> sorted ( const MatchPredicate &  matchName) const
inline

Deprecated(2023-07) use csorted() method.

Deprecated:
(2023-07) - use csorted() method

Definition at line 999 of file objectRegistry.H.

◆ classesImpl()

Foam::HashTable<Foam::wordHashSet> classesImpl ( const objectRegistry list,
const MatchPredicate &  matchName 
)

Definition at line 31 of file objectRegistryTemplates.C.

References forAllConstIters(), insert(), IOobject::name(), and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

◆ countImpl()

Foam::label countImpl ( const objectRegistry list,
const MatchPredicate1 &  matchClass,
const MatchPredicate2 &  matchName 
)

Definition at line 57 of file objectRegistryTemplates.C.

References Foam::BitOps::count(), forAllConstIters(), and IOobject::name().

Here is the call graph for this function:

◆ countTypeImpl()

Foam::label countTypeImpl ( const objectRegistry list,
const MatchPredicate &  matchName 
)

Definition at line 82 of file objectRegistryTemplates.C.

References Foam::BitOps::count(), forAllConstIters(), and IOobject::name().

Here is the call graph for this function:

◆ namesImpl()

Foam::wordList namesImpl ( const objectRegistry list,
const MatchPredicate1 &  matchClass,
const MatchPredicate2 &  matchName,
const bool  doSort 
)

Definition at line 110 of file objectRegistryTemplates.C.

References Foam::BitOps::count(), forAllConstIters(), IOobject::name(), HashTable< T, Key, Hash >::size(), and Foam::sort().

Here is the call graph for this function:

◆ namesTypeImpl()

Foam::wordList namesTypeImpl ( const objectRegistry list,
const MatchPredicate &  matchName,
const bool  doSort 
)

Definition at line 145 of file objectRegistryTemplates.C.

References Foam::BitOps::count(), forAllConstIters(), IOobject::name(), HashTable< T, Key, Hash >::size(), and Foam::sort().

Here is the call graph for this function:

◆ objectsTypeImpl()

Foam::UPtrList<Type> objectsTypeImpl ( const bool  strict,
const objectRegistry list,
const MatchPredicate &  matchName,
const bool  doSort 
)

Definition at line 184 of file objectRegistryTemplates.C.

References Foam::BitOps::count(), forAllConstIters(), IOobject::name(), HashTable< T, Key, Hash >::size(), and Foam::sort().

Here is the call graph for this function:

◆ lookupClassTypeImpl()

Foam::HashTable<Type*> lookupClassTypeImpl ( const bool  strict,
const objectRegistry list 
)

Definition at line 228 of file objectRegistryTemplates.C.

References HashTable< T, Key, Hash >::capacity(), forAllConstIters(), and IOobject::name().

Here is the call graph for this function:

◆ classes() [3/3]

Foam::HashTable<Foam::wordHashSet> classes ( const MatchPredicate &  matchName) const

Definition at line 261 of file objectRegistryTemplates.C.

◆ count() [6/9]

Foam::label count ( const MatchPredicate &  matchClass) const

Definition at line 271 of file objectRegistryTemplates.C.

◆ count() [7/9]

Foam::label count ( const MatchPredicate1 &  matchClass,
const MatchPredicate2 &  matchName 
) const

Definition at line 281 of file objectRegistryTemplates.C.

◆ count() [8/9]

Foam::label count ( const MatchPredicate &  matchName) const

Definition at line 292 of file objectRegistryTemplates.C.

◆ count() [9/9]

Foam::label count ( const bool  strict) const

Definition at line 302 of file objectRegistryTemplates.C.

References forAllConstIters().

Here is the call graph for this function:

◆ cobjects() [3/4]

Foam::UPtrList<const Type> cobjects ( ) const

Definition at line 335 of file objectRegistryTemplates.C.

◆ objects() [3/4]

Foam::UPtrList<Type> objects ( )

Definition at line 346 of file objectRegistryTemplates.C.

◆ csorted() [4/5]

Foam::UPtrList<const Type> csorted ( ) const

Definition at line 357 of file objectRegistryTemplates.C.

◆ sorted() [7/8]

Foam::UPtrList<Type> sorted ( )

Definition at line 368 of file objectRegistryTemplates.C.

◆ cobjects() [4/4]

Foam::UPtrList<const Type> cobjects ( const MatchPredicate &  matchName) const

Definition at line 380 of file objectRegistryTemplates.C.

◆ objects() [4/4]

Foam::UPtrList<Type> objects ( const MatchPredicate &  matchName)

Definition at line 392 of file objectRegistryTemplates.C.

◆ csorted() [5/5]

Foam::UPtrList<const Type> csorted ( const MatchPredicate &  matchName) const

Definition at line 404 of file objectRegistryTemplates.C.

◆ sorted() [8/8]

Foam::UPtrList<Type> sorted ( const MatchPredicate &  matchName)

Definition at line 415 of file objectRegistryTemplates.C.

◆ names() [7/10]

Foam::wordList names ( const MatchPredicate &  matchClass) const

Definition at line 427 of file objectRegistryTemplates.C.

◆ names() [8/10]

Foam::wordList names ( const MatchPredicate1 &  matchClass,
const MatchPredicate2 &  matchName 
) const

Definition at line 437 of file objectRegistryTemplates.C.

◆ names() [9/10]

Foam::wordList names ( ) const

Definition at line 447 of file objectRegistryTemplates.C.

◆ names() [10/10]

Foam::wordList names ( const MatchPredicate &  matchName) const

Definition at line 455 of file objectRegistryTemplates.C.

◆ sortedNames() [7/10]

Foam::wordList sortedNames ( const MatchPredicate &  matchClass) const

Definition at line 465 of file objectRegistryTemplates.C.

◆ sortedNames() [8/10]

Foam::wordList sortedNames ( const MatchPredicate1 &  matchClass,
const MatchPredicate2 &  matchName 
) const

Definition at line 475 of file objectRegistryTemplates.C.

◆ sortedNames() [9/10]

Foam::wordList sortedNames ( ) const

Definition at line 485 of file objectRegistryTemplates.C.

◆ sortedNames() [10/10]

Foam::wordList sortedNames ( const MatchPredicate &  matchName) const

Definition at line 493 of file objectRegistryTemplates.C.

◆ lookupClass() [5/8]

Foam::HashTable<const Type*> lookupClass ( ) const

Definition at line 502 of file objectRegistryTemplates.C.

◆ lookupClass() [6/8]

Foam::HashTable<Type*> lookupClass ( )

Definition at line 509 of file objectRegistryTemplates.C.

◆ lookupClass() [7/8]

Foam::HashTable<const Type*> lookupClass ( const bool  strict) const

Definition at line 517 of file objectRegistryTemplates.C.

◆ lookupClass() [8/8]

Foam::HashTable<Type*> lookupClass ( const bool  strict)

Definition at line 527 of file objectRegistryTemplates.C.


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