An Istream is an abstract base class for all input systems (streams, files, token lists etc). The basic operations are construct, close, read token, read primitive and read binary block. More...

Inheritance diagram for Istream:

[legend]

Collaboration diagram for Istream:

[legend]

Public Member Functions
	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...

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

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

virtual Istream &	read (word &)=0
	Read a word. More...

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

virtual Istream &	read (label &)=0
	Read a label. More...

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

virtual Istream &	read (doubleScalar &)=0
	Read a doubleScalar. More...

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

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

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

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

virtual void	rewind ()=0
	Rewind the stream so that it may be read again. 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...

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

virtual fileName &	name ()
	Return stream name for modification. 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...

virtual ios_base::fmtflags	flags () const =0
	Return flags of stream. 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...

virtual ios_base::fmtflags	flags (const ios_base::fmtflags f)=0
	Set flags of stream. 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...

virtual void	print (Ostream &os) const
	Print stream description to Ostream. 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...

Protected Member Functions
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...

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

An Istream is an abstract base class for all input systems (streams, files, token lists etc). The basic operations are construct, close, read token, read primitive and read binary block.

In addition, version control and line number counting is incorporated. Usually one would use the read primitive member functions, but if one were reading a stream on unknown data sequence one can read token by token, and then analyse.

Source files

Definition at line 61 of file Istream.H.

Constructor & Destructor Documentation

◆ Istream() [1/3]

Istream ( const Istream & )

default

Copy construct.

◆ ~Istream()

virtual ~Istream ( )

virtualdefault

Destructor.

◆ Istream() [2/3]

Istream ( IOstreamOption streamOpt = IOstreamOption() )

inlineexplicit

Default construct (ASCII, uncompressed), construct with specified stream option.

Definition at line 100 of file Istream.H.

◆ Istream() [3/3]

Istream	(	IOstreamOption::streamFormat	fmt,
		IOstreamOption::versionNumber	ver = `IOstreamOption::currentVersion`,
		IOstreamOption::compressionType	cmp = `IOstreamOption::UNCOMPRESSED`
	)

inlineexplicit

Construct with format, version (compression)

Definition at line 108 of file Istream.H.

Member Function Documentation

◆ hasPutback()

bool hasPutback ( ) const

inlineprotectednoexcept

True if putback token is in use.

Definition at line 79 of file Istream.H.

Referenced by ITstream::hasPutback(), and ITstream::peek().

Here is the caller graph for this function:

◆ peekBack() [1/2]

const Foam::token & peekBack ( ) const

noexcept

Examine putback token without removing it.

Returns const reference to token::undefinedToken if a putback is unavailable.

Definition at line 49 of file Istream.C.

References token::undefinedToken.

Referenced by ITstream::peek().

Here is the caller graph for this function:

◆ peekBack() [2/2]

bool peekBack ( token & tok )

Fetch putback token without removing it.

Returns: false sets the token to undefined if no put-back was available

Definition at line 55 of file Istream.C.

References token::reset().

Here is the call graph for this function:

◆ putBack()

void putBack ( const token & tok )

Put back a token. Only a single put back is permitted.

Definition at line 70 of file Istream.C.

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

Referenced by arcEdge::arcEdge(), blockDescriptor::blockDescriptor(), BSplineEdge::BSplineEdge(), CrankNicolsonDdtScheme< Type >::CrankNicolsonDdtScheme(), dictionaryListEntry::dictionaryListEntry(), ifeqEntry::evaluate(), wordDirective::execute(), blockVertex::New(), entry::New(), block::New(), Foam::operator>>(), genericPatchFieldBase::processEntry(), Foam::blockMeshTools::read(), dimensionSet::read(), dictionary::read(), decomposedBlockData::readBlockEntry(), IOPosition< CloudType >::readData(), PtrList< transferModel >::readIstream(), LList< Foam::chemPointISAT< CompType, ThermoType > * >::readList(), List< vectorField >::readList(), PackedList< 2 >::readList(), FixedList< Type, 3 >::readList(), UList< Foam::wordRe >::readList(), functionEntry::readStringList(), Reaction< ReactionThermo >::setLRhs(), and splineEdge::splineEdge().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBack()

bool getBack ( token & tok )

Get the put-back token if there is one.

Returns: false and sets token to undefined if no put-back was available

Definition at line 92 of file Istream.C.

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

