objectRegistry Class Reference

Registry of regIOobjects. More...

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

Public Member Functions

 TypeName ("objectRegistry")
 Declare type name for this IOobject. More...
 
 objectRegistry (const Time &db, const label nObjects=128)
 
 objectRegistry (const IOobject &io, const label nObjects=128)
 
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
 
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
 
wordList names () const
 The names of all objects. More...
 
wordList names (const char *clsName) const
 The names of objects with the given class name. More...
 
template<class MatchPredicate >
wordList names (const MatchPredicate &matchClass) const
 The names of objects with a matching class name. More...
 
template<class MatchPredicate1 , class MatchPredicate2 >
wordList names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const
 
template<class Type >
wordList names () const
 The names of objects with a class satisfying isA<Type>. More...
 
template<class Type , class MatchPredicate >
wordList names (const MatchPredicate &matchName) const
 
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
 
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
 
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 >
HashTable< const Type * > lookupClass (const bool strict=false) const
 Return all objects with a class satisfying isA<Type> More...
 
template<class Type >
HashTable< Type * > lookupClass (const bool strict=false)
 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 found (const word &name, const bool recursive=false) const
 Can the regIOobject object be found (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
 
template<class Type >
const Type & lookupObject (const word &name, const bool recursive=false) const
 
template<class Type >
Type & lookupObjectRef (const word &name, const bool recursive=false) const
 
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
 
bool checkOut (regIOobject &io) const
 
bool checkOut (const word &key) const
 
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...
 
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
 writeData function required by regIOobject but not used. More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 Write the objects using stream options. 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 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 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 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 >
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
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &io, const bool isTimeObject=false)
 
 regIOobject (const regIOobject &rio)
 Copy construct. More...
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 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 ownedByRegistry () const
 Is this object owned by the registry? More...
 
bool store ()
 
void release (const bool unregister=false)
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
label & eventNo ()
 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. More...
 
IstreamreadStream (const word &, const bool valid=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
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool write (const bool valid=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 comp, const bool valid) 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, readOption r=NO_READ, writeOption w=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, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=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, readOption, writeOption)
 Copy construct, resetting io options. 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
 Return Time associated with the objectRegistry. More...
 
const wordname () const noexcept
 Return 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
 Return non-constant access to the optional note. More...
 
bool registerObject () const noexcept
 Should object created with this IOobject be registered? More...
 
bool registerObject (bool on) noexcept
 Change registration preference, return previous value. More...
 
bool globalObject () const noexcept
 Is object same for all processors? More...
 
bool globalObject (bool on) noexcept
 Change global-object status, return previous value. 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...
 
bool isHeaderClassName (const word &clsName) const
 Test if headerClassName() equals the given class name. More...
 
template<class Type >
bool isHeaderClassName () const
 Test if headerClassName() equals Type::typeName. More...
 
readOption readOpt () const noexcept
 The read option. More...
 
readOption readOpt (readOption opt) noexcept
 Change the read option, return previous value. More...
 
writeOption writeOpt () const noexcept
 The write option. More...
 
writeOption writeOpt (writeOption opt) noexcept
 Change the write option, return previous value. More...
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const noexcept
 
fileNameinstance () noexcept
 
const fileNamelocal () const noexcept
 
fileName path () const
 The complete path. More...
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 The complete path with alternative instance and local. More...
 
fileName objectPath () const
 The complete 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
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches up if in parallel. More...
 
IOstreamOption parseHeader (const dictionary &headerDict)
 
bool readHeader (Istream &is)
 
bool readHeader (dictionary &headerDict, Istream &is)
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 Read header (uses typeFilePath to find file) and check its info. 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
 
void writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
 
bool good () const noexcept
 
bool bad () const noexcept
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &io)
 
readOptionreadOpt () noexcept
 Access to the read option. More...
 
writeOptionwriteOpt () noexcept
 Access to the write option. More...
 
boolregisterObject () noexcept
 Access to the register object option. More...
 
boolglobalObject () noexcept
 Access to the global object option. More...
 
template<>
bool isHeaderClassName () const
 Specialization for void always returns true (no headerClassName check). More...
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 
- Public Member Functions inherited from HashTable< regIOobject * >
 HashTable ()
 Default construct with default (128) table capacity. More...
 
 HashTable (const label size)
 Construct given initial table capacity. More...
 
 HashTable (Istream &is, const label size=128)
 Construct from Istream with default table capacity. More...
 
 HashTable (const this_type &ht)
 Copy construct. More...
 
 HashTable (this_type &&rhs)
 Move construct. More...
 
 HashTable (std::initializer_list< std::pair< word, regIOobject * >> list)
 Construct from an initializer list. More...
 
 ~HashTable ()
 Destructor. More...
 
label capacity () const noexcept
 The size of the underlying table. More...
 
label size () const noexcept
 The number of elements in table. More...
 
bool empty () const noexcept
 True if the hash table is empty. 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 found (const word &key) const
 Return true if hashed entry is 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
 
Foam::List< wordsortedToc (const Compare &comp) const
 
List< wordtocKeys (const UnaryPredicate &pred, const bool invert=false) const
 
Foam::List< wordtocKeys (const UnaryPredicate &pred, const bool invert) const
 
List< wordtocValues (const UnaryPredicate &pred, const bool invert=false) const
 
Foam::List< wordtocValues (const UnaryPredicate &pred, const bool invert) const
 
List< wordtocEntries (const BinaryPredicate &pred, const bool invert=false) const
 
Foam::List< wordtocEntries (const BinaryPredicate &pred, const bool invert) const
 
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 resize (const label sz)
 Resize the hash table for efficiency. More...
 
void clear ()
 Clear all entries from table. More...
 
void clearStorage ()
 Clear the table entries and the table itself. More...
 
void swap (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs)
 Swap contents into this table. More...
 
void transfer (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs)
 Transfer contents into this table. 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
 
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
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState : char { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. 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 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 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 an 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 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...
 
- Public Attributes inherited from HashTable< regIOobject * >
const typedef regIOobject * * const_pointer
 Const pointer type for the stored value_type. More...
 
const typedef regIOobject * & const_reference
 Const reference to the stored value_type. 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...
 
- 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...
 
- Protected Member Functions inherited from HashTable< regIOobject * >
bool iterator_erase (node_type *&entry, label &index)
 Low-level entry erasure using iterator internals. More...
 
- Static Protected Member Functions inherited from IOobject
static void writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
 
static void writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
 
- 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 60 of file objectRegistry.H.

Constructor & Destructor Documentation

◆ objectRegistry() [1/2]

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

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

Definition at line 82 of file objectRegistry.C.

◆ objectRegistry() [2/2]

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

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

Definition at line 105 of file objectRegistry.C.

References IOobject::AUTO_WRITE, and IOobject::writeOpt().

Here is the call graph for this function:

◆ ~objectRegistry()

~objectRegistry ( )
virtual

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

Definition at line 120 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 166 of file objectRegistry.H.

◆ parent()

const objectRegistry& parent ( ) const
inlinenoexcept

Return the parent objectRegistry.

Definition at line 172 of file objectRegistry.H.

◆ time()

const Time& time ( ) const
inlinenoexcept

Return time registry.

Definition at line 178 of file objectRegistry.H.

Referenced by mappedPatchBase::addWorldConnection(), minTimeStepCondition::apply(), equationMaxIterCondition::apply(), maxDurationCondition::apply(), averageCondition::apply(), SprayParcel< ParcelType >::calcAtomization(), fieldAverageItem::calculateMeanField(), fieldAverageItem::calculatePrime2MeanField(), cyclicAMIPolyPatch::canResetAMI(), timeVaryingMappedFixedValuePointPatchField< Type >::checkTable(), codedBase::codeDict(), logFiles::createFiles(), cloud::createIOField(), exprResultGlobals::Delete(), equationInitialResidualCondition::equationInitialResidualCondition(), fieldAverageItem::evolve(), faMesh::faMesh(), coupleGroupIdentifier::findOtherPatchID(), mappedPatchBase::getWorldCommunicator(), DSMCParcel< ParcelType >::hitWallPatch(), codedPoints0MotionSolver::libs(), mappedPatchBase::lookupMesh(), mappedVariableThicknessWallFvPatch::makeDeltaCoeffs(), Foam::MapLagrangianFields(), Foam::MapMesh(), meshReader::mesh(), triSurfaceMesh::movePoints(), lumpedPointIOMovement::New(), exprResultGlobals::New(), coordinateSystems::New(), GAMGAgglomeration::New(), objectiveManager::objectiveManager(), motionSolver::iNew::operator()(), points0MotionSolver::points0IO(), polyMesh::polyMesh(), uncollatedFileOperation::readObjects(), masterUncollatedFileOperation::readObjects(), polyMesh::readUpdate(), regionProperties::regionProperties(), triSurfaceMesh::setField(), twoPhaseSystem::solve(), multiphaseSystem::solve(), RASTurbulenceModel::solveIter(), patchFunction1Base::time(), fvMesh::time(), IOobject::time(), MPPICParcel< ParcelType >::trackingData::updateAverages(), KinematicParcel< ParcelType >::trackingData::updateAverages(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), velocityFilmShellFvPatchVectorField::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 128 of file objectRegistry.C.

◆ dbDir()

virtual const fileName& dbDir ( ) const
inlinevirtual

Local directory path of this objectRegistry relative to the time.

Reimplemented in polyMesh, and Time.

Definition at line 187 of file objectRegistry.H.

Referenced by polyMesh::dbDir(), uncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::filePathInfo(), masterUncollatedFileOperation::localObjectPath(), 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 134 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.

◆ 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 140 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 names of all objects.

Definition at line 147 of file objectRegistry.C.

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

Referenced by vtkUnstructuredReader::printFieldStats(), 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 names of objects with the given class name.

Note
uses the class type() method

Definition at line 159 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 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 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 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 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 153 of file objectRegistry.C.

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

Referenced by parseDriver::getField(), parseDriver::patchInternalField(), parseDriver::patchNeighbourField(), parseDriver::patchNormalField(), multiRegion::read(), areaWrite::read(), vtkWrite::writeVolFields(), and ensightWrite::writeVolFields().

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 166 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 174 of file objectRegistry.C.

References Foam::name(), IOobject::NO_READ, IOobject::NO_WRITE, 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/4]

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

