src/OpenFOAM/db/IOstreams/Pstreams/UIPstream.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::UIPstream
  26
  27 Description
  28     Input inter-processor communications stream operating on external
  29     buffer.
  30
  31 SourceFiles
  32     UIPstream.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #include "Pstream.H"
  37
  38 #ifndef UIPstream_H
  39 #define UIPstream_H
  40
  41 #include "UPstream.H"
  42 #include "Istream.H"
  43 #include "PstreamBuffers.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                            Class UIPstream Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class UIPstream
  55 :
  56     public UPstream,
  57     public Istream
  58 {
  59     // Private data
  60
  61         int fromProcNo_;
  62
  63         DynamicList<char>& externalBuf_;
  64
  65         label& externalBufPosition_;
  66
  67         const int tag_;
  68
  69         const bool clearAtEnd_;
  70
  71         label messageSize_;
  72
  73
  74     // Private Member Functions
  75
  76         //- Check the bufferPosition against messageSize_ for EOF
  77         inline void checkEof();
  78
  79         //- Read a T from the transfer buffer
  80         template<class T>
  81         inline void readFromBuffer(T&);
  82
  83         //- Read data from the transfer buffer
  84         inline void readFromBuffer(void* data, size_t count, size_t align);
  85
  86
  87 public:
  88
  89     // Constructors
  90
  91         //- Construct given process index to read from and optional buffer size,
  92         //  read format and IO version
  93         UIPstream
  94         (
  95             const commsTypes commsType,
  96             const int fromProcNo,
  97             DynamicList<char>& externalBuf,
  98             label& externalBufPosition,
  99             const int tag = UPstream::msgType(),
 100             const bool clearAtEnd = false,   // destroy externalBuf if at end
 101             streamFormat format=BINARY,
 102             versionNumber version=currentVersion
 103         );
 104
 105         //- Construct given buffers
 106         UIPstream(const int fromProcNo, PstreamBuffers&);
 107
 108
 109     //- Destructor
 110     ~UIPstream();
 111
 112
 113     // Member functions
 114
 115         // Inquiry
 116
 117             //- Return flags of output stream
 118             ios_base::fmtflags flags() const
 119             {
 120                 return ios_base::fmtflags(0);
 121             }
 122
 123
 124         // Read functions
 125
 126             //- Read into given buffer from given processor and return the
 127             //  message size
 128             static label read
 129             (
 130                 const commsTypes commsType,
 131                 const int fromProcNo,
 132                 char* buf,
 133                 const std::streamsize bufSize,
 134                 const int tag = UPstream::msgType()
 135             );
 136
 137             //- Return next token from stream
 138             Istream& read(token&);
 139
 140             //- Read a character
 141             Istream& read(char&);
 142
 143             //- Read a word
 144             Istream& read(word&);
 145
 146             // Read a string (including enclosing double-quotes)
 147             Istream& read(string&);
 148
 149             //- Read a label
 150             Istream& read(label&);
 151
 152             //- Read a floatScalar
 153             Istream& read(floatScalar&);
 154
 155             //- Read a doubleScalar
 156             Istream& read(doubleScalar&);
 157
 158             //- Read binary block
 159             Istream& read(char*, std::streamsize);
 160
 161             //- Rewind and return the stream so that it may be read again
 162             Istream& rewind();
 163
 164
 165         // Edit
 166
 167             //- Set flags of stream
 168             ios_base::fmtflags flags(const ios_base::fmtflags)
 169             {
 170                 return ios_base::fmtflags(0);
 171             }
 172
 173
 174         // Print
 175
 176             //- Print description of IOstream to Ostream
 177             void print(Ostream&) const;
 178 };
 179
 180
 181 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 182
 183 } // End namespace Foam
 184
 185 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 186
 187 #endif
 188
 189 // ************************************************************************* //