| /*---------------------------------------------------------------------------*\ | |
| ========= | | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | |
| \\ / O peration | Website: https://openfoam.org | |
| \\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation | |
| \\/ M anipulation | | |
| ------------------------------------------------------------------------------- | |
| License | |
| This file is part of OpenFOAM. | |
| OpenFOAM is free software: you can redistribute it and/or modify it | |
| under the terms of the GNU General Public License as published by | |
| the Free Software Foundation, either version 3 of the License, or | |
| (at your option) any later version. | |
| OpenFOAM is distributed in the hope that it will be useful, but WITHOUT | |
| ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| for more details. | |
| You should have received a copy of the GNU General Public License | |
| along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. | |
| Class | |
| Foam::regIOobject | |
| Description | |
| regIOobject is an abstract class derived from IOobject to handle | |
| automatic object registration with the objectRegistry. | |
| SourceFiles | |
| regIOobject.C | |
| regIOobjectRead.C | |
| regIOobjectWrite.C | |
| \*---------------------------------------------------------------------------*/ | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| namespace Foam | |
| { | |
| /*---------------------------------------------------------------------------*\ | |
| Class regIOobject Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| class regIOobject | |
| : | |
| public IOobject | |
| { | |
| // Private Data | |
| //- Is this object registered with the registry | |
| bool registered_; | |
| //- Is this object owned by the registry | |
| bool ownedByRegistry_; | |
| //- List of modification watch indices | |
| mutable labelList watchIndices_; | |
| //- eventNo of last update | |
| uint64_t eventNo_; | |
| //- Istream for reading | |
| autoPtr<ISstream> isPtr_; | |
| // Private Member Functions | |
| //- Return Istream | |
| Istream& readStream(const bool read = true); | |
| protected: | |
| // Protected Member Functions | |
| //- Read header, check readOpt flags and read data if necessary. | |
| // Format is set to ASCII if defaultFormat and file format are ASCII | |
| bool readHeaderOk | |
| ( | |
| const IOstream::streamFormat defaultFormat, | |
| const word& typeName | |
| ); | |
| public: | |
| // Static data | |
| //- Runtime type information | |
| TypeName("regIOobject"); | |
| static float fileModificationSkew; | |
| // Constructors | |
| //- Construct from IOobject. Optional flag for if IOobject is the | |
| // top level regIOobject. | |
| regIOobject(const IOobject&, const bool isTime = false); | |
| //- Construct from IOobject with new name, and overriding the | |
| // IOobject's register object setting | |
| regIOobject(const word& newName, const IOobject&, bool registerObject); | |
| //- Copy constructor | |
| regIOobject(const regIOobject&); | |
| //- Move constructor | |
| // Registers copy if the object is registered | |
| regIOobject(regIOobject&&); | |
| //- Copy constructor, transferring registry registration to copy | |
| // if registerCopy is true | |
| regIOobject(const regIOobject&, bool registerCopy); | |
| //- Destructor | |
| virtual ~regIOobject(); | |
| // Member Functions | |
| // Path components | |
| //- Return true if object is global, i.e. same for all processors | |
| // Defaults to false, must be overridden by global IO classes | |
| virtual bool global() const; | |
| //- Return true if object is global, i.e. same for all processors | |
| // and written to the global case directory, | |
| // i.e. not the processor time directory | |
| // Defaults to global() | |
| virtual bool globalFile() const; | |
| using IOobject::caseName; | |
| const fileName& caseName() const; | |
| using IOobject::path; | |
| //- Return complete path | |
| fileName path() const; | |
| using IOobject::objectPath; | |
| //- Return complete path + object name | |
| fileName objectPath() const | |
| { | |
| return path()/name(); | |
| } | |
| using IOobject::filePath; | |
| //- Return complete path + object name if the file exists | |
| // in the case directory otherwise null. | |
| // | |
| // For global objects in parallel searches up into the global | |
| // case directory | |
| fileName filePath() const; | |
| // Registration | |
| //- Add object to registry | |
| bool checkIn(); | |
| //- Remove object from registry | |
| bool checkOut(); | |
| //- Add file watch on object (if registered and READ_IF_MODIFIED) | |
| void addWatch(); | |
| //- Is this object registered with the registry? | |
| inline bool registered() const; | |
| //- Is this object owned by the registry? | |
| inline bool ownedByRegistry() const; | |
| //- Transfer ownership of this object to its registry | |
| inline void store(); | |
| //- Transfer ownership of the given object pointer to its registry | |
| // and return reference to object. | |
| template<class Type> | |
| inline static Type& store(Type*); | |
| //- Transfer ownership of the given object pointer to its registry | |
| // and return reference to object. | |
| template<class Type> | |
| inline static Type& store(autoPtr<Type>&); | |
| //- Release ownership of this object from its registry | |
| inline void release(); | |
| // Dependency checking | |
| //- Event number at last update. | |
| inline uint64_t eventNo() const; | |
| //- Event number at last update. | |
| inline uint64_t& eventNo(); | |
| //- Return true if up-to-date with respect to given object | |
| // otherwise false | |
| bool upToDate(const regIOobject&) const; | |
| //- Return true if up-to-date with respect to given objects | |
| // otherwise false | |
| bool upToDate | |
| ( | |
| const regIOobject&, | |
| const regIOobject& | |
| ) const; | |
| //- Return true if up-to-date with respect to given objects | |
| // otherwise false | |
| bool upToDate | |
| ( | |
| const regIOobject&, | |
| const regIOobject&, | |
| const regIOobject& | |
| ) const; | |
| //- Return true if up-to-date with respect to given objects | |
| // otherwise false | |
| bool upToDate | |
| ( | |
| const regIOobject&, | |
| const regIOobject&, | |
| const regIOobject&, | |
| const regIOobject& | |
| ) const; | |
| //- Set up to date (obviously) | |
| void setUpToDate(); | |
| // Edit | |
| //- Rename | |
| virtual void rename(const word& newName); | |
| // Reading | |
| //- Read and check header info | |
| bool headerOk(); | |
| //- Return Istream and check object type against that given | |
| Istream& readStream(const word&, const bool read = true); | |
| //- Close Istream | |
| void close(); | |
| //- Virtual readData function. | |
| // Must be defined in derived types for which | |
| // re-reading is required | |
| virtual bool readData(Istream&); | |
| //- Read object | |
| virtual bool read(); | |
| //- Return file-monitoring handles | |
| inline const labelList& watchIndices() const; | |
| //- Return file-monitoring handles | |
| inline labelList& watchIndices(); | |
| //- Return true if the object's file (or files for objectRegistry) | |
| // have been modified. (modified state is cached by Time) | |
| virtual bool modified() const; | |
| //- Return true if the object's dependencies have been modified | |
| virtual bool dependenciesModified() const | |
| { | |
| return false; | |
| } | |
| //- Read object if modified (as set by call to modified) | |
| virtual bool readIfModified(); | |
| // Writing | |
| //- Pure virtual writaData function. | |
| // Must be defined in derived types | |
| virtual bool writeData(Ostream&) const = 0; | |
| //- Write using given format, version and compression | |
| virtual bool writeObject | |
| ( | |
| IOstream::streamFormat, | |
| IOstream::versionNumber, | |
| IOstream::compressionType, | |
| const bool write | |
| ) const; | |
| //- Write using setting from DB | |
| virtual bool write(const bool write = true) const; | |
| // Member Operators | |
| //- Assign to IOobject | |
| void operator=(const IOobject&) = delete; | |
| //- Disallow default assignment | |
| void operator=(const regIOobject&) = delete; | |
| }; | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| } // End namespace Foam | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |