| /*---------------------------------------------------------------------------*\ | |
| ========= | | |
| \\ / 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::prefixOSstream | |
| Description | |
| Version of OSstream which prints a prefix on each line. | |
| This is useful for running in parallel as it allows the processor number | |
| to be automatically prepended to each message line. | |
| SourceFiles | |
| prefixOSstream.C | |
| \*---------------------------------------------------------------------------*/ | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| namespace Foam | |
| { | |
| /*---------------------------------------------------------------------------*\ | |
| Class prefixOSstream Declaration | |
| \*---------------------------------------------------------------------------*/ | |
| class prefixOSstream | |
| : | |
| public OSstream | |
| { | |
| // Private Data | |
| bool printPrefix_; | |
| string prefix_; | |
| // Private Member Functions | |
| inline void checkWritePrefix(); | |
| public: | |
| // Constructors | |
| //- Set stream status | |
| prefixOSstream | |
| ( | |
| ostream& os, | |
| const string& name, | |
| const streamFormat format = ASCII, | |
| const versionNumber version = currentVersion, | |
| const compressionType compression = UNCOMPRESSED | |
| ); | |
| // Member Functions | |
| // Enquiry | |
| //- Return the prefix of the stream | |
| const string& prefix() const | |
| { | |
| return prefix_; | |
| } | |
| //- Return non-const access to the prefix of the stream | |
| string& prefix() | |
| { | |
| return prefix_; | |
| } | |
| // Write functions | |
| //- Write character | |
| virtual Ostream& write(const char); | |
| //- Write character string | |
| virtual Ostream& write(const char*); | |
| //- Write word | |
| virtual Ostream& write(const word&); | |
| //- Write string | |
| virtual Ostream& write(const string&); | |
| //- Write verbatimString | |
| virtual Ostream& write(const verbatimString&); | |
| //- Write std::string surrounded by quotes. | |
| // Optional write without quotes. | |
| virtual Ostream& writeQuoted | |
| ( | |
| const std::string&, | |
| const bool quoted=true | |
| ); | |
| //- Write int32_t | |
| virtual Ostream& write(const int32_t); | |
| //- Write int64_t | |
| virtual Ostream& write(const int64_t); | |
| //- Write int32_t | |
| virtual Ostream& write(const uint32_t); | |
| //- Write int64_t | |
| virtual Ostream& write(const uint64_t); | |
| //- Write floatScalar | |
| virtual Ostream& write(const floatScalar); | |
| //- Write doubleScalar | |
| virtual Ostream& write(const doubleScalar); | |
| //- Write longDoubleScalar | |
| virtual Ostream& write(const longDoubleScalar); | |
| //- Write binary block | |
| virtual Ostream& write(const char*, std::streamsize); | |
| //- Add indentation characters | |
| virtual void indent(); | |
| //- Print description of IOstream to Ostream | |
| virtual void print(Ostream&) const; | |
| }; | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| } // End namespace Foam | |
| // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // | |
| // ************************************************************************* // | |