src/OpenFOAM/db/IOstreams/Pstreams/UOPstream.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::UOPstream
  26
  27 Description
  28     Output inter-processor communications stream operating on external
  29     buffer.
  30
  31 SourceFiles
  32     UOPstream.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #include "Pstream.H"
  37
  38 #ifndef UOPstream_H
  39 #define UOPstream_H
  40
  41 #include "UPstream.H"
  42 #include "Ostream.H"
  43 #include "DynamicList.H"
  44 #include "PstreamBuffers.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                           Class UOPstream Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class UOPstream
  56 :
  57     public UPstream,
  58     public Ostream
  59 {
  60     // Private data
  61
  62         int toProcNo_;
  63
  64         DynamicList<char>& sendBuf_;
  65
  66         const int tag_;
  67
  68         const bool sendAtDestruct_;
  69
  70
  71     // Private Member Functions
  72
  73         //- Write a T to the transfer buffer
  74         template<class T>
  75         inline void writeToBuffer(const T&);
  76
  77         //- Write a char to the transfer buffer
  78         inline void writeToBuffer(const char&);
  79
  80         //- Write data to the transfer buffer
  81         inline void writeToBuffer(const void* data, size_t count, size_t align);
  82
  83
  84 public:
  85
  86     // Constructors
  87
  88         //- Construct given process index to send to and optional buffer size,
  89         //  write format and IO version
  90         UOPstream
  91         (
  92             const commsTypes commsType,
  93             const int toProcNo,
  94             DynamicList<char>& sendBuf,
  95             const int tag = UPstream::msgType(),
  96             const bool sendAtDestruct = true,
  97             streamFormat format=BINARY,
  98             versionNumber version=currentVersion
  99         );
 100
 101         //- Construct given buffers
 102         UOPstream(const int toProcNo, PstreamBuffers&);
 103
 104
 105     //- Destructor
 106     ~UOPstream();
 107
 108
 109     // Member functions
 110
 111         // Inquiry
 112
 113             //- Return flags of output stream
 114             ios_base::fmtflags flags() const
 115             {
 116                 return ios_base::fmtflags(0);
 117             }
 118
 119
 120         // Write functions
 121
 122             //- Write given buffer to given processor
 123             static bool write
 124             (
 125                 const commsTypes commsType,
 126                 const int toProcNo,
 127                 const char* buf,
 128                 const std::streamsize bufSize,
 129                 const int tag = UPstream::msgType()
 130             );
 131
 132             //- Write next token to stream
 133             Ostream& write(const token&);
 134
 135             //- Write character
 136             Ostream& write(const char);
 137
 138             //- Write character string
 139             Ostream& write(const char*);
 140
 141             //- Write word
 142             Ostream& write(const word&);
 143
 144             //- Write string
 145             Ostream& write(const string&);
 146
 147             //- Write std::string surrounded by quotes.
 148             //  Optional write without quotes.
 149             Ostream& writeQuoted
 150             (
 151                 const std::string&,
 152                 const bool quoted=true
 153             );
 154
 155             //- Write label
 156             Ostream& write(const label);
 157
 158             //- Write floatScalar
 159             Ostream& write(const floatScalar);
 160
 161             //- Write doubleScalar
 162             Ostream& write(const doubleScalar);
 163
 164             //- Write binary block
 165             Ostream& write(const char*, std::streamsize);
 166
 167             //- Add indentation characters
 168             void indent()
 169             {}
 170
 171
 172         // Stream state functions
 173
 174             //- Flush stream
 175             void flush()
 176             {}
 177
 178             //- Add newline and flush stream
 179             void endl()
 180             {}
 181
 182             //- Get width of output field
 183             int width() const
 184             {
 185                 return 0;
 186             }
 187
 188             //- Set width of output field (and return old width)
 189             int width(const int)
 190             {
 191                  return 0;
 192             }
 193
 194             //- Get precision of output field
 195             int precision() const
 196             {
 197                  return 0;
 198             }
 199
 200             //- Set precision of output field (and return old precision)
 201             int precision(const int)
 202             {
 203                  return 0;
 204             }
 205
 206
 207         // Edit
 208
 209             //- Set flags of stream
 210             ios_base::fmtflags flags(const ios_base::fmtflags)
 211             {
 212                 return ios_base::fmtflags(0);
 213             }
 214
 215
 216         // Print
 217
 218             //- Print description of IOstream to Ostream
 219             void print(Ostream&) const;
 220 };
 221
 222
 223 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 224
 225 } // End namespace Foam
 226
 227 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 228
 229 #endif
 230
 231 // ************************************************************************* //