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

#include <dummyISstream.H>

Inheritance diagram for dummyISstream:

[legend]

Collaboration diagram for dummyISstream:

[legend]

Public Member Functions
	dummyISstream ()=default
	Default construct.
virtual	~dummyISstream ()=default
	Destructor.
virtual std::ios_base::fmtflags	flags () const override
	Return current stream flags. Dummy for dummy stream, returns 0.
virtual std::ios_base::fmtflags	flags (std::ios_base::fmtflags) override
	Set stream flags, return old stream flags. Dummy for dummy stream, returns 0.
virtual Istream &	read (token &) override
	Return next token from stream.
virtual Istream &	read (char &) override
	Read a character.
virtual Istream &	read (word &) override
	Read a word.
virtual Istream &	read (string &) override
	Read a string (including enclosing double-quotes).
virtual Istream &	read (int32_t &) override
	Read int32_t.
virtual Istream &	read (int64_t &) override
	Read int64_t.
virtual Istream &	read (uint32_t &) override
	Read uint32_t.
virtual Istream &	read (uint64_t &) override
	Read uint64_t.
virtual Istream &	read (float &) override
	Read a float.
virtual Istream &	read (double &) override
	Read a double.
virtual Istream &	read (char *, std::streamsize) override
	Read binary block.
virtual Istream &	readRaw (char *, std::streamsize) override
	Low-level raw binary read.
virtual bool	beginRawRead () override
	Start of low-level raw binary read.
virtual bool	endRawRead () override
	End of low-level raw binary read.
virtual void	rewind () override
	Rewind the stream so that it may be read again.
Public Member Functions inherited from ICharStream
	ICharStream (IOstreamOption streamOpt=IOstreamOption())
	Default construct (empty), optionally with specified stream option.
	ICharStream (const std::string &buffer, IOstreamOption streamOpt=IOstreamOption())
	Copy construct from string content.
	ICharStream (List< char > &&buffer, IOstreamOption streamOpt=IOstreamOption())
	Move construct from List.
template<int SizeMin>
	ICharStream (DynamicList< char, SizeMin > &&buffer, IOstreamOption streamOpt=IOstreamOption())
	Move construct from DynamicList (uses current size).
std::streampos	tellg () const
	Position of the get buffer.
std::streampos	input_pos () const
	The current get position within the buffer (tellg).
label	size () const
	The input list size. Same as capacity().
std::streamsize	capacity () const
	The get buffer capacity.
std::streamsize	remaining () const
	The number of characters remaining in the get area. Same as (capacity() - input_pos()).
auto	view () const
	A string_view of buffer contents.
auto	view (size_t pos, size_t len=std::string::npos) const
	A sub-slice string view of the buffer contents.
UList< char >	list () const
	A list span of the input characters (is modifiable!).
auto	str () const
	For IStringStream compatibility, return the buffer as string copy.
void	reset (const char *buffer, size_t nbytes)
	Reset content (copy).
void	swap (List< char > &other)
	Exchange stream content and parameter contents, reset positions.
template<int SizeMin>
void	swap (DynamicList< char, SizeMin > &other)
	Exchange stream content and parameter contents, reset positions.
DynamicList< char >	release ()
	Reset stream and return contents as a List.
void	seek (std::streampos pos)
	Reposition the stream from the start.
virtual void	print (Ostream &os) const override
	Print stream description.
Istream &	operator() () const
	A non-const reference to const Istream.
Public Member Functions inherited from ISstream
	ISstream (std::istream &is, const string &streamName, IOstreamOption streamOpt=IOstreamOption())
	Construct wrapper around std::istream, set stream status.
	ISstream (std::istream &is, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct wrapper around std::istream, set stream status.
	ISstream (std::istream &is, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct wrapper around std::istream, set stream status.
virtual	~ISstream ()=default
	Destructor.
virtual const fileName &	name () const override
	The name of the input serial stream. (eg, the name of the Fstream file name).
virtual fileName &	name ()
	The name of the input serial stream, for modification.
virtual const std::istream &	stdStream () const
	Const access to underlying std::istream.
virtual std::istream &	stdStream ()
	Access to underlying std::istream.
void	syncState ()
	Set stream state to match that of the std::istream.
*return False if stream exhausted before finding the comment end bool	seekCommentEnd_Cstyle ()
	Discard until end of C-style comment '.
bool	continueReadUntilRightBrace (std::string &str, const bool stripComments=true)
	Raw, low-level get into a string. Continues reading after an initial left-brace until it finds the matching closing right-brace.
ISstream &	get (char &c)
	Raw, low-level get character function.
int	peek ()
	Raw, low-level peek function.
ISstream &	getLine (std::string &str, char delim='\n')
	Raw, low-level getline (until delimiter) into a string.
std::streamsize	getLine (std::nullptr_t, char delim='\n')
	Low-level discard until delimiter.
ISstream &	putback (const char c)
	Raw, low-level putback character function.
Public Member Functions inherited from Istream
	Istream (const Istream &)=default
	Copy construct.
virtual	~Istream ()=default
	Destructor.
	Istream (IOstreamOption streamOpt=IOstreamOption())
	Default construct (ASCII, uncompressed), construct with specified stream option.
	Istream (IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format (uncompressed).
const token &	peekBack () const noexcept
	Examine putback token without removing it.
void	putBackClear ()
	Drop the putback token.
void	putBack (const token &tok)
	Put back a token (copy). Only a single put back is permitted.
void	putBack (token &&tok)
	Put back a token (move). Only a single put back is permitted.
bool	getBack (token &tok)
	Retrieve the put-back token if there is one.
bool	readBegin (const char *funcName)
	Begin read of data chunk, starts with '('.
bool	readEnd (const char *funcName)
	End read of data chunk, ends with ')'.
char	readBeginList (const char *funcName)
	Begin read of list data, starts with '(' or '{'.
char	readEndList (const char *funcName)
	End read of list data, ends with ')' or '}'.
Istream &	operator() () const
	Return a non-const reference to const Istream.
Public Member Functions inherited from IOstream
	IOstream (const IOstream &)=default
	Copy construct.
virtual	~IOstream ()=default
	Destructor.
	IOstream (IOstreamOption streamOpt=IOstreamOption())
	Default construct (ASCII, uncompressed), construct with specified stream option.
	IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format, version (compression).
fileName	relativeName () const
	Return the name of the stream relative to the current case.
virtual bool	check (const char *operation) const
	Check IOstream status for given operation.
bool	fatalCheck (const char *operation) const
	Check IOstream status for given operation.
bool	opened () const noexcept
	True if stream has been opened.
bool	closed () const noexcept
	True if stream is closed.
bool	good () const noexcept
	True if next operation might succeed.
bool	eof () const noexcept
	True if end of input seen.
bool	fail () const noexcept
	True if next operation will fail.
bool	bad () const noexcept
	True if stream is corrupted.
	operator bool () const noexcept
	True if the stream has not failed.
bool	operator! () const noexcept
	True if the stream has failed.
unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes associated with the stream.
unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes associated with the stream.
void	setLabelByteSize (unsigned nbytes) noexcept
	Set the sizeof (label) in bytes associated with the stream.
void	setScalarByteSize (unsigned nbytes) noexcept
	Set the sizeof (scalar) in bytes associated with the stream.
template<class T, class = std::enable_if_t<std::is_integral_v<T>>>
bool	checkLabelSize () const noexcept
	Test if the label byte-size associated with the stream is the same as the given type.
template<class T, class = std::enable_if_t<std::is_floating_point_v<T>>>
bool	checkScalarSize () const noexcept
	Test if the scalar byte-size associated with the stream is the same as the given type.
bool	checkNativeSizes () const noexcept
	Test if the label/scalar byte-size associated with the stream are the native label/scalar sizes.
bool	fatalCheckNativeSizes (const char *operation) const
	Assert that the label/scalar byte-size associated with the stream are the native label/scalar sizes.
label	lineNumber () const noexcept
	Const access to the current stream line number.
label &	lineNumber () noexcept
	Non-const access to the current stream line number.
label	lineNumber (const label num) noexcept
	Set the stream line number.
void	setEof () noexcept
	Set stream state as reached 'eof'.
void	setFail () noexcept
	Set stream state as 'failed'.
void	setBad () noexcept
	Set stream state to be 'bad'.
std::ios_base::fmtflags	setf (std::ios_base::fmtflags f)
	Set stream flag(s), return old stream flags.
std::ios_base::fmtflags	setf (const std::ios_base::fmtflags f, const std::ios_base::fmtflags mask)
	Set stream flag(s) with mask, return old stream flags.
std::ios_base::fmtflags	unsetf (std::ios_base::fmtflags f)
	Unset stream flags, return old stream flags.
void	print (Ostream &os, const int streamState) const
	Print information about the stream state bits.
InfoProxy< IOstream >	info () const noexcept
	Return info proxy, used to print IOstream information to a stream.
Public Member Functions inherited from IOstreamOption
constexpr	IOstreamOption (streamFormat fmt=streamFormat::ASCII, compressionType comp=compressionType::UNCOMPRESSED) noexcept
	Default construct (ASCII, UNCOMPRESSED, currentVersion) or construct with format, compression.
constexpr	IOstreamOption (streamFormat fmt, compressionType comp, versionNumber ver) noexcept
	Construct from components (format, compression, version).
constexpr	IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept
	Construct from components (format, version, compression).
	IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept
	Copy construct with change of format.
streamFormat	format () const noexcept
	Get the current stream format.
streamFormat	format (const streamFormat fmt) noexcept
	Set the stream format.
streamFormat	format (const word &formatName)
	Set the stream format from string value.
compressionType	compression () const noexcept
	Get the stream compression.
compressionType	compression (const compressionType comp) noexcept
	Set the stream compression.
compressionType	compression (const word &compName)
	Set the stream compression from string value.
versionNumber	version () const noexcept
	Get the stream version.
versionNumber	version (const versionNumber ver) noexcept
	Set the stream version.
versionNumber	version (const token &tok)
	Set the stream version from token.

Static Public Member Functions
static autoPtr< ISstream >	New ()
	Return a dummyISstream.
Static Public Member Functions inherited from IOstream
static unsigned int	defaultPrecision () noexcept
	Return the default precision.
static unsigned int	defaultPrecision (unsigned int prec) noexcept
	Reset the default precision.
static unsigned int	minPrecision (unsigned int prec) noexcept
	Set the minimum default precision.
Static Public Member Functions inherited from IOstreamOption
static floatFormat	floatFormatEnum (const word &fmtName, const floatFormat deflt=floatFormat::general)
	Lookup floatFormat enum corresponding to the string (general \| fixed \| scientific).
static floatFormat	floatFormatEnum (const word &key, const dictionary &dict, const floatFormat deflt=floatFormat::general)
	getOrDefault floatFormat from dictionary, warn only on bad enumeration.
static streamFormat	formatEnum (const word &fmtName, const streamFormat deflt=streamFormat::ASCII)
	Lookup streamFormat enum corresponding to the string (ascii \| binary).
static streamFormat	formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII)
	getOrDefault streamFormat from dictionary, warn only on bad enumeration.
static compressionType	compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED)
	The compression enum corresponding to the string.
static compressionType	compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED)
	getOrDefault compressionType from dictionary, warn only on bad enumeration.

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 , COHERENT , UNKNOWN_FORMAT }
	Data format (ascii \| binary \| coherent). More...