Return all objects with a class satisfying isA<Type>

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

Referenced by meshObject::clear(), meshObject::clearUpto(), coupleGroupIdentifier::findOtherPatchID(), surfaceInterpolate::interpolateFields(), basicThermo::lookupThermo(), meshObject::movePoints(), areaWrite::read(), and meshObject::updateMesh().

Here is the caller graph for this function:

◆ lookupClass() [2/4]

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

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 411 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:

◆ found()

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

Can the regIOobject object be found (by name).

Parameters
recursivesearch parent registries

Definition at line 432 of file objectRegistry.C.

References Foam::name().

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:

◆ foundObject()

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

◆ cfindObject()

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

Return 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 390 of file objectRegistryTemplates.C.

References Foam::name().

Referenced by fvExprDriver::evaluateVariableRemote(), polySurface::findFieldObject(), cloud::findIOField(), cloud::findIOPosition(), fluxSummary::initialiseSurface(), fluxSummary::initialiseSurfaceAndDirection(), GAMGAgglomeration::New(), regionFunctionObject::obr(), lumpedPointDisplacementPointPatchVectorField::points0(), heatTransferCoeffModel::q(), propellerInfo::setRotationalSpeed(), and triSurfaceMeshPointSet::triSurfaceMeshPointSet().

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

◆ findObject() [1/2]

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

◆ 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 412 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 423 of file objectRegistryTemplates.C.

References Foam::name().

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

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 434 of file objectRegistryTemplates.C.

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

Referenced by solidAbsorption::a(), interRegionHeatTransferModel::addSup(), adjointSimple::adjointSimple(), DEShybrid< Type >::blendingFactor(), Foam::calc_pTotal(), Foam::calc_rhoU(), ObukhovLength::calcOL(), parcelSelection::calculateFilter(), tabulatedHeatTransfer::calculateHtc(), variableHeatTransfer::calculateHtc(), fieldAverageItem::calculateMeanField(), fieldAverageItem::calculatePrime2MeanField(), adjointSensitivity::computeGradDxDbMultiplier(), motionDirectionalDiffusivity::correct(), filmTurbulenceModel::devRhoReff(), solidAbsorption::e(), interfaceTrackingFvMesh::freeSurfacePressureJump(), interfaceTrackingFvMesh::freeSurfaceSnGradU(), adjointSolver::getPrimalSolver(), interRegionExplicitPorositySource::initialise(), phaseSystem::lookupBlendedSubModel(), cloud::lookupIOField(), mappedPatchBase::lookupMesh(), twoPhaseSystem::lookupSubModel(), phaseSystem::lookupSubModel(), basicThermo::lookupThermo(), mappedVariableThicknessWallFvPatch::makeDeltaCoeffs(), regionModel::mapRegionPatchField(), regionModel::mapRegionPatchInternalField(), function1Base::mesh(), solidParticleCloud::move(), displacementMotionSolverMeshMover::move(), medialAxisMeshMover::move(), solidAbsorption::nBands(), surfaceFieldValue::obr(), liquidFilmBase::pg(), pointHistory::pointHistory(), hydrostaticPressure::pRef(), vtkUnstructuredReader::printFieldStats(), particleDistribution::processField(), heatTransferCoeffModel::q(), filmTurbulenceModel::rho(), ReynoldsAnalogy::rho(), VollerPrakash::S(), patchProbes::sample(), interRegionOption::setMapper(), interRegionHeatTransferModel::setNbrModel(), sixDoFRigidBodyMotionSolver::solve(), rigidBodyMeshMotionSolver::solve(), rigidBodyMeshMotion::solve(), liquidFilmBase::Up(), freeSurfaceVelocityFvPatchVectorField::updateCoeffs(), inclinedFilmNusseltHeightFvPatchScalarField::updateCoeffs(), inclinedFilmNusseltInletVelocityFvPatchVectorField::updateCoeffs(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), vibrationShellFvPatchScalarField::updateCoeffs(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::updateCoeffs(), mappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), freeSurfacePressureFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), cloudInfo::write(), momentumError::write(), and cellCellStencil::zoneID().

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 478 of file objectRegistryTemplates.C.

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