Referenced by UIPstream::read(), ISstream::read(), and ITstream::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read() [1/8]

virtual Istream& read ( token & )

pure virtual

Return next token from stream.

Implemented in ITstream, ISstream, UIPstream, and dummyISstream.

Referenced by CollidingParcel< ParcelType >::CollidingParcel(), DSMCParcel< ParcelType >::DSMCParcel(), findCellParticle::findCellParticle(), injectedParticle::injectedParticle(), KinematicParcel< ParcelType >::KinematicParcel(), molecule::molecule(), MPPICParcel< ParcelType >::MPPICParcel(), Foam::operator>>(), particle< Type >::particle(), ReactingParcel< ParcelType >::ReactingParcel(), ensightReadFile::read(), primitiveEntry::read(), dimensioned< vector >::read(), Foam::readChar(), Foam::readHexDigit(), List< vectorField >::readList(), UList< Foam::wordRe >::readList(), PackedList< 2 >::readList(), ISstream::readRaw(), solidParticle::solidParticle(), SprayParcel< ParcelType >::SprayParcel(), ThermoParcel< ParcelType >::ThermoParcel(), token::token(), trackedParticle::trackedParticle(), and wallBoundedParticle::wallBoundedParticle().

Here is the caller graph for this function:

◆ read() [2/8]

virtual Istream& read ( char & )

pure virtual

Read a character.

Implemented in ISstream, UIPstream, ITstream, and dummyISstream.

◆ read() [3/8]

virtual Istream& read ( word & )

pure virtual

Read a word.

Implemented in ISstream, UIPstream, ITstream, and dummyISstream.

◆ read() [4/8]

virtual Istream& read ( string & )

pure virtual

Read a string (including enclosing double-quotes)

Implemented in ensightReadFile, ISstream, UIPstream, ITstream, and dummyISstream.

◆ read() [5/8]

virtual Istream& read ( label & )

pure virtual

Read a label.

Implemented in ensightReadFile, ISstream, UIPstream, ITstream, and dummyISstream.

◆ read() [6/8]

virtual Istream& read ( floatScalar & )

pure virtual

Read a floatScalar.

Implemented in ISstream, UIPstream, ITstream, and dummyISstream.

◆ read() [7/8]

virtual Istream& read ( doubleScalar & )

pure virtual

Read a doubleScalar.

Implemented in ISstream, UIPstream, ITstream, and dummyISstream.

◆ read() [8/8]

virtual Istream& read	(	char *	,
		std::streamsize
	)

pure virtual

Read binary block.

Implemented in ITstream, UIPstream, ISstream, ensightReadFile, and dummyISstream.

◆ beginRawRead()

virtual bool beginRawRead ( )

pure virtual

Start of low-level raw binary read.

Implemented in ITstream, ISstream, UIPstream, and dummyISstream.

Referenced by CollidingParcel< ParcelType >::CollidingParcel(), DSMCParcel< ParcelType >::DSMCParcel(), findCellParticle::findCellParticle(), injectedParticle::injectedParticle(), KinematicParcel< ParcelType >::KinematicParcel(), molecule::molecule(), MPPICParcel< ParcelType >::MPPICParcel(), Foam::operator>>(), particle< Type >::particle(), ReactingParcel< ParcelType >::ReactingParcel(), Foam::Detail::readContiguous(), solidParticle::solidParticle(), SprayParcel< ParcelType >::SprayParcel(), ThermoParcel< ParcelType >::ThermoParcel(), trackedParticle::trackedParticle(), and wallBoundedParticle::wallBoundedParticle().

Here is the caller graph for this function:

◆ endRawRead()

virtual bool endRawRead ( )

pure virtual

End of low-level raw binary read.

Implemented in ITstream, ISstream, UIPstream, and dummyISstream.

Referenced by CollidingParcel< ParcelType >::CollidingParcel(), DSMCParcel< ParcelType >::DSMCParcel(), findCellParticle::findCellParticle(), injectedParticle::injectedParticle(), KinematicParcel< ParcelType >::KinematicParcel(), molecule::molecule(), MPPICParcel< ParcelType >::MPPICParcel(), Foam::operator>>(), particle< Type >::particle(), ReactingParcel< ParcelType >::ReactingParcel(), Foam::Detail::readContiguous(), solidParticle::solidParticle(), SprayParcel< ParcelType >::SprayParcel(), ThermoParcel< ParcelType >::ThermoParcel(), trackedParticle::trackedParticle(), and wallBoundedParticle::wallBoundedParticle().

Here is the caller graph for this function:

◆ readRaw()

virtual Istream& readRaw	(	char *	,
		std::streamsize
	)

pure virtual

Low-level raw binary read.

Implemented in ITstream, ISstream, UIPstream, and dummyISstream.

Referenced by Foam::Detail::readContiguous(), and Foam::readRawLabel().

Here is the caller graph for this function:

◆ rewind()

virtual void rewind ( )

pure virtual

Rewind the stream so that it may be read again.

Implemented in ITstream, UIListStream, ISstream, IListStream, UIPstream, dummyISstream, and IFstream.

◆ readBegin()

bool readBegin ( const char * funcName )

Begin read of data chunk, starts with '('.

Returns: true or FatalIOError

Definition at line 111 of file Istream.C.

References token::BEGIN_LIST, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, token::info(), and Foam::nl.

Referenced by Foam::input(), objectMap::objectMap(), Foam::operator>>(), PackedList< 2 >::setPair(), shellSurfaces::shellSurfaces(), and VectorSpace< Vector< vector >, vector, 3 >::VectorSpace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readEnd()

bool readEnd ( const char * funcName )

End read of data chunk, ends with ')'.

Returns: true or FatalIOError

Definition at line 129 of file Istream.C.

References token::END_LIST, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, token::info(), and Foam::nl.

Referenced by Foam::input(), objectMap::objectMap(), Foam::operator>>(), PackedList< 2 >::setPair(), shellSurfaces::shellSurfaces(), and VectorSpace< Vector< vector >, vector, 3 >::VectorSpace().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readBeginList()

char readBeginList ( const char * funcName )

Begin read of list data, starts with '(' or '{'.

Returns: starting delimiter or FatalIOError

Definition at line 148 of file Istream.C.

References token::BEGIN_BLOCK, token::BEGIN_LIST, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, token::info(), and token::pToken().

Referenced by dictionaryListEntry::dictionaryListEntry(), Foam::blockMeshTools::read(), IOPosition< CloudType >::readData(), PtrList< transferModel >::readIstream(), LList< Foam::chemPointISAT< CompType, ThermoType > * >::readList(), List< vectorField >::readList(), PackedList< 2 >::readList(), FixedList< Type, 3 >::readList(), UList< Foam::wordRe >::readList(), and Matrix< RectangularMatrix< Type >, Type >::readMatrix().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readEndList()

char readEndList ( const char * funcName )

End read of list data, ends with ')' or '}'.

Returns: closing delimiter or FatalIOError

Definition at line 169 of file Istream.C.

References token::END_BLOCK, token::END_LIST, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, token::info(), Foam::nl, and token::pToken().

Referenced by dictionaryListEntry::dictionaryListEntry(), Foam::blockMeshTools::read(), IOPosition< CloudType >::readData(), PtrList< transferModel >::readIstream(), LList< Foam::chemPointISAT< CompType, ThermoType > * >::readList(), List< vectorField >::readList(), PackedList< 2 >::readList(), FixedList< Type, 3 >::readList(), UList< Foam::wordRe >::readList(), and Matrix< RectangularMatrix< Type >, Type >::readMatrix().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator()()

Foam::Istream & operator() ( ) const

Return a non-const reference to const Istream.

Needed for read-constructors where the stream argument is temporary

Definition at line 191 of file Istream.C.

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

Here is the call graph for this function:

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

src/OpenFOAM/db/IOstreams/IOstreams/Istream.H
src/OpenFOAM/db/IOstreams/IOstreams/Istream.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Istream() [1/3]

◆ ~Istream()

◆ Istream() [2/3]

◆ Istream() [3/3]

Member Function Documentation

◆ hasPutback()

◆ peekBack() [1/2]

◆ peekBack() [2/2]

◆ putBack()

◆ getBack()

◆ read() [1/8]

◆ read() [2/8]

◆ read() [3/8]

◆ read() [4/8]

◆ read() [5/8]

◆ read() [6/8]

◆ read() [7/8]

◆ read() [8/8]

◆ beginRawRead()

◆ endRawRead()

◆ readRaw()

◆ rewind()

◆ readBegin()

◆ readEnd()

◆ readBeginList()

◆ readEndList()

◆ operator()()