Public Member Functions | List of all members
IFstream Class Reference

Input from file stream, using an ISstream. More...

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

Public Member Functions

 ClassName ("IFstream")
 
 IFstream (const fileName &pathname, IOstreamOption streamOpt=IOstreamOption())
 
 IFstream (const fileName &pathname, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion)
 
 ~IFstream ()=default
 
virtual std::istream & stdStream ()
 
virtual const std::istream & stdStream () const
 
virtual void rewind ()
 
virtual void print (Ostream &os) const
 
IFstream & operator() () const
 
ISstream & get (char &c)
 
virtual const fileName & name () const
 
virtual fileName & name ()
 
- Public Member Functions inherited from ISstream
 ISstream (std::istream &is, const string &streamName, IOstreamOption streamOpt=IOstreamOption())
 
 ISstream (std::istream &is, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 
virtual ~ISstream ()=default
 
virtual const fileName & name () const
 
virtual fileName & name ()
 
virtual ios_base::fmtflags flags () const
 
bool seekCommentEnd_Cstyle ()
 
bool continueReadUntilRightBrace (std::string &str, const bool stripComments=true)
 
ISstream & get (char &c)
 
int peek ()
 
ISstream & getLine (std::string &str, char delim='\n')
 
std::streamsize getLine (std::nullptr_t, char delim='\n')
 
ISstream & putback (const char c)
 
virtual Istream & read (token &t)
 
virtual Istream & read (char &c)
 
virtual Istream & read (word &str)
 
virtual Istream & read (string &str)
 
virtual Istream & read (label &val)
 
virtual Istream & read (floatScalar &val)
 
virtual Istream & read (doubleScalar &val)
 
virtual Istream & read (char *buf, std::streamsize count)
 
virtual Istream & readRaw (char *data, std::streamsize count)
 
virtual bool beginRawRead ()
 
virtual bool endRawRead ()
 
virtual ios_base::fmtflags flags (const ios_base::fmtflags flags)
 
- Public Member Functions inherited from Istream
 Istream (const Istream &)=default
 
virtual ~Istream ()=default
 
 Istream (IOstreamOption streamOpt=IOstreamOption())
 
 Istream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 
const token & peekBack () const noexcept
 
bool peekBack (token &tok)
 
void putBack (const token &tok)
 
bool getBack (token &tok)
 
bool readBegin (const char *funcName)
 
bool readEnd (const char *funcName)
 
char readBeginList (const char *funcName)
 
char readEndList (const char *funcName)
 
Istream & operator() () const
 
- Public Member Functions inherited from IOstream
 IOstream (const IOstream &)=default
 
virtual ~IOstream ()=default
 
 IOstream (IOstreamOption streamOpt=IOstreamOption())
 
 IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 
fileName relativeName () const
 
virtual bool check (const char *operation) const
 
bool fatalCheck (const char *operation) const
 
bool opened () const noexcept
 
bool closed () const noexcept
 
bool good () const noexcept
 
bool eof () const noexcept
 
bool fail () const noexcept
 
bool bad () const noexcept
 
 operator bool () const noexcept
 
bool operator! () const noexcept
 
unsigned labelByteSize () const noexcept
 
unsigned scalarByteSize () const noexcept
 
void setLabelByteSize (unsigned nbytes) noexcept
 
void setScalarByteSize (unsigned nbytes) noexcept
 
template<class T = label>
std::enable_if< std::is_integral< T >::value, bool >::type checkLabelSize () const noexcept
 
template<class T = scalar>
std::enable_if< std::is_floating_point< T >::value, bool >::type checkScalarSize () const noexcept
 
label lineNumber () const noexcept
 
label & lineNumber () noexcept
 
label lineNumber (const label num) noexcept
 
void setEof () noexcept
 
void setFail () noexcept
 
void setBad ()
 
ios_base::fmtflags setf (const ios_base::fmtflags f)
 
ios_base::fmtflags setf (const ios_base::fmtflags f, const ios_base::fmtflags mask)
 
void unsetf (const ios_base::fmtflags f)
 
void print (Ostream &os, const int streamState) const
 
InfoProxy< IOstream > info () const
 
- Public Member Functions inherited from IOstreamOption
constexpr IOstreamOption (streamFormat fmt=streamFormat::ASCII, compressionType comp=compressionType::UNCOMPRESSED) noexcept
 
constexpr IOstreamOption (streamFormat fmt, compressionType comp, versionNumber ver) noexcept
 
constexpr IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept
 
 IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept
 
streamFormat format () const noexcept
 
streamFormat format (const streamFormat fmt) noexcept
 
streamFormat format (const word &formatName)
 
compressionType compression () const noexcept
 
compressionType compression (const compressionType comp) noexcept
 
compressionType compression (const word &compName)
 
versionNumber version () const noexcept
 
versionNumber version (const versionNumber ver) noexcept
 
versionNumber version (const token &tok)
 

Additional Inherited Members

- Public Types inherited from IOstream
enum  streamAccess : char { CLOSED = 0, OPENED }
 
- Public Types inherited from IOstreamOption
enum  streamFormat : char { ASCII = 0, BINARY }
 
enum  compressionType : char { UNCOMPRESSED = 0, COMPRESSED }
 
- Static Public Member Functions inherited from IOstream
static unsigned int defaultPrecision () noexcept
 
static unsigned int defaultPrecision (unsigned int prec) noexcept
 
- Static Public Member Functions inherited from IOstreamOption
static streamFormat formatEnum (const word &formatName, const streamFormat deflt=streamFormat::ASCII)
 
static streamFormat formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII)
 
