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

Inheritance diagram for IFstream:

Collaboration diagram for IFstream:

Public Member Functions
	ClassName ("IFstream")
	Declare type-name (with debug switch) More...

	IFstream (const fileName &pathname, IOstreamOption streamOpt=IOstreamOption())
	Construct from pathname. More...

	IFstream (const fileName &pathname, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion)
	Construct from pathname, format (version) More...

	~IFstream ()=default
	Destructor. More...

virtual std::istream &	stdStream ()
	Access to underlying std::istream. More...

virtual const std::istream &	stdStream () const
	Const access to underlying std::istream. More...

virtual void	rewind ()
	Rewind the stream so that it may be read again. More...

virtual void	print (Ostream &os) const
	Print stream description. More...

IFstream &	operator() () const
	Return a non-const reference to const IFstream. More...

ISstream &	get (char &c)
	Get character(s) More...

virtual const fileName &	name () const
	Read/write access to the name of the stream. More...

virtual fileName &	name ()
	Read/write access to the name of the stream. More...

Public Member Functions inherited from ISstream
	ISstream (std::istream &is, const string &streamName, IOstreamOption streamOpt=IOstreamOption())
	Construct wrapper around std::istream, set stream status. More...

	ISstream (std::istream &is, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct wrapper around std::istream, set stream status. More...

virtual	~ISstream ()=default
	Destructor. More...

virtual const fileName &	name () const
	Return the name of the stream. More...

virtual fileName &	name ()
	Return stream name for modification. More...

virtual ios_base::fmtflags	flags () const
	Return flags of output stream. More...

bool	seekCommentEnd_Cstyle ()
	Discard until end of C-style comment '*‍/'. More...

bool	continueReadUntilRightBrace (std::string &str, const bool stripComments=true)

ISstream &	get (char &c)
	Raw, low-level get character function. More...

int	peek ()
	Raw, low-level peek function. More...

ISstream &	getLine (std::string &str, char delim='\n')
	Raw, low-level getline (until delimiter) into a string. More...

std::streamsize	getLine (std::nullptr_t, char delim='\n')
	Low-level discard until delimiter. More...

ISstream &	putback (const char c)
	Raw, low-level putback character function. More...

virtual Istream &	read (token &t)
	Return next token from stream. More...

virtual Istream &	read (char &c)
	Read a character. More...

virtual Istream &	read (word &str)
	Read a word. More...

virtual Istream &	read (string &str)
	Read a string (including enclosing double-quotes). More...

virtual Istream &	read (label &val)
	Read a label. More...

virtual Istream &	read (floatScalar &val)
	Read a floatScalar. More...

virtual Istream &	read (doubleScalar &val)
	Read a doubleScalar. More...

virtual Istream &	read (char *buf, std::streamsize count)
	Read binary block. More...

virtual Istream &	readRaw (char *data, std::streamsize count)
	Low-level raw binary read. More...

virtual bool	beginRawRead ()
	Start of low-level raw binary read. More...

virtual bool	endRawRead ()
	End of low-level raw binary read. More...

virtual ios_base::fmtflags	flags (const ios_base::fmtflags flags)
	Set stream flags. More...

Public Member Functions inherited from Istream
	Istream (const Istream &)=default
	Copy construct. More...

virtual	~Istream ()=default
	Destructor. More...

	Istream (IOstreamOption streamOpt=IOstreamOption())

	Istream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format, version (compression) More...

const token &	peekBack () const noexcept
	Examine putback token without removing it. More...

bool	peekBack (token &tok)
	Fetch putback token without removing it. More...

void	putBack (const token &tok)
	Put back a token. Only a single put back is permitted. More...

bool	getBack (token &tok)
	Get the put-back token if there is one. More...

bool	readBegin (const char *funcName)
	Begin read of data chunk, starts with '('. More...

bool	readEnd (const char *funcName)
	End read of data chunk, ends with ')'. More...

char	readBeginList (const char *funcName)
	Begin read of list data, starts with '(' or '{'. More...

char	readEndList (const char *funcName)
	End read of list data, ends with ')' or '}'. More...

Istream &	operator() () const
	Return a non-const reference to const Istream. More...

Public Member Functions inherited from IOstream
	IOstream (const IOstream &)=default
	Copy construct. More...

virtual	~IOstream ()=default
	Destructor. More...

	IOstream (IOstreamOption streamOpt=IOstreamOption())

	IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format, version (compression) More...

fileName	relativeName () const
	Return the name of the stream relative to the current case. More...

virtual bool	check (const char *operation) const
	Check IOstream status for given operation. More...

bool	fatalCheck (const char *operation) const
	Check IOstream status for given operation. More...

bool	opened () const noexcept
	True if stream has been opened. More...

bool	closed () const noexcept
	True if stream is closed. More...

bool	good () const noexcept
	True if next operation might succeed. More...

bool	eof () const noexcept
	True if end of input seen. More...

bool	fail () const noexcept
	True if next operation will fail. More...

bool	bad () const noexcept
	True if stream is corrupted. More...

	operator bool () const noexcept
	Return true if the stream has not failed. More...

bool	operator! () const noexcept
	Return true if the stream has failed. More...

unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes associated with the stream. More...

unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes associated with the stream. More...

void	setLabelByteSize (unsigned nbytes) noexcept
	Set the sizeof (label) in bytes associated with the stream. More...

void	setScalarByteSize (unsigned nbytes) noexcept
	Set the sizeof (scalar) in bytes associated with the stream. More...

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
	Const access to the current stream line number. More...

label &	lineNumber () noexcept
	Non-const access to the current stream line number. More...

label	lineNumber (const label num) noexcept
	Set the stream line number. More...

void	setEof () noexcept
	Set stream state as reached 'eof'. More...

void	setFail () noexcept
	Set stream state as 'failed'. More...

void	setBad ()
	Set stream state 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 f)
	Unset flags of stream. More...