enum	compressionType : char { UNCOMPRESSED = 0 , COMPRESSED }
	Compression treatment (UNCOMPRESSED \| COMPRESSED). More...
enum	appendType : char { NO_APPEND = 0 , APPEND_APP , APPEND_ATE , NON_APPEND = NO_APPEND , APPEND = APPEND_APP }
	File appending (NO_APPEND \| APPEND_APP \| APPEND_ATE). More...
enum	atomicType : char { NON_ATOMIC = 0 , ATOMIC }
	Atomic operations (output). More...
enum class	floatFormat : unsigned { general = unsigned(0) , fixed = unsigned(std::ios_base::fixed) , scientific = unsigned(std::ios_base::scientific) }
	Float formats (eg, time directory name formats). More...
Static Public Attributes inherited from IOstream
static unsigned int	precision_
	Default precision.
Static Public Attributes inherited from IOstreamOption
static const Enum< floatFormat >	floatFormatNames
	Names for float formats (general, fixed, scientific).
static const Enum< streamFormat >	formatNames
	Stream format names (ascii, binary).
static const versionNumber	currentVersion
	The current version number (2.0).
Protected Member Functions inherited from StreamAllocator< Foam::icharstream >
	StreamAllocator ()=default
	Default construct (empty).
Protected Member Functions inherited from Istream
bool	hasPutback () const noexcept
	True if putback token is in use.
Protected Member Functions inherited from IOstream
void	setOpened () noexcept
	Set stream opened.
void	setClosed () noexcept
	Set stream closed.
void	setState (std::ios_base::iostate state) noexcept
	Set stream state.
void	setGood () noexcept
	Set stream state to be good.
Protected Attributes inherited from StreamAllocator< Foam::icharstream >
Foam::icharstream	stream_
	The std::stream.
Protected Attributes inherited from IOstream
std::ios_base::iostate	ioState_
	Mirror of internal stream io state.
streamAccess	openClosed_
	The stream open/closed state.
unsigned char	sizeofLabel_
	The sizeof (label), possibly read from the header.
unsigned char	sizeofScalar_
	The sizeof (scalar), possibly read from the header.
label	lineNumber_
	The file line.
Static Protected Attributes inherited from IOstream
static fileName	staticName_
	Name for any generic stream - normally treat as readonly.

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 ICharStream is solely for convenience of implementation and should not be relied upon.

Source files

Definition at line 53 of file dummyISstream.H.

Constructor & Destructor Documentation

◆ dummyISstream()

