OpenFOAM-dev / data /src /OpenFOAM /global /fileOperations /uncollatedFileOperation /uncollatedFileOperation.H
| /*---------------------------------------------------------------------------*\ | |
| ========= | | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | |
| \\ / O peration | Website: https://openfoam.org | |
| \\ / A nd | Copyright (C) 2017-2025 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::fileOperations::uncollatedFileOperation | |
| Description | |
| fileOperation that assumes file operations are local. | |
| \*---------------------------------------------------------------------------*/ | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| namespace Foam | |
| { | |
| namespace fileOperations | |
| { | |
| /*---------------------------------------------------------------------------*\ | |
| Class uncollatedFileOperation Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| class uncollatedFileOperation | |
| : | |
| public fileOperation | |
| { | |
| // Private Member Functions | |
| //- Search for an object. | |
| // globalFile : also check undecomposed case | |
| // isFile : true:check for file false:check for directory | |
| fileName filePathInfo | |
| ( | |
| const bool globalFile, | |
| const bool isFile, | |
| const IOobject& | |
| ) const; | |
| public: | |
| //- Runtime type information | |
| TypeName("uncollated"); | |
| // Constructors | |
| //- Construct null | |
| uncollatedFileOperation(const bool verbose); | |
| //- Destructor | |
| virtual ~uncollatedFileOperation(); | |
| // Member Functions | |
| // OSSpecific equivalents | |
| //- Make directory | |
| virtual bool mkDir(const fileName&, mode_t=0777) const; | |
| //- Set the file mode | |
| virtual bool chMod(const fileName&, const mode_t) const; | |
| //- Return the file mode | |
| virtual mode_t mode | |
| ( | |
| const fileName&, | |
| const bool checkVariants = true, | |
| const bool followLink = true | |
| ) const; | |
| //- Return the file type: directory, file or link | |
| virtual fileType type | |
| ( | |
| const fileName&, | |
| const bool checkVariants = true, | |
| const bool followLink = true | |
| ) const; | |
| //- Does the name exist (as directory or file) in the file system? | |
| // Optionally enable/disable check for gzip file. | |
| virtual bool exists | |
| ( | |
| const fileName&, | |
| const bool checkVariants = true, | |
| const bool followLink = true | |
| ) const; | |
| //- Does the name exist as a directory in the file system? | |
| virtual bool isDir | |
| ( | |
| const fileName&, | |
| const bool followLink = true | |
| ) const; | |
| //- Does the name exist as a FILE in the file system? | |
| // Optionally enable/disable check for gzip file. | |
| virtual bool isFile | |
| ( | |
| const fileName&, | |
| const bool checkVariants = true, | |
| const bool followLink = true | |
| ) const; | |
| //- Return size of file | |
| virtual off_t fileSize | |
| ( | |
| const fileName&, | |
| const bool checkVariants = true, | |
| const bool followLink = true | |
| ) const; | |
| //- Return time of last file modification | |
| virtual time_t lastModified | |
| ( | |
| const fileName&, | |
| const bool checkVariants = true, | |
| const bool followLink = true | |
| ) const; | |
| //- Return time of last file modification | |
| virtual double highResLastModified | |
| ( | |
| const fileName&, | |
| const bool checkVariants = true, | |
| const bool followLink = true | |
| ) const; | |
| //- Read a directory and return the entries as a string list | |
| virtual fileNameList readDir | |
| ( | |
| const fileName&, | |
| const fileType = fileType::file, | |
| const bool filtergz=true, | |
| const bool followLink = true | |
| ) const; | |
| //- Copy, recursively if necessary, the source to the destination | |
| virtual bool cp | |
| ( | |
| const fileName& src, | |
| const fileName& dst, | |
| const bool followLink = true | |
| ) const; | |
| //- Create a softlink. dst should not exist. Returns true if | |
| // successful. | |
| virtual bool ln(const fileName& src, const fileName& dst) const; | |
| //- Rename src to dst | |
| virtual bool mv | |
| ( | |
| const fileName& src, | |
| const fileName& dst, | |
| const bool followLink = false | |
| ) const; | |
| //- Rename to a corresponding backup file | |
| // If the backup file already exists, attempt with | |
| // "01" .. "99" suffix | |
| virtual bool mvBak | |
| ( | |
| const fileName&, | |
| const std::string& ext = "bak" | |
| ) const; | |
| //- Remove a file, returning true if successful otherwise false | |
| virtual bool rm(const fileName&) const; | |
| //- Remove a directory and its contents | |
| virtual bool rmDir(const fileName&) const; | |
| // (reg)IOobject functionality | |
| //- Search for an object. globalFile : also check undecomposed case | |
| virtual fileName filePath | |
| ( | |
| const bool globalFile, | |
| const IOobject& | |
| ) const; | |
| //- Search for a directory. globalFile : also check undecomposed | |
| // case | |
| virtual fileName dirPath | |
| ( | |
| const bool globalFile, | |
| const IOobject& | |
| ) const; | |
| //- Search directory for objects. Used in IOobjectList. | |
| virtual fileNameList readObjects | |
| ( | |
| const objectRegistry& db, | |
| const fileName& instance, | |
| const fileName& local, | |
| word& newInstance | |
| ) const; | |
| //- Read object header from supplied file | |
| virtual bool readHeader | |
| ( | |
| IOobject&, | |
| const fileName&, | |
| const word& typeName | |
| ) const; | |
| //- Reads header for regIOobject and returns an ISstream | |
| // to read the contents. | |
| virtual autoPtr<ISstream> readStream | |
| ( | |
| regIOobject&, | |
| const fileName&, | |
| const word& typeName, | |
| const bool read = true | |
| ) const; | |
| //- Top-level read | |
| // Format set to ASCII if defaultFormat and file format are ASCII | |
| virtual bool read | |
| ( | |
| regIOobject&, | |
| const bool masterOnly, | |
| const IOstream::streamFormat defaultFormat, | |
| const word& typeName | |
| ) const; | |
| //- Generate an ISstream that reads a file | |
| virtual autoPtr<ISstream> NewIFstream | |
| ( | |
| const fileName& filePath, | |
| IOstream::streamFormat format=IOstream::ASCII, | |
| IOstream::versionNumber version=IOstream::currentVersion | |
| ) const; | |
| //- Generate an Ostream that writes a file | |
| virtual autoPtr<Ostream> NewOFstream | |
| ( | |
| const fileName& filePath, | |
| IOstream::streamFormat format=IOstream::ASCII, | |
| IOstream::versionNumber version=IOstream::currentVersion, | |
| IOstream::compressionType compression=IOstream::UNCOMPRESSED, | |
| const bool write = true | |
| ) const; | |
| }; | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| } // End namespace fileOperations | |
| } // End namespace Foam | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |