Generic input stream using a standard (STL) stream. More...

#include <ISstream.H>

Inheritance diagram for ISstream:

[legend]

Collaboration diagram for ISstream:

Public Member Functions
	ISstream (std::istream &is, const string &streamName, IOstreamOption streamOpt=IOstreamOption())
	Construct wrapper around std::istream, set stream status.
	ISstream (std::istream &is, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct wrapper around std::istream, set stream status.
	ISstream (std::istream &is, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct wrapper around std::istream, set stream status.
virtual	~ISstream ()=default
	Destructor.
virtual const fileName &	name () const override
	The name of the input serial stream. (eg, the name of the Fstream file name).
virtual fileName &	name ()
	The name of the input serial stream, for modification.
virtual const std::istream &	stdStream () const
	Const access to underlying std::istream.
virtual std::istream &	stdStream ()
	Access to underlying std::istream.
virtual std::ios_base::fmtflags	flags () const override
	Return current stream flags.
virtual std::ios_base::fmtflags	flags (std::ios_base::fmtflags f) override
	Set stream flags, return old stream flags.
void	syncState ()
	Set stream state to match that of the std::istream.
*return False if stream exhausted before finding the comment end bool	seekCommentEnd_Cstyle ()
	Discard until end of C-style comment '.
bool	continueReadUntilRightBrace (std::string &str, const bool stripComments=true)
	Raw, low-level get into a string. Continues reading after an initial left-brace until it finds the matching closing right-brace.
ISstream &	get (char &c)
	Raw, low-level get character function.
int	peek ()
	Raw, low-level peek function.
ISstream &	getLine (std::string &str, char delim='\n')
	Raw, low-level getline (until delimiter) into a string.
std::streamsize	getLine (std::nullptr_t, char delim='\n')
	Low-level discard until delimiter.
ISstream &	putback (const char c)
	Raw, low-level putback character function.
virtual Istream &	read (token &t) override
	Return next token from stream.
virtual Istream &	read (char &c) override
	Read a character.
virtual Istream &	read (word &str) override
	Read a word.
virtual Istream &	read (string &str) override
	Read a string (including enclosing double-quotes).
virtual Istream &	read (int32_t &val) override
	Read int32_t.
virtual Istream &	read (int64_t &val) override
	Read int64_t.
virtual Istream &	read (uint32_t &val) override
	Read uint32_t.
virtual Istream &	read (uint64_t &val) override
	Read uint64_t.
virtual Istream &	read (float &val) override
	Read a float.
virtual Istream &	read (double &val) override
	Read a double.
virtual Istream &	read (char *data, std::streamsize count) override
	Read binary block (with any possible block delimiters). Reading into a null pointer behaves like a forward seek of count characters.
virtual Istream &	readRaw (char *data, std::streamsize count) override
	Low-level raw binary read (without possible block delimiters). Reading into a null pointer behaves like a forward seek of count characters.
virtual bool	beginRawRead () override
	Start of low-level raw binary read.
virtual bool	endRawRead () override
	End of low-level raw binary read.
virtual void	rewind () override
	Rewind the stream so that it may be read again.
virtual void	print (Ostream &os) const override
	Print stream description to Ostream.
Public Member Functions inherited from Istream
	Istream (const Istream &)=default
	Copy construct.
virtual	~Istream ()=default
	Destructor.
	Istream (IOstreamOption streamOpt=IOstreamOption())
	Default construct (ASCII, uncompressed), construct with specified stream option.
	Istream (IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format (uncompressed).
const token &	peekBack () const noexcept
	Examine putback token without removing it.
void	putBackClear ()
	Drop the putback token.
void	putBack (const token &tok)
	Put back a token (copy). Only a single put back is permitted.
void	putBack (token &&tok)
	Put back a token (move). Only a single put back is permitted.
bool	getBack (token &tok)
	Retrieve the put-back token if there is one.
bool	readBegin (const char *funcName)
	Begin read of data chunk, starts with '('.
bool	readEnd (const char *funcName)
	End read of data chunk, ends with ')'.
char	readBeginList (const char *funcName)
	Begin read of list data, starts with '(' or '{'.
char	readEndList (const char *funcName)
	End read of list data, ends with ')' or '}'.
Istream &	operator() () const
	Return a non-const reference to const Istream.
Public Member Functions inherited from IOstream
	IOstream (const IOstream &)=default
	Copy construct.
virtual	~IOstream ()=default
	Destructor.
	IOstream (IOstreamOption streamOpt=IOstreamOption())
	Default construct (ASCII, uncompressed), construct with specified stream option.
	IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format, version (compression).
fileName	relativeName () const
	Return the name of the stream relative to the current case.
virtual bool	check (const char *operation) const
	Check IOstream status for given operation.
bool	fatalCheck (const char *operation) const
	Check IOstream status for given operation.
bool	opened () const noexcept
	True if stream has been opened.
bool	closed () const noexcept
	True if stream is closed.
bool	good () const noexcept
	True if next operation might succeed.
bool	eof () const noexcept
	True if end of input seen.
bool	fail () const noexcept
	True if next operation will fail.
bool	bad () const noexcept
	True if stream is corrupted.
	operator bool () const noexcept
	True if the stream has not failed.
bool	operator! () const noexcept
	True if the stream has failed.
unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes associated with the stream.
unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes associated with the stream.
void	setLabelByteSize (unsigned nbytes) noexcept
	Set the sizeof (label) in bytes associated with the stream.
void	setScalarByteSize (unsigned nbytes) noexcept
	Set the sizeof (scalar) in bytes associated with the stream.
template<class T, class = std::enable_if_t<std::is_integral_v<T>>>
bool	checkLabelSize () const noexcept
	Test if the label byte-size associated with the stream is the same as the given type.
template<class T, class = std::enable_if_t<std::is_floating_point_v<T>>>
bool	checkScalarSize () const noexcept
	Test if the scalar byte-size associated with the stream is the same as the given type.
bool	checkNativeSizes () const noexcept
	Test if the label/scalar byte-size associated with the stream are the native label/scalar sizes.
bool	fatalCheckNativeSizes (const char *operation) const
	Assert that the label/scalar byte-size associated with the stream are the native label/scalar sizes.
label	lineNumber () const noexcept
	Const access to the current stream line number.
label &	lineNumber () noexcept
	Non-const access to the current stream line number.
label	lineNumber (const label num) noexcept
	Set the stream line number.
void	setEof () noexcept
	Set stream state as reached 'eof'.
void	setFail () noexcept
	Set stream state as 'failed'.
void	setBad () noexcept
	Set stream state to be 'bad'.
std::ios_base::fmtflags	setf (std::ios_base::fmtflags f)
	Set stream flag(s), return old stream flags.
std::ios_base::fmtflags	setf (const std::ios_base::fmtflags f, const std::ios_base::fmtflags mask)
	Set stream flag(s) with mask, return old stream flags.
std::ios_base::fmtflags	unsetf (std::ios_base::fmtflags f)
	Unset stream flags, return old stream flags.
void	print (Ostream &os, const int streamState) const
	Print information about the stream state bits.
InfoProxy< IOstream >	info () const noexcept
	Return info proxy, used to print IOstream information to a stream.
Public Member Functions inherited from IOstreamOption
constexpr	IOstreamOption (streamFormat fmt=streamFormat::ASCII, compressionType comp=compressionType::UNCOMPRESSED) noexcept
	Default construct (ASCII, UNCOMPRESSED, currentVersion) or construct with format, compression.
constexpr	IOstreamOption (streamFormat fmt, compressionType comp, versionNumber ver) noexcept
	Construct from components (format, compression, version).
constexpr	IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept
	Construct from components (format, version, compression).
	IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept
	Copy construct with change of format.
streamFormat	format () const noexcept
	Get the current stream format.
streamFormat	format (const streamFormat fmt) noexcept
	Set the stream format.
streamFormat	format (const word &formatName)
	Set the stream format from string value.
compressionType	compression () const noexcept
	Get the stream compression.
compressionType	compression (const compressionType comp) noexcept
	Set the stream compression.
compressionType	compression (const word &compName)
	Set the stream compression from string value.
versionNumber	version () const noexcept
	Get the stream version.
versionNumber	version (const versionNumber ver) noexcept
	Set the stream version.
versionNumber	version (const token &tok)
	Set the stream version from token.

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 , COHERENT , UNKNOWN_FORMAT }
	Data format (ascii \| binary \| coherent). More...
enum	compressionType : char { UNCOMPRESSED = 0 , COMPRESSED }
	Compression treatment (UNCOMPRESSED \| COMPRESSED). More...
enum	appendType : char { NO_APPEND = 0 , APPEND_APP , APPEND_ATE , NON_APPEND = NO_APPEND , APPEND = APPEND_APP }
	File appending (NO_APPEND \| APPEND_APP \| APPEND_ATE). More...
enum	atomicType : char { NON_ATOMIC = 0 , ATOMIC }
	Atomic operations (output). More...
enum class	floatFormat : unsigned { general = unsigned(0) , fixed = unsigned(std::ios_base::fixed) , scientific = unsigned(std::ios_base::scientific) }
	Float formats (eg, time directory name formats). More...
Static Public Member Functions inherited from IOstream
static unsigned int	defaultPrecision () noexcept
	Return the default precision.
static unsigned int	defaultPrecision (unsigned int prec) noexcept
	Reset the default precision.
static unsigned int	minPrecision (unsigned int prec) noexcept
	Set the minimum default precision.
Static Public Member Functions inherited from IOstreamOption
static floatFormat	floatFormatEnum (const word &fmtName, const floatFormat deflt=floatFormat::general)
	Lookup floatFormat enum corresponding to the string (general \| fixed \| scientific).
static floatFormat	floatFormatEnum (const word &key, const dictionary &dict, const floatFormat deflt=floatFormat::general)
	getOrDefault floatFormat from dictionary, warn only on bad enumeration.
static streamFormat	formatEnum (const word &fmtName, const streamFormat deflt=streamFormat::ASCII)
	Lookup streamFormat enum corresponding to the string (ascii \| binary).
static streamFormat	formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII)
	getOrDefault streamFormat from dictionary, warn only on bad enumeration.
static compressionType	compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED)
	The compression enum corresponding to the string.
