OpenFOAM logo
Open Source CFD Toolkit

Istream Class Reference

Inheritance diagram for Istream:

Inheritance graph
[legend]
Collaboration diagram for Istream:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Istream (streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
 Set stream status.
virtual ~Istream ()
void putBack (const token &)
 Put back token.
bool getBack (token &)
 Get the put back token.
virtual Istreamread (token &)=0
 Return next token from stream.
virtual Istreamread (char &)=0
 Read a character.
virtual Istreamread (word &)=0
 Read a word.
virtual Istreamread (string &)=0
virtual Istreamread (label &)=0
 Read a label.
virtual Istreamread (floatScalar &)=0
 Read a floatScalar.
virtual Istreamread (doubleScalar &)=0
 Read a doubleScalar.
virtual Istreamread (char *, std::streamsize)=0
 Read binary block.
virtual Istreamrewind ()=0
 Rewind and return the stream so that it may be read again.
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.

Constructor & Destructor Documentation

Istream streamFormat  format = ASCII,
versionNumber  version = currentVersion,
compressionType  compression = UNCOMPRESSED
[inline]
 

Set stream status.

Definition at line 78 of file Istream.H.

virtual ~Istream  )  [inline, virtual]
 

Definition at line 91 of file Istream.H.


Member Function Documentation

bool getBack token  ) 
 

Get the put back token.

Istream& operator()  )  const
 

Return a non-const reference to const Istream.

Needed for read-constructors where the stream argument is temporary: e.g. thing thisThing(IFstream("thingFileName")());

Reimplemented in IFstream, and IStringStream.

void putBack const token  ) 
 

Put back token.

virtual Istream& read char *  ,
std::streamsize 
[pure virtual]
 

Read binary block.

Implemented in IPstream, ISstream, and ITstream.

virtual Istream& read doubleScalar  )  [pure virtual]
 

Read a doubleScalar.

Implemented in IPstream, ISstream, and ITstream.

virtual Istream& read floatScalar  )  [pure virtual]
 

Read a floatScalar.

Implemented in IPstream, ISstream, and ITstream.

virtual Istream& read label  )  [pure virtual]
 

Read a label.

Implemented in IPstream, ISstream, and ITstream.

virtual Istream& read string  )  [pure virtual]
 

Implemented in IPstream, ISstream, and ITstream.

virtual Istream& read word  )  [pure virtual]
 

Read a word.

Implemented in IPstream, ISstream, and ITstream.

virtual Istream& read char &   )  [pure virtual]
 

Read a character.

Implemented in IPstream, ISstream, and ITstream.

virtual Istream& read token  )  [pure virtual]
 

Return next token from stream.

Implemented in IPstream, ISstream, and ITstream.

Istream& readBegin const char *  funcName  ) 
 

Referenced by tetrahedron::circumRadius(), line::line(), objectMap::objectMap(), point2D::point2D(), face::prevLabel(), and labelledTri::region().

char readBeginList const char *  funcName  ) 
 

Istream& readEnd const char *  funcName  ) 
 

Istream& readEndBegin const char *  funcName  ) 
 

char readEndList const char *  funcName  ) 
 

virtual Istream& rewind  )  [pure virtual]
 

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

Implemented in IPstream, ISstream, and ITstream.


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org