src/OpenFOAM/db/IOstreams/Fstreams/OFstream.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::OFstream
  27
  28 Description
  29     Output to file stream.
  30
  31 SourceFiles
  32     OFstream.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef OFstream_H
  37 #define OFstream_H
  38
  39 #include "OSstream.H"
  40 #include "fileName.H"
  41 #include "className.H"
  42
  43 #include <fstream>
  44 using std::ofstream;
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 class OFstream;
  52
  53 /*---------------------------------------------------------------------------*\
  54                        Class OFstreamAllocator Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 //- A std::ostream with ability to handle compressed files
  58 class OFstreamAllocator
  59 {
  60     friend class OFstream;
  61
  62     ostream* ofPtr_;
  63
  64     // Constructors
  65
  66         //- Construct from pathname
  67         OFstreamAllocator
  68         (
  69             const fileName& pathname,
  70             IOstream::compressionType compression=IOstream::UNCOMPRESSED
  71         );
  72
  73     // Destructor
  74
  75         ~OFstreamAllocator();
  76
  77
  78 public:
  79
  80     // Member functions
  81
  82         //- Access to underlying std::ostream
  83         ostream& stdStream();
  84 };
  85
  86
  87 /*---------------------------------------------------------------------------*\
  88                            Class OFstream Declaration
  89 \*---------------------------------------------------------------------------*/
  90
  91 class OFstream
  92 :
  93     private OFstreamAllocator,
  94     public OSstream
  95 {
  96     // Private data
  97
  98         fileName pathname_;
  99
 100
 101 public:
 102
 103     // Declare name of the class and its debug switch
 104     ClassName("OFstream");
 105
 106
 107     // Constructors
 108
 109         //- Construct from pathname
 110         OFstream
 111         (
 112             const fileName& pathname,
 113             streamFormat format=ASCII,
 114             versionNumber version=currentVersion,
 115             compressionType compression=UNCOMPRESSED
 116         );
 117
 118
 119     // Destructor
 120
 121         ~OFstream();
 122
 123
 124     // Member functions
 125
 126         // Access
 127
 128             //- Return the name of the stream
 129             const fileName& name() const
 130             {
 131                 return pathname_;
 132             }
 133
 134             //- Return non-const access to the name of the stream
 135             fileName& name()
 136             {
 137                 return pathname_;
 138             }
 139
 140
 141         // Print
 142
 143             //- Print description of IOstream to Ostream
 144             void print(Ostream&) const;
 145 };
 146
 147
 148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 149 // Global predefined null output stream
 150
 151 extern OFstream Snull;
 152
 153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 154
 155 } // End namespace Foam
 156
 157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 158
 159 #endif
 160
 161 // ************************************************************************* //