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 held by original author
   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             ios_base::openmode mode,
  71             IOstream::compressionType compression = IOstream::UNCOMPRESSED
  72
  73         );
  74
  75     // Destructor
  76
  77         ~OFstreamAllocator();
  78
  79
  80 public:
  81
  82     // Member functions
  83
  84         //- Access to underlying std::ostream
  85         ostream& stdStream();
  86 };
  87
  88
  89 /*---------------------------------------------------------------------------*\
  90                            Class OFstream Declaration
  91 \*---------------------------------------------------------------------------*/
  92
  93 class OFstream
  94 :
  95     private OFstreamAllocator,
  96     public OSstream
  97 {
  98     // Private data
  99
 100         fileName pathname_;
 101
 102
 103 public:
 104
 105     // Declare name of the class and its debug switch
 106     ClassName("OFstream");
 107
 108
 109     // Constructors
 110
 111         //- Construct from pathname
 112         OFstream
 113         (
 114             const fileName& pathname,
 115             ios_base::openmode mode = ios_base::out|ios_base::trunc,
 116             streamFormat format=ASCII,
 117             versionNumber version=currentVersion,
 118             compressionType compression=UNCOMPRESSED
 119         );
 120
 121
 122     // Destructor
 123
 124         ~OFstream();
 125
 126
 127     // Member functions
 128
 129         // Access
 130
 131             //- Return the name of the stream
 132             const fileName& name() const
 133             {
 134                 return pathname_;
 135             }
 136
 137             //- Return non-const access to the name of the stream
 138             fileName& name()
 139             {
 140                 return pathname_;
 141             }
 142
 143
 144         // Print
 145
 146             //- Print description of IOstream to Ostream
 147             void print(Ostream&) const;
 148 };
 149
 150
 151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 152 // Global predefined null output stream
 153
 154 extern OFstream Snull;
 155
 156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 157
 158 } // End namespace Foam
 159
 160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 161
 162 #endif
 163
 164 // ************************************************************************* //