dummyISstream ( )

default

Default construct.

Referenced by New().

Here is the caller graph for this function:

◆ ~dummyISstream()

virtual ~dummyISstream ( )

virtualdefault

Destructor.

Member Function Documentation

◆ New()

autoPtr< ISstream > New ( )

inlinestatic

Return a dummyISstream.

Definition at line 77 of file dummyISstream.H.

References dummyISstream().

Referenced by dummyFileOperation::NewIFstream(), masterUncollatedFileOperation::read(), dummyFileOperation::readStream(), and uncollatedFileOperation::readStream().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ flags() [1/2]

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

inlineoverridevirtual

Return current stream flags. Dummy for dummy stream, returns 0.

Reimplemented from ISstream.

Definition at line 91 of file dummyISstream.H.

◆ flags() [2/2]

virtual std::ios_base::fmtflags flags ( std::ios_base::fmtflags )

inlineoverridevirtual

Set stream flags, return old stream flags. Dummy for dummy stream, returns 0.

Reimplemented from ISstream.

Definition at line 100 of file dummyISstream.H.

◆ read() [1/11]

virtual Istream & read ( token & )

inlineoverridevirtual

Return next token from stream.

Reimplemented from ISstream.

Definition at line 111 of file dummyISstream.H.

References NotImplemented.

◆ read() [2/11]

virtual Istream & read ( char & )

inlineoverridevirtual

Read a character.

Reimplemented from ISstream.

Definition at line 120 of file dummyISstream.H.

References NotImplemented.

◆ read() [3/11]

virtual Istream & read ( word & )

inlineoverridevirtual

Read a word.

Reimplemented from ISstream.

Definition at line 129 of file dummyISstream.H.

References NotImplemented.

◆ read() [4/11]

virtual Istream & read ( string & str )

inlineoverridevirtual

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 136 of file dummyISstream.H.

References NotImplemented.

◆ read() [5/11]

virtual Istream & read ( int32_t & )

inlineoverridevirtual

Read int32_t.

Reimplemented from ISstream.

Definition at line 145 of file dummyISstream.H.

References NotImplemented.

◆ read() [6/11]

virtual Istream & read ( int64_t & )

inlineoverridevirtual

Read int64_t.

Reimplemented from ISstream.

Definition at line 154 of file dummyISstream.H.

References NotImplemented.

◆ read() [7/11]

virtual Istream & read ( uint32_t & )

inlineoverridevirtual

Read uint32_t.

Reimplemented from ISstream.

Definition at line 163 of file dummyISstream.H.

References NotImplemented.

◆ read() [8/11]

virtual Istream & read ( uint64_t & )

inlineoverridevirtual

Read uint64_t.

Reimplemented from ISstream.

Definition at line 172 of file dummyISstream.H.

References NotImplemented.

◆ read() [9/11]

virtual Istream & read ( float & )

inlineoverridevirtual

Read a float.

Reimplemented from ISstream.

Definition at line 181 of file dummyISstream.H.

References NotImplemented.

◆ read() [10/11]

virtual Istream & read ( double & )

inlineoverridevirtual

Read a double.

Reimplemented from ISstream.

Definition at line 190 of file dummyISstream.H.

References NotImplemented.

◆ read() [11/11]

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

inlineoverridevirtual

Read binary block.

Reimplemented from ISstream.

Definition at line 199 of file dummyISstream.H.

References NotImplemented.

◆ readRaw()

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

inlineoverridevirtual

Low-level raw binary read.

Reimplemented from ISstream.

Definition at line 208 of file dummyISstream.H.

References NotImplemented.

◆ beginRawRead()

virtual bool beginRawRead ( )

inlineoverridevirtual

Start of low-level raw binary read.

Reimplemented from ISstream.

Definition at line 217 of file dummyISstream.H.

◆ endRawRead()

virtual bool endRawRead ( )

inlineoverridevirtual

End of low-level raw binary read.

Reimplemented from ISstream.

Definition at line 225 of file dummyISstream.H.

◆ rewind()

virtual void rewind ( )

inlineoverridevirtual

Rewind the stream so that it may be read again.

Reimplemented from ICharStream.

Definition at line 233 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

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ dummyISstream()

◆ ~dummyISstream()

Member Function Documentation

◆ New()

◆ flags() [1/2]

◆ flags() [2/2]

◆ read() [1/11]

◆ read() [2/11]

◆ read() [3/11]

◆ read() [4/11]

◆ read() [5/11]

◆ read() [6/11]

◆ read() [7/11]

◆ read() [8/11]

◆ read() [9/11]

◆ read() [10/11]

◆ read() [11/11]

◆ readRaw()

◆ beginRawRead()

◆ endRawRead()

◆ rewind()