Dummy input stream, which can be used as a placeholder for interfaces taking an Istream or ISstream. Aborts at any attempt to read from it. More...

Inheritance diagram for dummyISstream:

[legend]

Collaboration diagram for dummyISstream:

[legend]

Public Member Functions
	dummyISstream ()=default
	Default construct. More...

virtual	~dummyISstream ()=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 IStringStream
	IStringStream (streamFormat format=ASCII, versionNumber version=currentVersion)
	Default construct. More...

	IStringStream (const std::string &s, streamFormat format=ASCII, versionNumber version=currentVersion, const Foam::string &name="input")
	Construct from std::string. More...

	IStringStream (const char *s, streamFormat format=ASCII, versionNumber version=currentVersion, const Foam::string &name="input")
	Construct from char*. More...

	IStringStream (const IStringStream &str)
	Copy construct, copies content and format. More...

virtual void	reset (const std::string &s)
	Reset the input buffer and rewind the stream. More...

virtual void	print (Ostream &os) const
	Print stream description to Ostream. More...

Istream &	operator() () const
	Return a non-const reference to const Istream. More...

Public Member Functions inherited from StringStreamAllocator< std::istringstream >
Foam::string	str () const
	Get the string - as Foam::string rather than std::string. More...

void	str (const std::string &s)
	Set the string. More...

Public Member Functions inherited from ISstream
	ISstream (std::istream &is, const string &streamName, IOstreamOption streamOpt=IOstreamOption())
	Construct wrapper around std::istream, set stream status. More...

	ISstream (std::istream &is, const string &streamName, streamFormat fmt, versionNumber ver=currentVersion, compressionType comp=compressionType::UNCOMPRESSED)
	Construct wrapper around std::istream, set stream status. More...

virtual	~ISstream ()=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...

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

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

ISstream &	getLine (std::string &str, char delim='\n')
	Raw, low-level getline (until delimiter) into a string. More...

std::streamsize	getLine (std::nullptr_t, char delim='\n')
	Low-level discard until delimiter. More...

ISstream &	putback (const char c)
	Raw, low-level putback character function. More...

virtual std::istream &	stdStream ()
	Access to underlying std::istream. More...

virtual const std::istream &	stdStream () const
	Const access to underlying std::istream. More...

Public Member Functions inherited from Istream
	Istream (const Istream &)=default
	Copy construct. More...

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

	Istream (IOstreamOption streamOpt=IOstreamOption())

	Istream (streamFormat fmt, versionNumber ver=currentVersion, compressionType comp=compressionType::UNCOMPRESSED)
	Construct with format, version (compression) 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 IOstream &)=default
	Copy construct. More...

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

	IOstream (IOstreamOption streamOpt=IOstreamOption())

	IOstream (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED)
	Construct with format, version (compression) 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
	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...

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

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 ()
	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, 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 Types inherited from StringStreamAllocator< std::istringstream >
typedef std::istringstream	stream_type
	The stream type. More...

Protected Member Functions inherited from StringStreamAllocator< std::istringstream >
	StringStreamAllocator ()
	Default construct. More...

	StringStreamAllocator (const std::string &s)
	Copy construct from string. 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 StringStreamAllocator< std::istringstream >
stream_type	stream_
	The input/output stream. 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 input stream, which can be used as a placeholder for interfaces taking an Istream or ISstream. Aborts at any attempt to read from it.

Note: The inheritance from an empty IStringStream is solely for convenience of implementation and should not be relied upon.

Source files

Definition at line 56 of file dummyISstream.H.

Constructor & Destructor Documentation

◆ dummyISstream()

dummyISstream ( )

default

Default construct.

◆ ~dummyISstream()

virtual ~dummyISstream ( )

virtualdefault

Destructor.

Member Function Documentation

◆ read() [1/8]

virtual Istream& read ( token & )

inlinevirtual

Return next token from stream.

Reimplemented from ISstream.

Definition at line 76 of file dummyISstream.H.

References NotImplemented.

◆ read() [2/8]

virtual Istream& read ( char & )

inlinevirtual

Read a character.

Reimplemented from ISstream.

Definition at line 83 of file dummyISstream.H.

References NotImplemented.

◆ read() [3/8]

virtual Istream& read ( word & )

inlinevirtual

Read a word.

Reimplemented from ISstream.

Definition at line 90 of file dummyISstream.H.

References NotImplemented.

◆ read() [4/8]

virtual Istream& read ( string & str )

inlinevirtual

Read a string (including enclosing double-quotes).

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

Reimplemented from ISstream.

Definition at line 97 of file dummyISstream.H.

References NotImplemented.

◆ read() [5/8]

virtual Istream& read ( label & )

inlinevirtual

Read a label.

Reimplemented from ISstream.

Definition at line 104 of file dummyISstream.H.

References NotImplemented.

◆ read() [6/8]

virtual Istream& read ( floatScalar & )

inlinevirtual

Read a floatScalar.

Reimplemented from ISstream.

Definition at line 111 of file dummyISstream.H.

References NotImplemented.

◆ read() [7/8]

virtual Istream& read ( doubleScalar & )

inlinevirtual

Read a doubleScalar.

Reimplemented from ISstream.

Definition at line 118 of file dummyISstream.H.

References NotImplemented.

◆ read() [8/8]

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

inlinevirtual

Read binary block.

Reimplemented from ISstream.

Definition at line 125 of file dummyISstream.H.

References NotImplemented.

◆ readRaw()

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

inlinevirtual

Low-level raw binary read.

Reimplemented from ISstream.

Definition at line 132 of file dummyISstream.H.

References NotImplemented.

◆ beginRawRead()

virtual bool beginRawRead ( )

inlinevirtual

Start of low-level raw binary read.

Reimplemented from ISstream.

Definition at line 139 of file dummyISstream.H.

◆ endRawRead()

virtual bool endRawRead ( )

inlinevirtual

End of low-level raw binary read.

Reimplemented from ISstream.

Definition at line 145 of file dummyISstream.H.

◆ rewind()

virtual void rewind ( )

inlinevirtual

Rewind the stream so that it may be read again.

Reimplemented from ISstream.

Definition at line 151 of file dummyISstream.H.

◆ flags() [1/2]

virtual ios_base::fmtflags flags ( ) const

inlinevirtual

Return flags of stream.

Reimplemented from ISstream.

Definition at line 155 of file dummyISstream.H.

◆ flags() [2/2]

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

inlinevirtual

Set flags of stream.

Reimplemented from ISstream.

Definition at line 161 of file dummyISstream.H.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ dummyISstream()

◆ ~dummyISstream()

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]