Input from file stream. More...


Public Member Functions | |
| ClassName ("IFstream") | |
| IFstream (const fileName &filePath, const streamFormat format=ASCII, const versionNumber version=currentVersion) | |
| Construct from filePath. More... | |
| ~IFstream () | |
| Destructor. More... | |
| const fileName & | name () const |
| Return the name of the stream. More... | |
| fileName & | name () |
| 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... | |
| IFstream & | operator() () const |
| Return a non-const reference to const IFstream. More... | |
Public Member Functions inherited from ISstream | |
| ISstream (istream &is, const string &name, const streamFormat format=ASCII, const versionNumber version=currentVersion, const 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... | |
| ISstream & | get (char &) |
| Low-level get character function. More... | |
| int | peek () |
| Low-level peek function. More... | |
| ISstream & | putback (const char &) |
| Low-level putback character function. More... | |
| ISstream & | getLine (string &, const bool continuation=true) |
| Read line into a string. More... | |
| Istream & | readList (string &) |
| Read a '(...)' delimited set of characters into a string. More... | |
| Istream & | readBlock (string &) |
| Read a '{...}' delimited set of characters into a string. More... | |
| virtual Istream & | read (token &) |
| Return next token from stream. More... | |
| virtual Istream & | read (char &) |
| Read a character. More... | |
| virtual Istream & | read (word &) |
| Read a word. More... | |
| virtual Istream & | read (string &) |
| Read a string (including enclosing double-quotes). More... | |
| virtual Istream & | read (int32_t &) |
| Read an int32_t. More... | |
| virtual Istream & | read (int64_t &) |
| Read an int64_t. More... | |
| virtual Istream & | read (uint32_t &) |
| Read a uint32_t. More... | |
| virtual Istream & | read (uint64_t &) |
| Read a uint64_t. More... | |
| virtual Istream & | read (floatScalar &) |
| Read a floatScalar. More... | |
| virtual Istream & | read (doubleScalar &) |
| Read a doubleScalar. More... | |
| virtual Istream & | read (longDoubleScalar &) |
| Read a longDoubleScalar. More... | |
| virtual Istream & | read (char *, std::streamsize) |
| Read binary block. More... | |
| virtual Istream & | rewind () |
| 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 (const streamFormat format=ASCII, const versionNumber version=currentVersion, const compressionType compression=UNCOMPRESSED, const bool global=false) | |
| 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... | |
| Istream & | readBegin (const char *funcName) |
| Istream & | readEnd (const char *funcName) |
| Istream & | readEndBegin (const char *funcName) |
| char | readBeginList (const char *funcName) |
| char | readEndList (const char *funcName) |
| Istream & | operator() () const |
| Return a non-const reference to const Istream. More... | |
Public Member Functions inherited from IOstream | |
| IOstream (const streamFormat format, const versionNumber version, const compressionType compression=UNCOMPRESSED, const bool global=false) | |
| 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... | |
| bool | global () const |
| Return global state. More... | |
| bool & | global () |
| Return global state. More... | |
| label | lineNumber () const |
| Return current stream line number. More... | |
| label & | lineNumber () |
| 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< IOstream > | info () 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_ |
| IFstream | ( | const fileName & | filePath, |
| const streamFormat | format = ASCII, |
||
| const versionNumber | version = currentVersion |
||
| ) |
Construct from filePath.
Definition at line 92 of file IFstream.C.
References Foam::endl(), IOstream::good(), IOstream::info(), InfoInFunction, IOstream::lineNumber_, IOstream::setBad(), IOstream::setClosed(), IOstream::setOpened(), and IOstream::setState().

| ~IFstream | ( | ) |
Destructor.
Definition at line 135 of file IFstream.C.
| ClassName | ( | "IFstream" | ) |
|
inlinevirtual |
Return the name of the stream.
Reimplemented from ISstream.
Definition at line 116 of file IFstream.H.
Referenced by NASedgeFormat::read(), STARCDedgeFormat::read(), NASsurfaceFormat< Face >::read(), STARCDsurfaceFormat< Face >::read(), externalCoupledMixedFvPatchField< Type >::readData(), STARCDCore::readHeader(), STARCD::readHeader(), STARCDCore::readPoints(), and externalCoupledMixedFvPatchField< scalar >::~externalCoupledMixedFvPatchField().

|
inlinevirtual |
Return non-const access to the name of the stream.
Reimplemented from ISstream.
Definition at line 122 of file IFstream.H.
|
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().


|
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.

|
virtual |
Print description of IOstream to Ostream.
Reimplemented from ISstream.
Definition at line 163 of file IFstream.C.
References ISstream::print().

| 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 IOerror::exit(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and Foam::isFile().