static compressionType	compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED)
	getOrDefault compressionType from dictionary, warn only on bad enumeration.
Static Public Attributes inherited from IOstream
static unsigned int	precision_
	Default precision.
Static Public Attributes inherited from IOstreamOption
static const Enum< floatFormat >	floatFormatNames
	Names for float formats (general, fixed, scientific).
static const Enum< streamFormat >	formatNames
	Stream format names (ascii, binary).
static const versionNumber	currentVersion
	The current version number (2.0).
Protected Member Functions inherited from Istream
bool	hasPutback () const noexcept
	True if putback token is in use.
Protected Member Functions inherited from IOstream
void	setOpened () noexcept
	Set stream opened.
void	setClosed () noexcept
	Set stream closed.
void	setState (std::ios_base::iostate state) noexcept
	Set stream state.
void	setGood () noexcept
	Set stream state to be good.
Protected Attributes inherited from IOstream
std::ios_base::iostate	ioState_
	Mirror of internal stream io state.
streamAccess	openClosed_
	The stream open/closed state.
unsigned char	sizeofLabel_
	The sizeof (label), possibly read from the header.
unsigned char	sizeofScalar_
	The sizeof (scalar), possibly read from the header.
label	lineNumber_
	The file line.
Static Protected Attributes inherited from IOstream
static fileName	staticName_
	Name for any generic stream - normally treat as readonly.

