dummyISstream Class Reference

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

Inheritance diagram for dummyISstream:
Collaboration diagram for dummyISstream:

Public Member Functions

 dummyISstream ()
 Construct null. More...
 
virtual ~dummyISstream ()
 Destructor. More...
 
virtual Istreamread (token &)
 Return next token from stream. More...
 
virtual Istreamread (char &)
 Read a character. More...
 
virtual Istreamread (word &)
 Read a word. More...
 
virtual Istreamread (string &)
 Read a string (including enclosing double-quotes). More...
 
virtual Istreamread (label &)
 Read a label. More...
 
virtual Istreamread (floatScalar &)
 Read a floatScalar. More...
 
virtual Istreamread (doubleScalar &)
 Read a doubleScalar. More...
 
virtual Istreamread (longDoubleScalar &)
 Read a longDoubleScalar. More...
 
virtual Istreamread (char *, std::streamsize)
 Read binary block. More...
 
virtual Istreamrewind ()
 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 IStringStream
 IStringStream (const string &buffer, streamFormat format=ASCII, versionNumber version=currentVersion)
 Construct from string. More...
 
 IStringStream (const string &name, const string &buffer, streamFormat format=ASCII, versionNumber version=currentVersion)
 Construct from string and name. More...
 
 IStringStream (const char *buffer, streamFormat format=ASCII, versionNumber version=currentVersion)
 Construct from char*. More...
 
 ~IStringStream ()
 Destructor. More...
 
string str () const
 Return the string. More...
 
void print (Ostream &) const
 Print description to Ostream. More...
 
Istreamoperator() () const
 Return a non-const reference to const Istream. More...
 
- Public Member Functions inherited from ISstream
 ISstream (istream &is, const string &name, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
 Construct as wrapper around istream. More...
 
virtual ~ISstream ()
 Destructor. More...
 
virtual const fileNamename () const
 Return the name of the stream. More...
 
virtual fileNamename ()
 Return non-const access to the name of the stream. More...
 
ISstreamget (char &)
 Raw, low-level get character function. More...
 
int peek ()
 Raw, low-level peek function. More...
 
ISstreamgetLine (string &)
 Raw, low-level getline into a string function. More...
 
ISstreamputback (const char &)
 Raw, low-level putback character function. More...
 
virtual istream & stdStream ()
 Access to underlying std::istream. More...
 
virtual const istream & stdStream () const
 Const access to underlying std::istream. More...
 
void operator= (const ISstream &)=delete
 Disallow default bitwise assignment. 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...
 
IstreamreadBegin (const char *funcName)
 
IstreamreadEnd (const char *funcName)
 
IstreamreadEndBegin (const char *funcName)
 
char readBeginList (const char *funcName)
 
char readEndList (const char *funcName)
 
Istreamoperator() () 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 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...
 
labellineNumber ()
 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...
 
void print (Ostream &, const int streamState) const
 Check given stream state bits. More...
 
InfoProxy< IOstreaminfo () 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

Definition at line 47 of file dummyISstream.H.

Constructor & Destructor Documentation

◆ dummyISstream()

dummyISstream ( )
inline

Construct null.

Definition at line 57 of file dummyISstream.H.

◆ ~dummyISstream()

virtual ~dummyISstream ( )
inlinevirtual

Destructor.

Definition at line 64 of file dummyISstream.H.

Member Function Documentation

◆ read() [1/9]

virtual Istream& read ( token )
inlinevirtual

Return next token from stream.

Reimplemented from ISstream.

Definition at line 73 of file dummyISstream.H.

References NotImplemented.

◆ read() [2/9]

virtual Istream& read ( char &  )
inlinevirtual

Read a character.

Reimplemented from ISstream.

Definition at line 80 of file dummyISstream.H.

References NotImplemented.

◆ read() [3/9]

virtual Istream& read ( word )
inlinevirtual

Read a word.

Reimplemented from ISstream.

Definition at line 87 of file dummyISstream.H.

References NotImplemented.

◆ read() [4/9]

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

References NotImplemented.

◆ read() [5/9]

virtual Istream& read ( label )
inlinevirtual

Read a label.

Reimplemented from ISstream.

Definition at line 101 of file dummyISstream.H.

References NotImplemented.

◆ read() [6/9]

virtual Istream& read ( floatScalar )
inlinevirtual

Read a floatScalar.

Reimplemented from ISstream.

Definition at line 108 of file dummyISstream.H.

References NotImplemented.

◆ read() [7/9]

virtual Istream& read ( doubleScalar )
inlinevirtual

Read a doubleScalar.

Reimplemented from ISstream.

Definition at line 115 of file dummyISstream.H.

References NotImplemented.

◆ read() [8/9]

virtual Istream& read ( longDoubleScalar )
inlinevirtual

Read a longDoubleScalar.

Reimplemented from ISstream.

Definition at line 122 of file dummyISstream.H.

References NotImplemented.

◆ read() [9/9]

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

Read binary block.

Reimplemented from ISstream.

Definition at line 129 of file dummyISstream.H.

References NotImplemented.

◆ rewind()

virtual Istream& rewind ( )
inlinevirtual

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

Reimplemented from ISstream.

Definition at line 136 of file dummyISstream.H.

References NotImplemented.

◆ flags() [1/2]

virtual ios_base::fmtflags flags ( ) const
inlinevirtual

Return flags of stream.

Reimplemented from ISstream.

Definition at line 143 of file dummyISstream.H.

References NotImplemented.

◆ flags() [2/2]

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

Set flags of stream.

Reimplemented from ISstream.

Definition at line 150 of file dummyISstream.H.

References f(), and NotImplemented.

Here is the call graph for this function:

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