static compressionType compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED)
 
static compressionType compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED)
 
- Static Public Attributes inherited from IOstream
static unsigned int precision_
 
- Static Public Attributes inherited from IOstreamOption
static const Enum< streamFormat > formatNames
 
static const versionNumber currentVersion
 
- Protected Member Functions inherited from Istream
bool hasPutback () const noexcept
 
- Protected Member Functions inherited from IOstream
void setOpened () noexcept
 
void setClosed () noexcept
 
void setState (std::ios_base::iostate state) noexcept
 
void setGood () noexcept
 
- Protected Attributes inherited from IOstream
std::ios_base::iostate ioState_
 
streamAccess openClosed_
 
unsigned char sizeofLabel_
 
unsigned char sizeofScalar_
 
label lineNumber_
 
- Static Protected Attributes inherited from IOstream
static fileName staticName_
 

Detailed Description

Input from file stream, using an ISstream.

Source files

Definition at line 49 of file IFstream.H.

Constructor & Destructor Documentation

◆ IFstream() [1/2]

IFstream ( const fileName &  pathname,
IOstreamOption  streamOpt = IOstreamOption() 
)
explicit

Definition at line 36 of file IFstream.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::PtrListOps::get(), InfoInFunction, and Foam::name().

Here is the call graph for this function:

◆ IFstream() [2/2]

IFstream ( const fileName &  pathname,
IOstreamOption::streamFormat  fmt,
IOstreamOption::versionNumber  ver = IOstreamOption::currentVersion 
)
inline

Definition at line 71 of file IFstream.H.

◆ ~IFstream()

~IFstream ( )
default

Member Function Documentation

◆ ClassName()

ClassName ( "IFstream"  )

◆ stdStream() [1/2]

const std::istream & stdStream ( )
virtual

Reimplemented from ISstream.

Definition at line 87 of file IFstream.C.

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

Referenced by ensightSurfaceReader::geometry(), ensightReadFile::read(), and masterUncollatedFileOperation::readAndSend().

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

◆ stdStream() [2/2]

virtual const std::istream& stdStream ( ) const
virtual

Reimplemented from ISstream.

◆ rewind()

void rewind ( )
virtual

Reimplemented from ISstream.

Definition at line 117 of file IFstream.C.

References IOstreamOption::COMPRESSED, ifstreamPointer::get(), Foam::name(), ifstreamPointer::reopen_gz(), ISstream::rewind(), and ifstreamPointer::whichCompression().

Here is the call graph for this function:

◆ print()

void print ( Ostream &  os) const
virtual

Reimplemented from ISstream.

Definition at line 132 of file IFstream.C.

References os(), and ISstream::print().

Here is the call graph for this function:

◆ operator()()

Foam::IFstream & operator() ( ) const

Definition at line 141 of file IFstream.C.

References Foam::check(), Foam::exit(), IOerror::exit(), Foam::FatalIOError, FatalIOErrorInFunction, FUNCTION_NAME, Foam::isFile(), and Foam::name().

Here is the call graph for this function:

◆ get()

Foam::ISstream & get
inline

Definition at line 49 of file ISstreamI.H.

◆ name() [1/2]

virtual const fileName& name
inline

Definition at line 109 of file ISstream.H.

Referenced by ensightSurfaceReader::geometry(), NASedgeFormat::read(), STARCDsurfaceFormat< Face >::read(), NASsurfaceFormat< Face >::read(), STARCDedgeFormat::read(), ensightSurfaceReader::readCase(), ensightSurfaceReader::readField(), STARCDCore::readHeader(), and STARCDCore::readPoints().

Here is the caller graph for this function:

◆ name() [2/2]

virtual fileName& name
inline

Definition at line 115 of file ISstream.H.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17