Detailed Description

Generic input stream using a standard (STL) stream.

Source files

Definition at line 51 of file ISstream.H.

Constructor & Destructor Documentation

◆ ISstream() [1/3]

ISstream	(	std::istream &	is,
		const string &	streamName,
		IOstreamOption	streamOpt = IOstreamOption() )

inline

Construct wrapper around std::istream, set stream status.

Default stream options (ASCII, uncompressed)

Definition at line 24 of file ISstreamI.H.

References Istream::Istream().

Referenced by ICharStream::ICharStream(), IFstream::IFstream(), ISpanStream::ISpanStream(), ISstream(), ISstream(), IStringStream::IStringStream(), IStringStream::IStringStream(), IStringStream::IStringStream(), and IStringStream::IStringStream().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ISstream() [2/3]

ISstream	(	std::istream &	is,
		const string &	streamName,
		IOstreamOption::streamFormat	fmt,
		IOstreamOption::compressionType	cmp = IOstreamOption::UNCOMPRESSED )

inline

Construct wrapper around std::istream, set stream status.

Definition at line 106 of file ISstream.H.

References ISstream(), and IOstreamOption::UNCOMPRESSED.

Here is the call graph for this function:

◆ ISstream() [3/3]

ISstream	(	std::istream &	is,
		const string &	streamName,
		IOstreamOption::streamFormat	fmt,
		IOstreamOption::versionNumber	ver,
		IOstreamOption::compressionType	cmp = IOstreamOption::UNCOMPRESSED )