void	print (Ostream &os, const int streamState) const
	Print information about the stream state bits. More...

InfoProxy< IOstream >	info () const
	Return info proxy. More...

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
	Construct from components (format, compression, version) More...

constexpr	IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept
	Construct from components (format, version, compression) More...

	IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept
	Copy construct with change of format. More...

streamFormat	format () const noexcept
	Get the current stream format. More...

streamFormat	format (const streamFormat fmt) noexcept
	Set the stream format. More...

streamFormat	format (const word &formatName)
	Set the stream format from string value. More...

compressionType	compression () const noexcept
	Get the stream compression. More...

compressionType	compression (const compressionType comp) noexcept
	Set the stream compression. More...

compressionType	compression (const word &compName)
	Set the stream compression from string value. More...

versionNumber	version () const noexcept
	Get the stream version. More...

versionNumber	version (const versionNumber ver) noexcept
	Set the stream version. More...

versionNumber	version (const token &tok)
	Set the stream version from token. More...

Additional Inherited Members
Public Types inherited from IOstream
enum	streamAccess : char { CLOSED = 0, OPENED }
	Enumeration for stream open/closed state. More...

Public Types inherited from IOstreamOption
enum	streamFormat : char { ASCII = 0, BINARY }
	Data format (ascii \| binary) More...

enum	compressionType : char { UNCOMPRESSED = 0, COMPRESSED }
	Compression treatment (UNCOMPRESSED \| COMPRESSED) More...

Static Public Member Functions inherited from IOstream
static unsigned int	defaultPrecision () noexcept
	Return the default precision. More...

static unsigned int	defaultPrecision (unsigned int prec) noexcept
	Reset the default precision. More...

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)
	Failsafe construct streamFormat from optional dictionary lookup. More...

static compressionType	compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED)
	The compression enum corresponding to the string. More...

static compressionType	compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED)
	Failsafe construct compressionType from optional dictionary lookup. More...

Static Public Attributes inherited from IOstream
static unsigned int	precision_
	Default precision. More...

Static Public Attributes inherited from IOstreamOption
static const Enum< streamFormat >	formatNames
	Stream format names (ascii, binary) More...

static const versionNumber	currentVersion
	The current version number (2.0) More...

Protected Member Functions inherited from Istream
bool	hasPutback () const noexcept
	True if putback token is in use. More...

Protected Member Functions inherited from IOstream
void	setOpened () noexcept
	Set stream opened. More...

void	setClosed () noexcept
	Set stream closed. More...

void	setState (std::ios_base::iostate state) noexcept
	Set stream state. More...

void	setGood () noexcept
	Set stream state to be good. More...

Protected Attributes inherited from IOstream
std::ios_base::iostate	ioState_
	Mirror of internal stream io state. More...

streamAccess	openClosed_
	The stream open/closed state. More...

unsigned char	sizeofLabel_
	The sizeof (label), possibly read from the header. More...

unsigned char	sizeofScalar_
	The sizeof (scalar), possibly read from the header. More...

label	lineNumber_
	The file line. More...

Static Protected Attributes inherited from IOstream
static fileName	staticName_
	Name for any generic stream - normally treat as readonly. More...

Detailed Description

Input from file stream, using an ISstream.

Source files

Definition at line 53 of file IFstream.H.

Constructor & Destructor Documentation

◆ IFstream() [1/2]

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

explicit

Construct from pathname.

Definition at line 43 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

Construct from pathname, format (version)

Definition at line 75 of file IFstream.H.

◆ ~IFstream()

~IFstream ( )

default

Destructor.

Member Function Documentation

◆ ClassName()

ClassName ( "IFstream" )

Declare type-name (with debug switch)

◆ stdStream() [1/2]

std::istream & stdStream ( )

virtual

Access to underlying std::istream.

Reimplemented from ISstream.

Definition at line 94 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]

const std::istream & stdStream ( ) const

virtual

Const access to underlying std::istream.

Reimplemented from ISstream.

Definition at line 109 of file IFstream.C.

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

Here is the call graph for this function:

◆ rewind()

void rewind ( )

virtual

Rewind the stream so that it may be read again.

Includes special handling for compressed streams.

Reimplemented from ISstream.

Definition at line 124 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

Print stream description.

Reimplemented from ISstream.

Definition at line 139 of file IFstream.C.

References os(), and 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("fileName")());

Definition at line 148 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

Get character(s)

Definition at line 56 of file ISstreamI.H.

◆ name() [1/2]

virtual const fileName& name

inline

Read/write access to the name of the stream.

Definition at line 113 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

Read/write access to the name of the stream.

Definition at line 119 of file ISstream.H.

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

src/OpenFOAM/db/IOstreams/Fstreams/IFstream.H
src/OpenFOAM/db/IOstreams/Fstreams/IFstream.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IFstream() [1/2]

◆ IFstream() [2/2]

◆ ~IFstream()

Member Function Documentation

◆ ClassName()

◆ stdStream() [1/2]

◆ stdStream() [2/2]

◆ rewind()

◆ print()

◆ operator()()

◆ get()

◆ name() [1/2]

◆ name() [2/2]