src/foam/db/IOstreams/Pstreams/IPstream.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::IPstream
  26
  27 Description
  28     Input inter-processor communications stream.
  29
  30 SourceFiles
  31     IPstream.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #include "Pstream.H"
  36
  37 #ifndef IPstream_H
  38 #define IPstream_H
  39
  40 #include "Istream.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class IPstream Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class IPstream
  52 :
  53     public Pstream,
  54     public Istream
  55 {
  56     // Private data
  57
  58         //- ID of sending processor
  59         int fromProcNo_;
  60
  61         //- Message size
  62         label messageSize_;
  63
  64
  65     // Private member functions
  66
  67         //- Check the bufferPosition_ against messageSize_ for EOF
  68         inline void checkEof();
  69
  70         //- Read a T from the transfer buffer
  71         template<class T>
  72         inline void readFromBuffer(T&);
  73
  74         //- Read data from the transfer buffer
  75         inline void readFromBuffer(void* data, size_t count, size_t align);
  76
  77
  78 public:
  79
  80     // Constructors
  81
  82         //- Construct given process index to read from, optional buffer size,
  83         //  read format and IO version
  84         IPstream
  85         (
  86             const commsTypes commsType,
  87             const int fromProcNo,
  88             const label bufSize = 0,
  89             streamFormat format = BINARY,
  90             versionNumber version = currentVersion
  91         );
  92
  93
  94     // Destructor
  95
  96         ~IPstream();
  97
  98
  99     // Member functions
 100
 101         // Inquiry
 102
 103             //- Return flags of output stream
 104             ios_base::fmtflags flags() const
 105             {
 106                 return ios_base::fmtflags(0);
 107             }
 108
 109
 110         // Read functions
 111
 112             //- Read into given buffer from given processor and return the
 113             //  message size
 114             static label read
 115             (
 116                 const commsTypes commsType,
 117                 const int fromProcNo,
 118                 char* buf,
 119                 const std::streamsize bufSize
 120             );
 121
 122             //- Non-blocking receives: wait until all have finished.
 123             static void waitRequests();
 124
 125             //- Non-blocking receives: has request i finished?
 126             static bool finishedRequest(const label i);
 127
 128             //- Return next token from stream
 129             Istream& read(token&);
 130
 131             //- Read a character
 132             Istream& read(char&);
 133
 134             //- Read a word
 135             Istream& read(word&);
 136
 137             // Read a string (including enclosing double-quotes)
 138             Istream& read(string&);
 139
 140             //- Read a label
 141             Istream& read(label&);
 142
 143             //- Read a floatScalar
 144             Istream& read(floatScalar&);
 145
 146             //- Read a doubleScalar
 147             Istream& read(doubleScalar&);
 148
 149             //- Read a longDoubleScalar
 150             Istream& read(longDoubleScalar&);
 151
 152             //- Read binary block
 153             Istream& read(char*, std::streamsize);
 154
 155             //- Rewind and return the stream so that it may be read again
 156             Istream& rewind();
 157
 158
 159         // Edit
 160
 161             //- Set flags of stream
 162             ios_base::fmtflags flags(const ios_base::fmtflags)
 163             {
 164                 return ios_base::fmtflags(0);
 165             }
 166
 167
 168         // Print
 169
 170             //- Print description of IOstream to Ostream
 171             void print(Ostream&) const;
 172 };
 173
 174
 175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 176
 177 } // End namespace Foam
 178
 179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 180
 181 #endif
 182
 183 // ************************************************************************* //