FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

Generic input stream. More...

#include <OpenFOAM/ISstream.H>


Detailed Description

Generic input stream.

Source files

Definition at line 53 of file ISstream.H.

Inheritance diagram for ISstream:
Collaboration diagram for ISstream:

List of all members.

Public Member Functions

 ISstream (istream &is, const string &name, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
 Construct as wrapper around istream.
virtual  ~ISstream ()
virtual const fileName &  name () const
 Return the name of the stream.
virtual fileName &  name ()
 Return non-const access to the name of the stream.
virtual ios_base::fmtflags  flags () const
 Return flags of output stream.
ISstream &  get (char &)
 Raw, low-level get character function.
ISstream &  getLine (string &)
 Raw, low-level getline into a string function.
ISstream &  putback (const char &)
 Raw, low-level putback character function.
virtual Istream &  read (token &)
 Return next token from stream.
virtual Istream &  read (char &)
 Read a character.
virtual Istream &  read (word &)
 Read a word.
virtual Istream &  read (string &)
 Read a string (including enclosing double-quotes).
virtual Istream &  read (label &)
 Read a label.
virtual Istream &  read (floatScalar &)
 Read a floatScalar.
virtual Istream &  read (doubleScalar &)
 Read a doubleScalar.
virtual Istream &  read (char *, std::streamsize)
 Read binary block.
virtual Istream &  rewind ()
 Rewind and return the stream so that it may be read again.
virtual ios_base::fmtflags  flags (const ios_base::fmtflags flags)
 Set flags of output stream.
virtual void  print (Ostream &) const
 Print description of IOstream to Ostream.

Protected Member Functions

istream &  stream ()
 Return the stream reference.
const istream &  stream () const
 Return the const stream reference.

Constructor & Destructor Documentation

ISstream ( istream &   is,
const string &   name,
streamFormat   format = ASCII,
versionNumber   version = currentVersion,
compressionType   compression = UNCOMPRESSED  
) [inline]

Construct as wrapper around istream.

Definition at line 31 of file ISstreamI.H.

virtual ~ISstream (  ) [inline, virtual]

Definition at line 108 of file ISstream.H.


Member Function Documentation

istream& stream (  ) [inline, protected]

Return the stream reference.

Definition at line 79 of file ISstream.H.

Referenced by IStringStream::str(), and IStringStream::~IStringStream().

const istream& stream (  ) const [inline, protected]

Return the const stream reference.

Definition at line 85 of file ISstream.H.

virtual const fileName& name (  ) const [inline, virtual]

Return the name of the stream.

Useful for Fstream to return the filename

Reimplemented from IOstream.

Reimplemented in IFstream.

Definition at line 118 of file ISstream.H.

Referenced by IStringStream::print(), and ISstream::print().

virtual fileName& name (  ) [inline, virtual]

Return non-const access to the name of the stream.

Useful to alter the stream name

Reimplemented from IOstream.

Reimplemented in IFstream.

Definition at line 125 of file ISstream.H.

std::ios_base::fmtflags flags (  ) const [virtual]

Return flags of output stream.

Implements IOstream.

Definition at line 523 of file ISstream.C.

Foam::ISstream & get ( char &   c  ) [inline]

Raw, low-level get character function.

Definition at line 57 of file ISstreamI.H.

References IOstream::lineNumber_, and IOstream::setState().

Referenced by Foam::readHexLabel().

Foam::ISstream & putback ( const char &   c  ) [inline]

Raw, low-level putback character function.

Definition at line 81 of file ISstreamI.H.

Foam::Istream & read ( char &   c  ) [virtual]

Read a character.

Implements Istream.

Definition at line 275 of file ISstream.C.

Foam::Istream & read ( word &   str  ) [virtual]

Read a word.

Implements Istream.

Definition at line 282 of file ISstream.C.

References token::BEGIN_LIST, token::END_LIST, Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, and word::valid().

Foam::Istream & read ( string &   str  ) [virtual]

Read a string (including enclosing double-quotes).

Backslashes are retained, except when escaping double-quotes and an embedded newline character.

Implements Istream.

Definition at line 358 of file ISstream.C.

References token::BEGIN_STRING, token::END_STRING, Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, and token::NL.

Foam::Istream & read ( label &   val  ) [virtual]

Read a label.

Implements Istream.

Definition at line 468 of file ISstream.C.

Foam::Istream & read ( floatScalar &   val  ) [virtual]

Read a floatScalar.

Implements Istream.

Definition at line 476 of file ISstream.C.

Foam::Istream & read ( doubleScalar &   val  ) [virtual]

Read a doubleScalar.

Implements Istream.

Definition at line 484 of file ISstream.C.

Foam::Istream & read ( char *   buf,
std::streamsize   count  
) [virtual]

Read binary block.

Implements Istream.

Definition at line 493 of file ISstream.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, and format().

Foam::Istream & rewind (  ) [virtual]

Rewind and return the stream so that it may be read again.

Implements Istream.

Definition at line 512 of file ISstream.C.

std::ios_base::fmtflags flags ( const ios_base::fmtflags   flags  ) [virtual]

Set flags of output stream.

Definition at line 529 of file ISstream.C.

void print ( Ostream &   os  ) const [virtual]

Print description of IOstream to Ostream.

Reimplemented from IOstream.

Reimplemented in IFstream, and IStringStream.

Definition at line 34 of file SstreamsPrint.C.

References ISstream::name().

Referenced by IFstream::print().


The documentation for this class was generated from the following files: