Dummy stream for input. Aborts at any attempt to read from it. More...

Inheritance diagram for dummyIstream:

Collaboration diagram for dummyIstream:

Public Member Functions
	dummyIstream ()=default
	Construct null. More...

	~dummyIstream ()=default
	Destructor. 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 &	readRaw (char *, std::streamsize)
	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 void	rewind ()
	Rewind the stream so that it may be read again. More...

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

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

Public Member Functions inherited from Istream
	Istream (streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
	Construct and set stream status. More...

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

void	putBack (const token &tok)
	Put back token. More...

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

bool	peekBack (token &tok)
	Peek at the put back token without removing it. 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 IOstreamOption option)
	Construct with specified stream option. More...

	IOstream (streamFormat format, versionNumber version, compressionType compression=UNCOMPRESSED)
	Construct with format, version. More...

virtual	~IOstream ()=default
	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 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 bool () const
	Return true if the stream has not failed. More...

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

unsigned	labelByteSize () const
	The label byte-size associated with the stream. More...

unsigned	scalarByteSize () const
	The scalar byte-size associated with the stream. More...

void	setLabelByteSize (unsigned nbytes)
	Set the label byte-size associated with the stream. More...

void	setScalarByteSize (unsigned nbytes)
	Set the scalar byte-size associated with the stream. More...

template<class T = label>
std::enable_if< std::is_integral< T >::value, bool >::type	checkLabelSize () const

template<class T = scalar>
std::enable_if< std::is_floating_point< T >::value, bool >::type	checkScalarSize () const

label	lineNumber () const
	Const access to the current stream line number. More...

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

label	lineNumber (const label num)
	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 f)
	Unset flags of stream. More...

virtual void	print (Ostream &os) const
	Print description of IOstream 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
	IOstreamOption () noexcept
	Construct null. (default: ASCII, uncompressed, currentVersion) More...

	IOstreamOption (streamFormat format) noexcept
	Construct with format. (default: uncompressed, currentVersion) More...

	IOstreamOption (streamFormat format, compressionType compression, versionNumber version=currentVersion) noexcept
	Construct with format and compression, optionally with version. More...

	IOstreamOption (streamFormat format, versionNumber version, compressionType compression) noexcept
	Construct with format, version, compression. More...

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

streamFormat	format (const streamFormat format) 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 &compressionName)
	Set the stream compression, from string value. More...

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

versionNumber	version (const versionNumber verNum) noexcept
	Set the stream version. 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, 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 ()
	Return the default precision. More...

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

Static Public Member Functions inherited from IOstreamOption
static streamFormat	formatEnum (const word &formatName)
	The stream format enum corresponding to the string. More...

static compressionType	compressionEnum (const word &compName)
	The compression enum corresponding to the string. 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	originalVersion
	The original version number. More...

static const versionNumber	currentVersion
	The current version number. 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
streamAccess	openClosed_

ios_base::iostate	ioState_

unsigned short	labelByteSize_
	The label byte-size (could also be stored as byte) More...

unsigned short	scalarByteSize_
	The scalar byte-size (could also be stored as byte) 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

Dummy stream for input. Aborts at any attempt to read from it.

Source files

dummyIstream.H

Definition at line 50 of file dummyIstream.H.

Constructor & Destructor Documentation

◆ dummyIstream()

dummyIstream ( )

default

Construct null.

◆ ~dummyIstream()

~dummyIstream ( )

default

Destructor.

Member Function Documentation

◆ read() [1/8]

virtual Istream& read ( token & )

inlinevirtual

Return next token from stream.

Implements Istream.

Definition at line 71 of file dummyIstream.H.

References NotImplemented.

◆ read() [2/8]

virtual Istream& read ( char & )

inlinevirtual

Read a character.

Implements Istream.

Definition at line 78 of file dummyIstream.H.

References NotImplemented.

◆ read() [3/8]

virtual Istream& read ( word & )

inlinevirtual

Read a word.

Implements Istream.

Definition at line 85 of file dummyIstream.H.

References NotImplemented.

◆ read() [4/8]

virtual Istream& read ( string & )

inlinevirtual

Read a string (including enclosing double-quotes)

Implements Istream.

Definition at line 92 of file dummyIstream.H.

References NotImplemented.

◆ read() [5/8]

virtual Istream& read ( label & )

inlinevirtual

Read a label.

Implements Istream.

Definition at line 99 of file dummyIstream.H.

References NotImplemented.

◆ read() [6/8]

virtual Istream& read ( floatScalar & )

inlinevirtual

Read a floatScalar.

Implements Istream.

Definition at line 106 of file dummyIstream.H.

References NotImplemented.

◆ read() [7/8]

virtual Istream& read ( doubleScalar & )

inlinevirtual

Read a doubleScalar.

Implements Istream.

Definition at line 113 of file dummyIstream.H.

References NotImplemented.

◆ read() [8/8]

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

inlinevirtual

Read binary block.

Implements Istream.

Definition at line 120 of file dummyIstream.H.

References NotImplemented.

◆ readRaw()

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

inlinevirtual

Low-level raw binary read.

Implements Istream.

Definition at line 127 of file dummyIstream.H.

References NotImplemented.

◆ beginRawRead()

virtual bool beginRawRead ( )

inlinevirtual

Start of low-level raw binary read.

Implements Istream.

Definition at line 134 of file dummyIstream.H.

◆ endRawRead()

virtual bool endRawRead ( )

inlinevirtual

End of low-level raw binary read.

Implements Istream.

Definition at line 140 of file dummyIstream.H.

◆ rewind()

virtual void rewind ( )

inlinevirtual

Rewind the stream so that it may be read again.

Implements Istream.

Definition at line 146 of file dummyIstream.H.

◆ flags() [1/2]

virtual ios_base::fmtflags flags ( ) const

inlinevirtual

Return flags of stream.

Implements IOstream.

Definition at line 150 of file dummyIstream.H.

◆ flags() [2/2]

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

inlinevirtual

Set flags of stream.

Implements IOstream.

Definition at line 156 of file dummyIstream.H.

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

src/OpenFOAM/db/IOstreams/dummy/dummyIstream.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ dummyIstream()

◆ ~dummyIstream()

Member Function Documentation

◆ read() [1/8]

◆ read() [2/8]

◆ read() [3/8]

◆ read() [4/8]

◆ read() [5/8]

◆ read() [6/8]

◆ read() [7/8]

◆ read() [8/8]

◆ readRaw()

◆ beginRawRead()

◆ endRawRead()

◆ rewind()

◆ flags() [1/2]

◆ flags() [2/2]