Public Member Functions | List of all members
ISstream Class Reference

Generic input stream. More...

Inheritance diagram for ISstream:
Inheritance graph
[legend]
Collaboration diagram for ISstream:
Collaboration graph
[legend]

Public Member Functions

 ISstream (istream &is, const string &name, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
 Construct as wrapper around istream. More...
 
virtual ~ISstream ()
 Destructor. More...
 
virtual const fileNamename () const
 Return the name of the stream. More...
 
virtual fileNamename ()
 Return non-const access to the name of the stream. More...
 
virtual ios_base::fmtflags flags () const
 Return flags of output stream. More...
 
ISstreamget (char &)
 Raw, low-level get character function. More...
 
int peek ()
 Raw, low-level peek function. More...
 
ISstreamgetLine (string &)
 Raw, low-level getline into a string function. More...
 
ISstreamputback (const char &)
 Raw, low-level putback character function. More...
 
virtual Istreamread (token &)
 Return next token from stream. More...
 
virtual Istreamread (char &)
 Read a character. More...
 
virtual Istreamread (word &)
 Read a word. More...
 
virtual Istreamread (string &)
 Read a string (including enclosing double-quotes). More...
 
virtual Istreamread (label &)
 Read a label. More...
 
virtual Istreamread (floatScalar &)
 Read a floatScalar. More...
 
virtual Istreamread (doubleScalar &)
 Read a doubleScalar. More...
 
virtual Istreamread (char *, std::streamsize)
 Read binary block. More...
 
virtual Istreamrewind ()
 Rewind and return the stream so that it may be read again. More...
 
virtual ios_base::fmtflags flags (const ios_base::fmtflags flags)
 Set flags of output stream. More...
 
virtual istream & stdStream ()
 Access to underlying std::istream. More...
 
virtual const istream & stdStream () const
 Const access to underlying std::istream. More...
 
virtual void print (Ostream &) const
 Print description of IOstream to Ostream. More...
 
- Public Member Functions inherited from Istream
 Istream (streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
 Set stream status. More...
 
virtual ~Istream ()
 Destructor. More...
 
void putBack (const token &)
 Put back token. More...
 
bool getBack (token &)
 Get the put back token if there is one and return true. More...
 
bool peekBack (token &)
 Peek at the put back token without removing it. More...
 
IstreamreadBegin (const char *funcName)
 
IstreamreadEnd (const char *funcName)
 
IstreamreadEndBegin (const char *funcName)
 
char readBeginList (const char *funcName)
 
char readEndList (const char *funcName)
 
Istreamoperator() () const
 Return a non-const reference to const Istream. More...
 
- Public Member Functions inherited from IOstream
 IOstream (streamFormat format, versionNumber version, compressionType compression=UNCOMPRESSED)
 Construct setting format and version. More...
 
virtual ~IOstream ()
 Destructor. More...
 
virtual bool check (const char *operation) const
 Check IOstream status for given operation. More...
 
void fatalCheck (const char *operation) const
 Check IOstream status for given operation. More...
 
bool opened () const
 Return true if stream has been opened. More...
 
bool closed () const
 Return true if stream is closed. More...
 
bool good () const
 Return true if next operation might succeed. More...
 
bool eof () const
 Return true if end of input seen. More...
 
bool fail () const
 Return true if next operation will fail. More...
 
bool bad () const
 Return true if stream is corrupted. More...
 
 operator void * () const
 Return non-zero if the stream has not failed. More...
 
bool operator! () const
 Return true if the stream has failed. More...
 
streamFormat format () const
 Return current stream format. More...
 
streamFormat format (const streamFormat fmt)
 Set the stream format. More...
 
streamFormat format (const word &fmt)
 Set the stream format from word. More...
 
versionNumber version () const
 Return the stream version. More...
 
versionNumber version (const versionNumber ver)
 Set the stream version. More...
 
compressionType compression () const
 Return the stream compression. More...
 
compressionType compression (const compressionType cmp)
 Set the stream compression. More...
 
compressionType compression (const word &cmp)
 Set the stream compression from word. More...
 
label lineNumber () const
 Return current stream line number. More...
 
labellineNumber ()
 Return current stream line number. More...
 
label lineNumber (const label ln)
 Set the stream line number. More...
 
void setEof ()
 Set stream to have reached eof. More...
 
void setFail ()
 Set stream to have failed. More...
 
void setBad ()
 Set stream to be bad. More...
 
ios_base::fmtflags setf (const ios_base::fmtflags f)
 Set flags of stream. More...
 
ios_base::fmtflags setf (const ios_base::fmtflags f, const ios_base::fmtflags mask)
 Set flags of given field of stream. More...
 
void unsetf (const ios_base::fmtflags uf)
 Unset flags of stream. More...
 
void print (Ostream &, const int streamState) const
 Check given stream state bits. More...
 
InfoProxy< IOstreaminfo () const
 Return info proxy. More...
 

Additional Inherited Members

- Public Types inherited from IOstream
enum  streamAccess { OPENED, CLOSED }
 Enumeration for whether the stream open or closed. More...
 
enum  streamFormat { ASCII, BINARY }
 Enumeration for the format of data in the stream. More...
 
enum  compressionType { UNCOMPRESSED, COMPRESSED }
 Enumeration for the format of data in the stream. More...
 
- Static Public Member Functions inherited from IOstream
static streamFormat formatEnum (const word &)
 Return stream format of given format name. More...
 
static compressionType compressionEnum (const word &)
 Return compression of given compression name. More...
 
static unsigned int defaultPrecision ()
 Return the default precision. More...
 
static unsigned int defaultPrecision (unsigned int p)
 Reset the default precision (and return old precision) More...
 
- Static Public Attributes inherited from IOstream
static const versionNumber originalVersion
 Original version number. More...
 
static const versionNumber currentVersion
 Current version number. More...
 
static unsigned int precision_
 Default precision. More...
 
- Protected Member Functions inherited from IOstream
void setOpened ()
 Set stream opened. More...
 
void setClosed ()
 Set stream closed. More...
 
void setState (ios_base::iostate state)
 Set stream state. More...
 
void setGood ()
 Set stream to be good. More...
 
- Protected Attributes inherited from IOstream
label lineNumber_
 

Detailed Description

Generic input stream.

Source files

Definition at line 51 of file ISstream.H.

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 ( )
inlinevirtual

Destructor.

Definition at line 96 of file ISstream.H.

References ISstream::flags(), ISstream::getLine(), ISstream::name(), ISstream::peek(), ISstream::putback(), ISstream::read(), and ISstream::rewind().

Here is the call graph for this function:

Member Function Documentation

virtual const fileName& name ( ) const
inlinevirtual

Return the name of the stream.

Useful for Fstream to return the filename

Reimplemented from IOstream.

Reimplemented in IFstream.

Definition at line 106 of file ISstream.H.

Referenced by dynamicCode::copyAndFilter(), IStringStream::print(), OStringStream::print(), ISstream::print(), OSstream::print(), and ISstream::~ISstream().

Here is the caller graph for this function:

virtual fileName& name ( )
inlinevirtual

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 113 of file ISstream.H.

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

Return flags of output stream.

Implements IOstream.

Definition at line 812 of file ISstream.C.

Referenced by ISstream::~ISstream().

Here is the caller graph for this function:

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::ReadHex().

Here is the call graph for this function:

Here is the caller graph for this function:

int peek ( )
inline

Raw, low-level peek function.

Does not remove the character from the stream. Returns the next character in the stream or EOF if the end of file is read.

Definition at line 71 of file ISstreamI.H.

Referenced by ISstream::~ISstream().

Here is the caller graph for this function:

Foam::ISstream & getLine ( string s)
inline
Foam::ISstream & putback ( const char &  c)
inline

Raw, low-level putback character function.

Definition at line 87 of file ISstreamI.H.

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

Referenced by ISstream::read(), and ISstream::~ISstream().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::Istream & read ( token t)
virtual
Foam::Istream & read ( char &  c)
virtual

Read a character.

Implements Istream.

Definition at line 403 of file ISstream.C.

Foam::Istream & read ( word str)
virtual

Read a word.

Implements Istream.

Definition at line 410 of file ISstream.C.

References IOstream::bad(), token::BEGIN_LIST, Foam::constant::universal::c, token::END_LIST, Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, ISstream::putback(), and word::valid().

Here is the call graph for this function:

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 481 of file ISstream.C.

References IOstream::bad(), token::BEGIN_BLOCK, token::BEGIN_STRING, Foam::constant::universal::c, token::END_BLOCK, token::END_STRING, Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, token::HASH, token::NL, ISstream::putback(), and word::valid().

Here is the call graph for this function:

Foam::Istream & read ( label val)
virtual

Read a label.

Implements Istream.

Definition at line 757 of file ISstream.C.

References IOstream::setState().

Here is the call graph for this function:

Foam::Istream & read ( floatScalar val)
virtual

Read a floatScalar.

Implements Istream.

Definition at line 765 of file ISstream.C.

References IOstream::setState().

Here is the call graph for this function:

Foam::Istream & read ( doubleScalar val)
virtual

Read a doubleScalar.

Implements Istream.

Definition at line 773 of file ISstream.C.

References IOstream::setState().

Here is the call graph for this function:

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

Read binary block.

Implements Istream.

Definition at line 782 of file ISstream.C.

References IOstream::BINARY, Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, IOstream::format(), Istream::readBegin(), Istream::readEnd(), and IOstream::setState().

Here is the call graph for this function:

Foam::Istream & rewind ( )
virtual

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

Implements Istream.

Definition at line 801 of file ISstream.C.

References ISstream::stdStream().

Referenced by ISstream::~ISstream().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Set flags of output stream.

Implements IOstream.

Definition at line 818 of file ISstream.C.

virtual istream& stdStream ( )
inlinevirtual

Access to underlying std::istream.

Reimplemented in IFstream.

Definition at line 178 of file ISstream.H.

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

Here is the caller graph for this function:

virtual const istream& stdStream ( ) const
inlinevirtual

Const access to underlying std::istream.

Reimplemented in IFstream.

Definition at line 184 of file ISstream.H.

References ISstream::print().

Here is the call graph for this function:

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(), and IOstream::print().

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

Here is the call graph for this function:

Here is the caller graph for this function:


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