src/OpenFOAM/db/IOstreams/Sstreams/prefixOSstream.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::prefixOSstream
  27
  28 Description
  29     Version of OSstream which prints a prefix on each line.
  30
  31     This is useful for running in parallel as it allows the processor number
  32     to be automatically prepended to each message line.
  33
  34 SourceFiles
  35     prefixOSstream.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef prefixOSstream_H
  40 #define prefixOSstream_H
  41
  42 #include "OSstream.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class prefixOSstream Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class prefixOSstream
  54 :
  55     public OSstream
  56 {
  57     // Private data
  58
  59         bool printPrefix_;
  60         string prefix_;
  61
  62
  63     // Private member functions
  64
  65         inline void checkWritePrefix();
  66
  67
  68 public:
  69
  70     // Constructors
  71
  72         //- Set stream status
  73         prefixOSstream
  74         (
  75             ostream& os,
  76             const string& name,
  77             streamFormat format=ASCII,
  78             versionNumber version=currentVersion,
  79             compressionType compression=UNCOMPRESSED
  80         );
  81
  82
  83     // Member functions
  84
  85         // Enquiry
  86
  87             //- Return the prefix of the stream
  88             const string& prefix() const
  89             {
  90                 return prefix_;
  91             }
  92
  93             //- Return non-const access to the prefix of the stream
  94             string& prefix()
  95             {
  96                 return prefix_;
  97             }
  98
  99
 100         // Write functions
 101
 102             //- Write next token to stream
 103             virtual Ostream& write(const token&);
 104
 105             //- Write character
 106             virtual Ostream& write(const char);
 107
 108             //- Write character string
 109             virtual Ostream& write(const char*);
 110
 111             //- Write word
 112             virtual Ostream& write(const word&);
 113
 114             //- Write string
 115             virtual Ostream& write(const string&);
 116
 117             //- Write std::string surrounded by quotes.
 118             //  Optional write without quotes.
 119             virtual Ostream& writeQuoted
 120             (
 121                 const std::string&,
 122                 const bool quoted=true
 123             );
 124
 125             //- Write label
 126             virtual Ostream& write(const label);
 127
 128             //- Write floatScalar
 129             virtual Ostream& write(const floatScalar);
 130
 131             //- Write doubleScalar
 132             virtual Ostream& write(const doubleScalar);
 133
 134             //- Write binary block
 135             virtual Ostream& write(const char*, std::streamsize);
 136
 137             //- Add indentation characters
 138             virtual void indent();
 139
 140
 141         // Print
 142
 143             //- Print description of IOstream to Ostream
 144             virtual void print(Ostream&) const;
 145 };
 146
 147
 148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 149
 150 } // End namespace Foam
 151
 152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 153
 154 #endif
 155
 156 // ************************************************************************* //