src/OpenFOAM/db/IOstreams/Sstreams/OSstream.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::OSstream
  27
  28 Description
  29     Generic output stream.
  30
  31 SourceFiles
  32     OSstreamI.H
  33     OSstream.C
  34     chkStream.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef OSstream_H
  39 #define OSstream_H
  40
  41 #include "Ostream.H"
  42 #include "fileName.H"
  43 #include <iostream>
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                           Class OSstream Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class OSstream
  55 :
  56     public Ostream
  57 {
  58     // Private data
  59
  60         fileName name_;
  61         ostream& os_;
  62
  63
  64     // Private Member Functions
  65
  66         //- Disallow default bitwise assignment
  67         void operator=(const OSstream&);
  68
  69
  70 protected:
  71
  72         //- Return the stream reference
  73         ostream& stream()
  74         {
  75             return os_;
  76         }
  77
  78         //- Return the const stream reference
  79         const ostream& stream() const
  80         {
  81             return os_;
  82         }
  83
  84
  85 public:
  86
  87     // Constructors
  88
  89         //- Set stream status
  90         OSstream
  91         (
  92             ostream& os,
  93             const string& name,
  94             streamFormat format=ASCII,
  95             versionNumber version=currentVersion,
  96             compressionType compression=UNCOMPRESSED
  97         );
  98
  99
 100     // Member functions
 101
 102         // Enquiry
 103
 104             //- Return the name of the stream
 105             //  Useful for Fstream to return the filename
 106             virtual const fileName& name() const
 107             {
 108                 return name_;
 109             }
 110
 111             //- Return non-const access to the name of the stream
 112             //  Useful to alter the stream name
 113             virtual fileName& name()
 114             {
 115                 return name_;
 116             }
 117
 118             //- Return flags of output stream
 119             virtual ios_base::fmtflags flags() const;
 120
 121
 122         // Write functions
 123
 124             //- Write next token to stream
 125             virtual Ostream& write(const token&);
 126
 127             //- Write character
 128             virtual Ostream& write(const char);
 129
 130             //- Write character string
 131             virtual Ostream& write(const char*);
 132
 133             //- Write word
 134             virtual Ostream& write(const word&);
 135
 136             //- Write string
 137             //  In the rare case that the string contains a final trailing
 138             //  backslash, it will be dropped to the appearance of an escaped
 139             //  double-quote.
 140             virtual Ostream& write(const string&);
 141
 142             //- Write std::string surrounded by quotes.
 143             //  Optional write without quotes.
 144             virtual Ostream& writeQuoted
 145             (
 146                 const std::string&,
 147                 const bool quoted=true
 148             );
 149
 150             //- Write label
 151             virtual Ostream& write(const label);
 152
 153             //- Write floatScalar
 154             virtual Ostream& write(const floatScalar);
 155
 156             //- Write doubleScalar
 157             virtual Ostream& write(const doubleScalar);
 158
 159             //- Write binary block
 160             virtual Ostream& write(const char*, std::streamsize);
 161
 162             //- Add indentation characters
 163             virtual void indent();
 164
 165
 166         // Stream state functions
 167
 168             //- Set flags of output stream
 169             virtual ios_base::fmtflags flags(const ios_base::fmtflags flags);
 170
 171             //- Flush stream
 172             virtual void flush();
 173
 174             //- Add newline and flush stream
 175             virtual void endl();
 176
 177             //- Get width of output field
 178             virtual int width() const;
 179
 180             //- Set width of output field (and return old width)
 181             virtual int width(const int);
 182
 183             //- Get precision of output field
 184             virtual int precision() const;
 185
 186             //- Set precision of output field (and return old precision)
 187             virtual int precision(const int);
 188
 189
 190         // Print
 191
 192             //- Print description of IOstream to Ostream
 193             virtual void print(Ostream&) const;
 194 };
 195
 196
 197 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 198
 199 } // End namespace Foam
 200
 201 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 202
 203 #include "OSstreamI.H"
 204
 205 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 206
 207 #endif
 208
 209 // ************************************************************************* //