inline

Construct wrapper around std::istream, set stream status.

Definition at line 120 of file ISstream.H.

References ISstream(), and IOstreamOption::UNCOMPRESSED.

Here is the call graph for this function:

◆ ~ISstream()

virtual ~ISstream ( )

virtualdefault

Destructor.

Member Function Documentation

◆ name() [1/2]

virtual const fileName & name ( ) const

inlineoverridevirtual

The name of the input serial stream. (eg, the name of the Fstream file name).

Reimplemented from IOstream.

Reimplemented in IFstream.

Definition at line 147 of file ISstream.H.

Referenced by dynamicCode::copyAndFilter(), IStringStream::IStringStream(), print(), decomposedBlockData::readBlock(), ensightSurfaceReader::readCase(), FIREMeshReader::readCells(), FIREMeshReader::readFaces(), decomposedBlockData::readHeader(), FIRECore::readPoints(), and IFstream::~IFstream().

Here is the caller graph for this function:

◆ name() [2/2]

virtual fileName & name ( )

inlinevirtual

The name of the input serial stream, for modification.

Use with caution since some classes (eg, Fstream) also use this for filesystem information!

Reimplemented in IFstream.

Definition at line 155 of file ISstream.H.

◆ stdStream() [1/2]

virtual const std::istream & stdStream ( ) const

inlinevirtual

Const access to underlying std::istream.

Reimplemented in IFstream.

Definition at line 163 of file ISstream.H.

Referenced by FIRECore::getFireLabel(), FIRECore::getFirePoint(), FIRECore::getFireString(), rewind(), and Foam::skipComments().

Here is the caller graph for this function:

◆ stdStream() [2/2]

virtual std::istream & stdStream ( )

inlinevirtual

Access to underlying std::istream.

Reimplemented in IFstream.

Definition at line 168 of file ISstream.H.

◆ flags() [1/2]

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

inlineoverridevirtual

Return current stream flags.

Implements IOstream.

Reimplemented in dummyISstream.

Definition at line 176 of file ISstream.H.

◆ flags() [2/2]

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

inlineoverridevirtual

Set stream flags, return old stream flags.

Implements IOstream.

Reimplemented in dummyISstream.

Definition at line 184 of file ISstream.H.

References f().

Here is the call graph for this function:

◆ syncState()

void syncState ( )

inline

Set stream state to match that of the std::istream.

Definition at line 195 of file ISstream.H.

References IOstream::setState().

