IFstream Class Reference

Input from file stream. More...

Inheritance diagram for IFstream:
Collaboration diagram for IFstream:

Public Member Functions

 ClassName ("IFstream")
 
 IFstream (const fileName &filePath, streamFormat format=ASCII, versionNumber version=currentVersion)
 Construct from filePath. More...
 
 ~IFstream ()
 Destructor. More...
 
const fileNamename () const
 Return the name of the stream. More...
 
fileNamename ()
 Return non-const access to the name of the 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...
 
IFstreamoperator() () const
 Return a non-const reference to const IFstream. More...
 
- Public Member Functions inherited from ISstream
 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 ios_base::fmtflags flags () const
 Return flags of output stream. More...
 
ISstreamget (char &)
 Low-level get character function. More...
 
int peek ()
 Low-level peek function. More...
 
ISstreamputback (const char &)
 Low-level putback character function. More...
 
ISstreamgetLine (string &, const bool continuation=true)
 Read line into a string. More...
 
IstreamreadList (string &)
 Read a '(...)' delimited set of characters into a string. More...
 
IstreamreadBlock (string &)
 Read a '{...}' delimited set of characters into a string. 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 (longDoubleScalar &)
 Read a longDoubleScalar. 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...
 
void operator= (const ISstream &)=delete
 Disallow default bitwise assignment. 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 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

Input from file stream.

Source files

Definition at line 81 of file IFstream.H.

Constructor & Destructor Documentation

◆ IFstream()

IFstream ( const fileName filePath,
streamFormat  format = ASCII,
versionNumber  version = currentVersion 
)

Construct from filePath.

Definition at line 93 of file IFstream.C.

References Foam::endl(), IOstream::good(), IOstream::info(), InfoInFunction, IOstream::lineNumber_, IOstream::setBad(), IOstream::setClosed(), IOstream::setOpened(), and IOstream::setState().

Here is the call graph for this function:

◆ ~IFstream()

~IFstream ( )

Destructor.

Definition at line 135 of file IFstream.C.

Member Function Documentation

◆ ClassName()

ClassName ( "IFstream"  )

◆ name() [1/2]

const fileName& name ( ) const
inlinevirtual

◆ name() [2/2]

fileName& name ( )
inlinevirtual

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

Reimplemented from ISstream.

Definition at line 122 of file IFstream.H.

◆ stdStream() [1/2]

std::istream & stdStream ( )
virtual

Access to underlying std::istream.

Reimplemented from ISstream.

Definition at line 141 of file IFstream.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Referenced by masterUncollatedFileOperation::readAndSend().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ stdStream() [2/2]

const std::istream & stdStream ( ) const
virtual

Const access to underlying std::istream.

Reimplemented from ISstream.

Definition at line 152 of file IFstream.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ print()

void print ( Ostream os) const
virtual

Print description of IOstream to Ostream.

Reimplemented from ISstream.

Definition at line 163 of file IFstream.C.

References ISstream::print().

Here is the call graph for this function:

◆ operator()()

Foam::IFstream & operator() ( ) const

Return a non-const reference to const IFstream.

Needed for read-constructors where the stream argument is temporary: e.g. thing thisThing(IFstream("thingFileName")());

Definition at line 173 of file IFstream.C.

References IOstream::check(), Foam::exit(), IOerror::exit(), Foam::FatalIOError, FatalIOErrorInFunction, IOstream::good(), and Foam::isFile().

Here is the call graph for this function:

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