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

virtual	~dummyISstream ()=default

virtual Istream &	read (token &)

virtual Istream &	read (char &)

virtual Istream &	read (word &)

virtual Istream &	read (string &)

virtual Istream &	read (label &)

virtual Istream &	read (floatScalar &)

virtual Istream &	read (doubleScalar &)

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

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

virtual bool	beginRawRead ()

virtual bool	endRawRead ()

virtual void	rewind ()

virtual ios_base::fmtflags	flags () const

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

Public Member Functions inherited from IStringStream
	IStringStream (IOstreamOption streamOpt=IOstreamOption())

	IStringStream (const std::string &s, IOstreamOption streamOpt=IOstreamOption())

	IStringStream (const char *s, IOstreamOption streamOpt=IOstreamOption())

	IStringStream (const IStringStream &str)

virtual void	reset (const std::string &s)

virtual void	print (Ostream &os) const

Istream &	operator() () const

Public Member Functions inherited from StringStreamAllocator< std::istringstream >
Foam::string	str () const

void	str (const std::string &s)

Public Member Functions inherited from ISstream
	ISstream (std::istream &is, const string &streamName, IOstreamOption streamOpt=IOstreamOption())

	ISstream (std::istream &is, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)

virtual	~ISstream ()=default

virtual const fileName &	name () const

virtual fileName &	name ()

bool	seekCommentEnd_Cstyle ()

bool	continueReadUntilRightBrace (std::string &str, const bool stripComments=true)

ISstream &	get (char &c)

int	peek ()

ISstream &	getLine (std::string &str, char delim='\n')

std::streamsize	getLine (std::nullptr_t, char delim='\n')

ISstream &	putback (const char c)

virtual std::istream &	stdStream ()

virtual const std::istream &	stdStream () const

Public Member Functions inherited from Istream
	Istream (const Istream &)=default

virtual	~Istream ()=default

	Istream (IOstreamOption streamOpt=IOstreamOption())

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

const token &	peekBack () const noexcept

bool	peekBack (token &tok)

void	putBack (const token &tok)

bool	getBack (token &tok)

bool	readBegin (const char *funcName)

bool	readEnd (const char *funcName)

char	readBeginList (const char *funcName)

char	readEndList (const char *funcName)

Istream &	operator() () const

Public Member Functions inherited from IOstream
	IOstream (const IOstream &)=default

virtual	~IOstream ()=default

	IOstream (IOstreamOption streamOpt=IOstreamOption())

	IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)

fileName	relativeName () const

virtual bool	check (const char *operation) const

bool	fatalCheck (const char *operation) const

bool	opened () const noexcept

bool	closed () const noexcept

bool	good () const noexcept

bool	eof () const noexcept

bool	fail () const noexcept

bool	bad () const noexcept

	operator bool () const noexcept

bool	operator! () const noexcept

unsigned	labelByteSize () const noexcept

unsigned	scalarByteSize () const noexcept

void	setLabelByteSize (unsigned nbytes) noexcept

void	setScalarByteSize (unsigned nbytes) noexcept

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

label &	lineNumber () noexcept

label	lineNumber (const label num) noexcept

void	setEof () noexcept

void	setFail () noexcept

void	setBad ()

ios_base::fmtflags	setf (const ios_base::fmtflags f)

ios_base::fmtflags	setf (const ios_base::fmtflags f, const ios_base::fmtflags mask)

void	unsetf (const ios_base::fmtflags f)

void	print (Ostream &os, const int streamState) const

InfoProxy< IOstream >	info () const

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

constexpr	IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept

	IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept

streamFormat	format () const noexcept

streamFormat	format (const streamFormat fmt) noexcept

streamFormat	format (const word &formatName)

compressionType	compression () const noexcept

compressionType	compression (const compressionType comp) noexcept

compressionType	compression (const word &compName)

versionNumber	version () const noexcept

versionNumber	version (const versionNumber ver) noexcept

versionNumber	version (const token &tok)

Additional Inherited Members
Public Types inherited from IOstream
enum	streamAccess : char { CLOSED = 0, OPENED }