Referenced by beginRawRead(), endRawRead(), get(), FIRECore::getFireLabel(), FIRECore::getFirePoint(), FIRECore::getFireString(), getLine(), getLine(), Foam::getPrimitive(), putback(), ensightReadFile::read(), read(), read(), read(), read(), read(), read(), read(), Foam::readEnsightString(), readRaw(), ICharStream::release(), ICharStream::reset(), ISpanStream::reset(), ISpanStream::reset(), ISpanStream::reset(), ICharStream::rewind(), ISpanStream::rewind(), ICharStream::seek(), ISpanStream::seek(), ensightReadFile::seekTime(), Foam::skipComments(), ICharStream::swap(), and ICharStream::swap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ seekCommentEnd_Cstyle()

bool seekCommentEnd_Cstyle ( )

Discard until end of C-style comment '.

Definition at line 84 of file ISstream.C.

References get().

Referenced by Foam::readUntilBalancedDelimiter(), and Foam::readVariable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ continueReadUntilRightBrace()

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

Raw, low-level get into a string. Continues reading after an initial left-brace until it finds the matching closing right-brace.

Tracks balanced pairs, trims out leading/trailing whitespace.

Returns: False if stream exhausted before finding closing brace

Definition at line 517 of file ISstream.C.

References token::BEGIN_BLOCK, token::END_BLOCK, and Foam::readUntilBalancedDelimiter().

Here is the call graph for this function:

◆ get()

Foam::ISstream & get ( char & c )

inline

Raw, low-level get character function.

Definition at line 49 of file ISstreamI.H.

References get(), IOstream::good(), IOstream::lineNumber_, and syncState().

Referenced by get(), read(), read(), read(), Foam::ReadHex(), Foam::readToNewline(), Foam::readUntilBalancedDelimiter(), Foam::readVariable(), Foam::readVerbatim(), seekCommentEnd_Cstyle(), and IFstream::~IFstream().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ peek()

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 63 of file ISstreamI.H.

Referenced by read(), ABAQUSCore::readHelper::readElements(), ABAQUSCore::readHelper::readPoints(), ABAQUSCore::readHelper::readSurfaceElements(), and Foam::readVariable().

Here is the caller graph for this function:

◆ getLine() [1/2]

Foam::ISstream & getLine	(	std::string &	str,
		char	delim = '\n' )

inline

Raw, low-level getline (until delimiter) into a string.

Definition at line 69 of file ISstreamI.H.

References IOstream::lineNumber_, and syncState().

Referenced by fileRegEx::apply(), dynamicCode::copyAndFilter(), AC3DsurfaceFormatCore::cueTo(), FIRECore::getFireString(), edgeMeshFormatsCore::getLineNoComment(), surfaceFormatsCore::getLineNoComment(), csvTableReader< Type >::operator()(), foamReport::parseTemplate(), ABAQUSCore::readHelper::read(), AC3DsurfaceFormat< Face >::read(), NASedgeFormat::read(), NASsurfaceFormat< Face >::read(), AC3DsurfaceFormatCore::readCmd(), externalCoupledMixedFvPatchField< Type >::readData(), ABAQUSCore::readHelper::readElements(), Foam::readEnsightString(), STARCDsurfaceFormatCore::readInpCellTable(), ensightSurfaceReader::readLine(), lumpedPointState::readPlain(), ABAQUSCore::readHelper::readPoints(), ABAQUSCore::readHelper::readSurfaceElements(), Foam::readUntilBalancedDelimiter(), Foam::readVariable(), and Foam::skipComments().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLine() [2/2]

std::streamsize getLine	(	std::nullptr_t	,
		char	delim = '\n' )

inline

Low-level discard until delimiter.

Returns: the number of characters extracted

Definition at line 84 of file ISstreamI.H.

References IOstream::lineNumber_, and syncState().

Here is the call graph for this function:

◆ putback()

Foam::ISstream & putback ( const char c )

inline

Raw, low-level putback character function.

Definition at line 99 of file ISstreamI.H.

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

