Generic input stream. More...

Inheritance diagram for ISstream:

[legend]

Collaboration diagram for ISstream:

[legend]

Public Member Functions
	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 const fileName &	name () const
	Return the name of the stream. More...

virtual fileName &	name ()
	Return non-const access to the name of the stream. More...

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

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

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

ISstream &	getLine (string &)
	Raw, low-level getline into a string function. More...

ISstream &	putback (const char &)
	Raw, low-level putback character function. 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 (label &)
	Read a label. More...

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

virtual Istream &	read (doubleScalar &)
	Read a doubleScalar. 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...

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

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

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

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

Private Member Functions
char	nextValid ()

void	readWordToken (token &)

Istream &	readVerbatim (string &)
	Read a verbatim string (excluding block delimiters). More...

Istream &	readVariable (string &)
	Read a variable name (includes '{') More...

void	operator= (const ISstream &)
	Disallow default bitwise assignment. More...

Private Attributes
fileName	name_

istream &	is_

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	originalVersion
	Original version number. More...

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

Generic input stream.

Source files

Definition at line 51 of file ISstream.H.

Constructor & Destructor Documentation

◆ ISstream()

ISstream	(	istream &	is,
		const string &	name,
		streamFormat	format = `ASCII`,
		versionNumber	version = `currentVersion`,
		compressionType	compression = `UNCOMPRESSED`
	)

inline

Construct as wrapper around istream.

Definition at line 31 of file ISstreamI.H.

◆ ~ISstream()

virtual ~ISstream ( )

inlinevirtual

Destructor.

Definition at line 96 of file ISstream.H.

Member Function Documentation

◆ nextValid()

char nextValid ( )

private

Definition at line 33 of file ISstream.C.

References IOstream::bad(), Foam::constant::universal::c, ISstream::get(), IOstream::good(), Foam::isspace(), and ISstream::putback().

Here is the call graph for this function:

◆ readWordToken()

void readWordToken ( token & t )

private

Definition at line 111 of file ISstream.C.

References token::compound::isCompound(), token::compound::New(), Foam::read(), and token::setBad().

Here is the call graph for this function:

◆ readVerbatim()

Foam::Istream & readVerbatim ( string & str )

private

Read a verbatim string (excluding block delimiters).

Definition at line 703 of file ISstream.C.

References Foam::constant::universal::c, token::END_BLOCK, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and token::HASH.

Here is the call graph for this function:

◆ readVariable()

Foam::Istream & readVariable ( string & str )

private

Read a variable name (includes '{')

Definition at line 583 of file ISstream.C.

References token::BEGIN_BLOCK, Foam::constant::universal::c, token::END_BLOCK, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and word::valid().

Here is the call graph for this function:

◆ operator=()

void operator= ( const ISstream & )

private

Disallow default bitwise assignment.

◆ name() [1/2]

virtual const fileName& name ( ) const

inlinevirtual

Return the name of the stream.

Useful for Fstream to return the filename

Reimplemented from IOstream.

Reimplemented in IFstream.

Definition at line 106 of file ISstream.H.

Referenced by dynamicCode::copyAndFilter(), IStringStream::print(), and ISstream::print().

Here is the caller graph for this function:

◆ name() [2/2]

virtual fileName& name ( )

inlinevirtual

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

Useful to alter the stream name

Reimplemented from IOstream.

Reimplemented in IFstream.

Definition at line 113 of file ISstream.H.

◆ flags() [1/2]

std::ios_base::fmtflags flags ( ) const

virtual

Return flags of output stream.

Implements IOstream.

Definition at line 812 of file ISstream.C.

◆ get()

Foam::ISstream & get ( char & c )

inline

Raw, low-level get character function.

Definition at line 57 of file ISstreamI.H.

References Foam::constant::universal::c, IOstream::good(), ISstream::is_, IOstream::lineNumber_, and IOstream::setState().

Referenced by ISstream::nextValid(), and Foam::ReadHex().

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

Referenced by main().

Here is the caller graph for this function:

◆ getLine()

Foam::ISstream & getLine ( string & s )

inline

Raw, low-level getline into a string function.

Definition at line 77 of file ISstreamI.H.

References s().

Referenced by dynamicCode::copyAndFilter(), AC3DsurfaceFormatCore::cueTo(), edgeMeshFormatsCore::getLineNoComment(), surfaceFormatsCore::getLineNoComment(), triSurface::getLineNoComment(), main(), csvTableReader< Type >::operator()(), NASedgeFormat::read(), NASsurfaceFormat< Face >::read(), AC3DsurfaceFormat< Face >::read(), CSV::read(), vtkUnstructuredReader::read(), triSurface::readAC(), Foam::readCmd(), AC3DsurfaceFormatCore::readCmd(), externalCoupledMixedFvPatchField< scalar >::readData(), externalCoupledTemperatureMixedFvPatchScalarField::readData(), vtkUnstructuredReader::readField(), STARCDCore::readHeader(), STARCDsurfaceFormatCore::readInpCellTable(), triSurface::readNAS(), Foam::readUpto(), and memInfo::update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ putback()