Public Types inherited from IOstreamOption
enum	streamFormat : char { ASCII = 0, BINARY }

enum	compressionType : char { UNCOMPRESSED = 0, COMPRESSED }

Static Public Member Functions inherited from IOstream
static unsigned int	defaultPrecision () noexcept

static unsigned int	defaultPrecision (unsigned int prec) noexcept

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)

static compressionType	compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED)

static compressionType	compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED)

Static Public Attributes inherited from IOstream
static unsigned int	precision_

Static Public Attributes inherited from IOstreamOption
static const Enum< streamFormat >	formatNames

static const versionNumber	currentVersion

Protected Types inherited from StringStreamAllocator< std::istringstream >
typedef std::istringstream	stream_type

Protected Member Functions inherited from StringStreamAllocator< std::istringstream >
	StringStreamAllocator ()=default

	StringStreamAllocator (const std::string &s)

Protected Member Functions inherited from Istream
bool	hasPutback () const noexcept

Protected Member Functions inherited from IOstream
void	setOpened () noexcept

void	setClosed () noexcept

void	setState (std::ios_base::iostate state) noexcept

void	setGood () noexcept

Protected Attributes inherited from StringStreamAllocator< std::istringstream >
stream_type	stream_

Protected Attributes inherited from IOstream
std::ios_base::iostate	ioState_

streamAccess	openClosed_

unsigned char	sizeofLabel_

unsigned char	sizeofScalar_

label	lineNumber_

Static Protected Attributes inherited from IOstream
static fileName	staticName_

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

Constructor & Destructor Documentation

◆ dummyISstream()

dummyISstream ( )

default

◆ ~dummyISstream()

virtual ~dummyISstream ( )

virtualdefault

Member Function Documentation

◆ read() [1/8]

virtual Istream& read ( token & )

inlinevirtual

Reimplemented from ISstream.

Definition at line 72 of file dummyISstream.H.

References NotImplemented.

◆ read() [2/8]

virtual Istream& read ( char & )

inlinevirtual

Reimplemented from ISstream.

Definition at line 79 of file dummyISstream.H.

References NotImplemented.

◆ read() [3/8]

virtual Istream& read ( word & )

inlinevirtual

Reimplemented from ISstream.

Definition at line 86 of file dummyISstream.H.

References NotImplemented.

◆ read() [4/8]

virtual Istream& read ( string & )

inlinevirtual

Reimplemented from ISstream.

Definition at line 93 of file dummyISstream.H.

References NotImplemented.

◆ read() [5/8]

virtual Istream& read ( label & )

inlinevirtual

Reimplemented from ISstream.

Definition at line 100 of file dummyISstream.H.

References NotImplemented.

◆ read() [6/8]

virtual Istream& read ( floatScalar & )

inlinevirtual

Reimplemented from ISstream.

Definition at line 107 of file dummyISstream.H.

References NotImplemented.

◆ read() [7/8]

virtual Istream& read ( doubleScalar & )

inlinevirtual

Reimplemented from ISstream.

Definition at line 114 of file dummyISstream.H.

References NotImplemented.

◆ read() [8/8]

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

inlinevirtual

Reimplemented from ISstream.

Definition at line 121 of file dummyISstream.H.

References NotImplemented.

◆ readRaw()

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

inlinevirtual

Reimplemented from ISstream.

Definition at line 128 of file dummyISstream.H.

References NotImplemented.

◆ beginRawRead()

virtual bool beginRawRead ( )

inlinevirtual

Reimplemented from ISstream.

Definition at line 135 of file dummyISstream.H.

◆ endRawRead()

virtual bool endRawRead ( )

inlinevirtual

Reimplemented from ISstream.

Definition at line 141 of file dummyISstream.H.

◆ rewind()

virtual void rewind ( )

inlinevirtual

Reimplemented from ISstream.

Definition at line 147 of file dummyISstream.H.

◆ flags() [1/2]

virtual ios_base::fmtflags flags ( ) const

inlinevirtual

Reimplemented from ISstream.

Definition at line 151 of file dummyISstream.H.

◆ flags() [2/2]

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

inlinevirtual

Reimplemented from ISstream.

Definition at line 157 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]