Referenced by heatTransferCoeff::calc(), momentumError::calcMomentError(), fieldAverageItem::calculateMeanField(), fieldAverageItem::calculatePrime2MeanField(), relaxedSnGrad< Type >::correction(), surfaceDistance::execute(), searchableSurfaceCollection::searchableSurfaceCollection(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), thermalShellFvPatchScalarField::updateCoeffs(), and velocityFilmShellFvPatchVectorField::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 200 of file objectRegistry.C.

References Foam::expressions::patchExpr::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 226 of file objectRegistry.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), HashTable< T, Key, Hash >::insert(), 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 300 of file objectRegistry.C.

◆ checkOut() [1/3]

bool checkOut ( regIOobject io) const

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

Definition at line 254 of file objectRegistry.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), objectRegistry::erase(), HashTable< T, Key, Hash >::find(), Foam::name(), IOobject::name(), Foam::Pout, and WarningInFunction.

Referenced by meshObject::clear(), fieldAverageItem::clear(), timeFunctionObject::clearOutputObjects(), meshObject::clearUpto(), exprResultGlobals::Delete(), fieldAverageItem::evolve(), meshObject::movePoints(), sampledSurface::removeRegistrySurface(), sampledSurface::removeSurfMesh(), and meshObject::updateMesh().

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

◆ checkOut() [2/3]

bool checkOut ( regIOobject io) const

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

Definition at line 306 of file objectRegistry.C.

◆ 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 312 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 318 of file objectRegistry.C.

References stdFoam::begin(), HashTable< T, Key, Hash >::clear(), Foam::expressions::patchExpr::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 344 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 351 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 374 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 380 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 386 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 392 of file objectRegistry.C.

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

Here is the call 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 441 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 455 of file objectRegistry.C.

References stdFoam::begin(), Foam::expressions::patchExpr::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 471 of file objectRegistry.C.

◆ writeData()

virtual bool writeData ( Ostream ) const
inlinevirtual

writeData function required by regIOobject but not used.

For this class, write is used instead

Implements regIOobject.

Reimplemented in triSurfaceMesh.

Definition at line 519 of file objectRegistry.H.

◆ writeObject()

bool writeObject ( IOstreamOption  streamOpt,
const bool  valid 
) const
virtual

Write the objects using stream options.

Reimplemented from regIOobject.

Reimplemented in distributedTriSurfaceMesh, fvMesh, Time, polySurface, dynamicOversetFvMesh, triSurfaceMesh, surfMesh, and dynamicRefineFvMesh.

Definition at line 479 of file objectRegistry.C.

References stdFoam::cbegin(), stdFoam::cend(), Foam::expressions::patchExpr::debug, Foam::endl(), Foam::name(), and Foam::Pout.

Referenced by Time::writeObject(), and fvMesh::writeObject().

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 540 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 553 of file objectRegistry.H.

References IOobject::name().

Here is the call graph for this function:

◆ classesImpl()

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

Definition at line 38 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 64 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 89 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 117 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 152 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:

◆ classes() [3/3]

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

Definition at line 192 of file objectRegistryTemplates.C.

◆ count() [6/9]

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

Definition at line 202 of file objectRegistryTemplates.C.

◆ count() [7/9]

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

Definition at line 212 of file objectRegistryTemplates.C.

◆ count() [8/9]

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

Definition at line 223 of file objectRegistryTemplates.C.

◆ count() [9/9]

Foam::label count ( const bool  strict) const

Definition at line 233 of file objectRegistryTemplates.C.

References forAllConstIters().

Here is the call graph for this function:

◆ names() [7/10]

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

Definition at line 259 of file objectRegistryTemplates.C.

◆ names() [8/10]

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

Definition at line 269 of file objectRegistryTemplates.C.

◆ names() [9/10]

Foam::wordList names ( ) const

Definition at line 279 of file objectRegistryTemplates.C.

◆ names() [10/10]

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

Definition at line 287 of file objectRegistryTemplates.C.

◆ sortedNames() [7/10]

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

Definition at line 297 of file objectRegistryTemplates.C.

◆ sortedNames() [8/10]

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

Definition at line 307 of file objectRegistryTemplates.C.

◆ sortedNames() [9/10]

Foam::wordList sortedNames ( ) const

Definition at line 317 of file objectRegistryTemplates.C.

◆ sortedNames() [10/10]

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

Definition at line 325 of file objectRegistryTemplates.C.

◆ lookupClass() [3/4]

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

Definition at line 335 of file objectRegistryTemplates.C.

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

Here is the call graph for this function:

◆ lookupClass() [4/4]

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

Definition at line 357 of file objectRegistryTemplates.C.

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

Here is the call graph for this function:

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