Referenced by read(), read(), Foam::readUntilBalancedDelimiter(), Foam::readVariable(), and Foam::readVerbatim().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read() [1/11]

Foam::Istream & read ( token & t )

overridevirtual

Return next token from stream.

Implements Istream.

Reimplemented in dummyISstream, and ensightReadFile.

Definition at line 535 of file ISstream.C.

References token::ASSIGN, IOstream::bad(), token::BEGIN_BLOCK, token::BEGIN_LIST, token::BEGIN_SQR, Foam::charToWord(), token::COLON, token::COMMA, token::DIRECTIVE, token::DIVIDE, token::DOLLAR, token::DQUOTE, token::END_BLOCK, token::END_LIST, token::END_SQR, token::END_STATEMENT, Foam::endl(), token::ERROR, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, get(), Istream::getBack(), token::HASH, token::int32Token(), token::int64Token(), IOWarningInFunction, token::compound::isCompound(), IOstream::lineNumber(), token::lineNumber(), token::MINUS, token::MULTIPLY, Foam::nl, peek(), token::PLUS, token::pToken(), putback(), Foam::read(), Foam::readCompoundToken(), Foam::readInt64(), Foam::readUint64(), Foam::readVariable(), Foam::readVerbatim(), token::reset(), token::setBad(), token::setType(), syncState(), token::uint32Token(), token::uint64Token(), word::valid(), and token::VERBATIM.

Referenced by Foam::parseStream(), STARCDedgeFormat::read(), STARCDsurfaceFormat< Face >::read(), STARCDMeshReader::readBoundary(), STARCDMeshReader::readCells(), STARCDCore::readPoints(), and STARCDMeshReader::readPoints().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read() [2/11]

Foam::Istream & read ( char & c )

overridevirtual

Read a character.

Implements Istream.

Reimplemented in dummyISstream, and ensightReadFile.

Definition at line 883 of file ISstream.C.

◆ read() [3/11]

Foam::Istream & read ( word & str )

overridevirtual

Read a word.

Implements Istream.

Reimplemented in dummyISstream, and ensightReadFile.

Definition at line 890 of file ISstream.C.

References IOstream::bad(), token::BEGIN_LIST, token::END_LIST, Foam::endl(), errLen, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, get(), IOWarningInFunction, string::length(), Foam::nl, putback(), and word::valid().

Here is the call graph for this function:

◆ read() [4/11]

Foam::Istream & read ( string & str )

overridevirtual

Read a string (including enclosing double-quotes).

Backslashes are retained, except when escaping double-quotes and an embedded newline character.

Implements Istream.

Reimplemented in dummyISstream, and ensightReadFile.

Definition at line 970 of file ISstream.C.

References token::DQUOTE, errLen, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, get(), string::length(), and token::NL.

Here is the call graph for this function:

◆ read() [5/11]

Foam::Istream & read ( int32_t & val )

overridevirtual

Read int32_t.

Implements Istream.

Reimplemented in dummyISstream, and ensightReadFile.

Definition at line 1071 of file ISstream.C.

References syncState().

Here is the call graph for this function:

◆ read() [6/11]

Foam::Istream & read ( int64_t & val )

overridevirtual

Read int64_t.

Implements Istream.

Reimplemented in dummyISstream, and ensightReadFile.

Definition at line 1079 of file ISstream.C.

References syncState().

Here is the call graph for this function:

◆ read() [7/11]

Foam::Istream & read ( uint32_t & val )

overridevirtual

Read uint32_t.

Implements Istream.

Reimplemented in dummyISstream, and ensightReadFile.

Definition at line 1087 of file ISstream.C.

References syncState().

Here is the call graph for this function:

◆ read() [8/11]

Foam::Istream & read ( uint64_t & val )

overridevirtual

Read uint64_t.

Implements Istream.

Reimplemented in dummyISstream, and ensightReadFile.

Definition at line 1095 of file ISstream.C.

References syncState().