Foam::ISstream & putback ( const char & c )

inline

Raw, low-level putback character function.

Definition at line 87 of file ISstreamI.H.

References Foam::constant::universal::c.

Referenced by ISstream::nextValid().

Here is the caller graph for this function:

◆ read() [1/8]

Foam::Istream & read ( token & t )

virtual

Return next token from stream.

Implements Istream.

Definition at line 132 of file ISstream.C.

References token::ADD, token::ASSIGN, token::BEGIN_BLOCK, token::BEGIN_LIST, token::BEGIN_SQR, token::BEGIN_STRING, Foam::constant::universal::c, token::COLON, token::COMMA, token::DIVIDE, token::END_BLOCK, token::END_LIST, token::END_SQR, token::END_STATEMENT, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Istream::getBack(), token::HASH, token::lineNumber(), token::MULTIPLY, Foam::read(), Foam::readScalar(), token::setBad(), token::SUBTRACT, token::type(), token::VARIABLE, and token::VERBATIMSTRING.

Referenced by dictionary::tokens().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read() [2/8]

Foam::Istream & read ( char & c )

virtual

Read a character.

Implements Istream.

Definition at line 403 of file ISstream.C.

References Foam::constant::universal::c.

◆ read() [3/8]

Foam::Istream & read ( word & str )

virtual

Read a word.

Implements Istream.

Definition at line 410 of file ISstream.C.

References token::BEGIN_LIST, Foam::constant::universal::c, token::END_LIST, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and word::valid().

Here is the call graph for this function:

◆ read() [4/8]

Foam::Istream & read ( string & str )

virtual

Read a string (including enclosing double-quotes).

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

Implements Istream.

Definition at line 481 of file ISstream.C.

References token::BEGIN_STRING, Foam::constant::universal::c, token::END_STRING, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and token::NL.

Here is the call graph for this function:

◆ read() [5/8]

Foam::Istream & read ( label & val )

virtual

Read a label.

Implements Istream.

Definition at line 757 of file ISstream.C.

◆ read() [6/8]

Foam::Istream & read ( floatScalar & val )

virtual

Read a floatScalar.

Implements Istream.

Definition at line 765 of file ISstream.C.

◆ read() [7/8]

Foam::Istream & read ( doubleScalar & val )

virtual

Read a doubleScalar.

Implements Istream.

Definition at line 773 of file ISstream.C.

◆ read() [8/8]

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

virtual

Read binary block.

Implements Istream.

Definition at line 782 of file ISstream.C.

References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and format().

Here is the call graph for this function:

◆ rewind()

Foam::Istream & rewind ( )

virtual

Rewind and return the stream so that it may be read again.

Implements Istream.

Definition at line 801 of file ISstream.C.

◆ flags() [2/2]

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

virtual

Set flags of output stream.

Implements IOstream.

Definition at line 818 of file ISstream.C.

References f().

Here is the call graph for this function:

◆ stdStream() [1/2]

virtual istream& stdStream ( )

inlinevirtual

Access to underlying std::istream.

Reimplemented in IFstream.

Definition at line 178 of file ISstream.H.

References ISstream::is_.

Referenced by IStringStream::str(), and IStringStream::~IStringStream().

Here is the caller graph for this function:

◆ stdStream() [2/2]

virtual const istream& stdStream ( ) const

inlinevirtual

Const access to underlying std::istream.

Reimplemented in IFstream.

Definition at line 184 of file ISstream.H.

References ISstream::is_.

◆ print()

void print ( Ostream & os ) const

virtual

Print description of IOstream to Ostream.

Reimplemented from IOstream.

Reimplemented in IFstream, and IStringStream.

Definition at line 34 of file SstreamsPrint.C.

References ISstream::is_, ISstream::name(), and IOstream::print().

Referenced by IStringStream::print(), and IFstream::print().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ name_

fileName name_

private

Definition at line 57 of file ISstream.H.

◆ is_

istream& is_

private

Definition at line 58 of file ISstream.H.

Referenced by ISstream::get(), ISstream::print(), and ISstream::stdStream().

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

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ISstream()

◆ ~ISstream()

Member Function Documentation

◆ nextValid()

◆ readWordToken()

◆ readVerbatim()

◆ readVariable()

◆ operator=()

◆ name() [1/2]

◆ name() [2/2]

◆ flags() [1/2]

◆ get()

◆ peek()

◆ getLine()

◆ putback()

◆ read() [1/8]

◆ read() [2/8]

◆ read() [3/8]

◆ read() [4/8]

◆ read() [5/8]

◆ read() [6/8]

◆ read() [7/8]

◆ read() [8/8]

◆ rewind()

◆ flags() [2/2]

◆ stdStream() [1/2]

◆ stdStream() [2/2]

◆ print()

Field Documentation

◆ name_

◆ is_