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 ()
	Construct null. More...

	~dummyIstream ()
	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 &)

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
	Return flags of stream. More...

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

virtual void	print (Ostream &) const
	Print description of IOstream to Ostream. More...

void	print (Ostream &, const int streamState) const
	Check given stream state bits. More...

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

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

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

Source files

dummyIstream.H

Definition at line 48 of file dummyIstream.H.

Constructor & Destructor Documentation

◆ dummyIstream()

dummyIstream ( )

inline

Construct null.

Definition at line 58 of file dummyIstream.H.

◆ ~dummyIstream()

~dummyIstream ( )

inline

Destructor.

Definition at line 65 of file dummyIstream.H.

Member Function Documentation

◆ read() [1/8]

virtual Istream& read ( token & )

inlinevirtual

Return next token from stream.

Implements Istream.

Definition at line 74 of file dummyIstream.H.

References NotImplemented.

◆ read() [2/8]

virtual Istream& read ( char & )

inlinevirtual

Read a character.

Implements Istream.

Definition at line 81 of file dummyIstream.H.

References NotImplemented.

◆ read() [3/8]

virtual Istream& read ( word & )

inlinevirtual

Read a word.

Implements Istream.

Definition at line 88 of file dummyIstream.H.

References NotImplemented.

◆ read() [4/8]

virtual Istream& read ( string & )

inlinevirtual

Implements Istream.

Definition at line 95 of file dummyIstream.H.

References NotImplemented.

◆ read() [5/8]

virtual Istream& read ( label & )

inlinevirtual

Read a label.

Implements Istream.

Definition at line 102 of file dummyIstream.H.

References NotImplemented.

◆ read() [6/8]

virtual Istream& read ( floatScalar & )

inlinevirtual

Read a floatScalar.

Implements Istream.

Definition at line 109 of file dummyIstream.H.

References NotImplemented.

◆ read() [7/8]

virtual Istream& read ( doubleScalar & )

inlinevirtual

Read a doubleScalar.

Implements Istream.

Definition at line 116 of file dummyIstream.H.

References NotImplemented.

◆ read() [8/8]

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

inlinevirtual

Read binary block.

Implements Istream.

Definition at line 123 of file dummyIstream.H.

References NotImplemented.

◆ rewind()

virtual Istream& rewind ( )

inlinevirtual

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

Implements Istream.

Definition at line 130 of file dummyIstream.H.

References NotImplemented.

◆ flags() [1/2]

virtual ios_base::fmtflags flags ( ) const

inlinevirtual

Return flags of stream.

Implements IOstream.

Definition at line 137 of file dummyIstream.H.

References NotImplemented.

◆ flags() [2/2]

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

inlinevirtual

Set flags of stream.

Implements IOstream.

Definition at line 144 of file dummyIstream.H.

References f(), and NotImplemented.

Here is the call graph for this function:

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

src/OpenFOAM/db/IOstreams/dummyIstream/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]

◆ rewind()

◆ flags() [1/2]

◆ flags() [2/2]