Here is the call graph for this function:

◆ read() [9/11]

Foam::Istream & read ( float & val )

overridevirtual

Read a float.

Implements Istream.

Reimplemented in dummyISstream, and ensightReadFile.

Definition at line 1103 of file ISstream.C.

References syncState().

Here is the call graph for this function:

◆ read() [10/11]

Foam::Istream & read ( double & val )

overridevirtual

Read a double.

Implements Istream.

Reimplemented in dummyISstream, and ensightReadFile.

Definition at line 1111 of file ISstream.C.

References syncState().

Here is the call graph for this function:

◆ read() [11/11]

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

overridevirtual

Read binary block (with any possible block delimiters). Reading into a null pointer behaves like a forward seek of count characters.

Implements Istream.

Reimplemented in dummyISstream, and ensightReadFile.

Definition at line 1119 of file ISstream.C.

References beginRawRead(), endRawRead(), and readRaw().

Here is the call graph for this function:

◆ readRaw()

Foam::Istream & readRaw	(	char *	data,
		std::streamsize	count )

overridevirtual

Low-level raw binary read (without possible block delimiters). Reading into a null pointer behaves like a forward seek of count characters.

Implements Istream.

Reimplemented in dummyISstream.

Definition at line 1129 of file ISstream.C.

References syncState().

Referenced by read(), and IFstream::readContents().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ beginRawRead()

bool beginRawRead ( )

overridevirtual

Start of low-level raw binary read.

Implements Istream.

Reimplemented in dummyISstream.

Definition at line 1147 of file ISstream.C.

References IOstreamOption::BINARY, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, format(), Istream::readBegin(), and syncState().

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ endRawRead()

bool endRawRead ( )

overridevirtual

End of low-level raw binary read.

Implements Istream.

Reimplemented in dummyISstream.

Definition at line 1162 of file ISstream.C.

References Istream::readEnd(), and syncState().

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rewind()

void rewind ( )

overridevirtual

Rewind the stream so that it may be read again.

Implements Istream.

Reimplemented in dummyISstream, ICharStream, IFstream, and ISpanStream.

Definition at line 1170 of file ISstream.C.

References IOstream::lineNumber_, Istream::rewind(), IOstream::setGood(), and stdStream().

Referenced by IStringStream::reset(), and IFstream::rewind().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ print()

void print ( Ostream & os ) const

overridevirtual

Print stream description to Ostream.

Reimplemented from IOstream.

Reimplemented in ICharStream, IFstream, ISpanStream, and IStringStream.

Definition at line 30 of file SstreamsPrint.C.

References name(), os(), and IOstream::print().

Referenced by IFstream::print().

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:

src/OpenFOAM/db/IOstreams/Sstreams/ISstream.H
src/OpenFOAM/db/IOstreams/Sstreams/ISstream.C
src/OpenFOAM/db/IOstreams/Sstreams/ISstreamI.H
src/OpenFOAM/db/IOstreams/Sstreams/SstreamsPrint.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ISstream() [1/3]

◆ ISstream() [2/3]

◆ ISstream() [3/3]

◆ ~ISstream()

Member Function Documentation

◆ name() [1/2]

◆ name() [2/2]

◆ stdStream() [1/2]

◆ stdStream() [2/2]

◆ flags() [1/2]

◆ flags() [2/2]

◆ syncState()

◆ seekCommentEnd_Cstyle()

◆ continueReadUntilRightBrace()

◆ get()

◆ peek()

◆ getLine() [1/2]

◆ getLine() [2/2]

◆ putback()

◆ read() [1/11]

◆ read() [2/11]

◆ read() [3/11]

◆ read() [4/11]

◆ read() [5/11]

◆ read() [6/11]

◆ read() [7/11]

◆ read() [8/11]

◆ read() [9/11]

◆ read() [10/11]

◆ read() [11/11]

◆ readRaw()

◆ beginRawRead()

◆ endRawRead()

◆ rewind()

◆ print()