| /*---------------------------------------------------------------------------*\ | |
| ========= | | |
| \\ / F ield | OpenFOAM: The Open Source CFD Toolbox | |
| \\ / O peration | Website: https://openfoam.org | |
| \\ / A nd | Copyright (C) 2011-2024 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::IFstream | |
| Description | |
| Input from file stream. | |
| SourceFiles | |
| IFstream.C | |
| \*---------------------------------------------------------------------------*/ | |
| using std::ifstream; | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| namespace Foam | |
| { | |
| class IFstream; | |
| /*---------------------------------------------------------------------------*\ | |
| Class IFstreamAllocator Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| //- A std::istream with ability to handle compressed files | |
| class IFstreamAllocator | |
| { | |
| friend class IFstream; | |
| // Private Data | |
| istream* ifPtr_; | |
| IOstream::compressionType compression_; | |
| // Constructors | |
| //- Construct from filePath | |
| IFstreamAllocator(const fileName& filePath); | |
| //- Destructor | |
| ~IFstreamAllocator(); | |
| }; | |
| /*---------------------------------------------------------------------------*\ | |
| Class IFstream Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| class IFstream | |
| : | |
| public IFstreamAllocator, | |
| public ISstream | |
| { | |
| // Private Data | |
| fileName filePath_; | |
| public: | |
| // Declare name of the class and its debug switch | |
| ClassName("IFstream"); | |
| // Constructors | |
| //- Construct from filePath | |
| IFstream | |
| ( | |
| const fileName& filePath, | |
| const streamFormat format = ASCII, | |
| const versionNumber version = currentVersion | |
| ); | |
| //- Destructor | |
| ~IFstream(); | |
| // Member Functions | |
| // Access | |
| //- Return the name of the stream | |
| const fileName& name() const | |
| { | |
| return filePath_; | |
| } | |
| //- Return non-const access to the name of the stream | |
| fileName& name() | |
| { | |
| return filePath_; | |
| } | |
| // STL stream | |
| //- Access to underlying std::istream | |
| virtual istream& stdStream(); | |
| //- Const access to underlying std::istream | |
| virtual const istream& stdStream() const; | |
| //- Print description of IOstream to Ostream | |
| virtual void print(Ostream&) const; | |
| // Member Operators | |
| //- Return a non-const reference to const IFstream | |
| // Needed for read-constructors where the stream argument is temporary: | |
| // e.g. thing thisThing(IFstream("thingFileName")()); | |
| IFstream& operator()() const; | |
| }; | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| } // End namespace Foam | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |