iIstream Class Referenceabstract
Inheritance diagram for iIstream:
Collaboration diagram for iIstream:

Public Member Functions

 iIstream ()
 
 iIstream (const iIstream &)=default
 
virtual ~iIstream ()=default
 
void putBack (const token &tok)
 
bool getBack (token &tok)
 
bool peekBack (token &tok)
 
void resetPutBack ()
 
virtual iIstreamread (token &)=0
 
virtual iIstreamread (char &)=0
 
virtual iIstreamread (word &)=0
 
virtual iIstreamreadString (word &)=0
 
virtual iIstreamread (int64 &)=0
 
virtual iIstreamread (int32 &)=0
 
virtual iIstreamread (int16 &)=0
 
virtual iIstreamread (int8 &)=0
 
virtual iIstreamread (label &)=0
 
virtual iIstreamread (uint32 &)=0
 
virtual iIstreamread (uint16 &)=0
 
virtual iIstreamread (float &)=0
 
virtual iIstreamread (double &)=0
 
virtual void rewind ()=0
 
virtual bool findToken (const word &w)
 
virtual bool findTokenSilent (const word &w, int32 limitLine=100)
 
virtual bool findTokenAndNext (const word &w, word &nextW, bool checkEndStatement=true)
 
virtual bool findTokenAndNextSilent (const word &w, word &nextW, int32 limitLine=100)
 
template<typename T >
bool findKeywordAndVal (const word &keyword, T &val, bool checkEndStatement=true)
 
template<typename T >
lookupData (const word &keyword)
 
template<typename T >
lookupDataOrSet (const word &keyword, const T &setVal)
 
template<typename T >
bool nextData (const word &keyword, T &data)
 
bool readBegin (const char *funcName)
 
bool readEnd (const char *funcName)
 
bool readBeginSquare (const char *funcName)
 
bool readEndSquare (const char *funcName)
 
char readBeginList (const char *funcName)
 
char readEndList (const char *funcName)
 
char readEndStatement (const char *funcName)
 
iIstreamoperator() () const
 
- Public Member Functions inherited from IOstream
 IOstream ()
 
 IOstream (const IOstream &)=default
 
virtual ~IOstream ()=default
 
virtual const wordname () const
 
virtual wordname ()
 
virtual bool check (const char *operation) const
 
bool fatalCheck (const char *operation) const
 
bool opened () const
 
bool closed () const
 
bool good () const
 
bool eof () const
 
bool fail () const
 
bool bad () const
 
 operator bool () const
 
bool operator! () const
 
int32 lineNumber () const
 
int32lineNumber ()
 
int32 lineNumber (const int32 num)
 
virtual ios_base::fmtflags flags () const =0
 
void setEof ()
 
void setFail ()
 
void setBad ()
 
virtual ios_base::fmtflags flags (const ios_base::fmtflags f)=0
 
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)
 

Private Attributes

bool putBack_
 
token putBackToken_
 

Additional Inherited Members

- Public Types inherited from IOstream
enum  streamAccess : char { CLOSED = 0, OPENED }
 
- Static Public Member Functions inherited from IOstream
static unsigned int defaultPrecision ()
 
static unsigned int defaultPrecision (unsigned int prec)
 
- Static Public Attributes inherited from IOstream
static unsigned int precision_ = 6
 
- Protected Member Functions inherited from IOstream
void setOpened ()
 
void setClosed ()
 
void setState (ios_base::iostate state)
 
void setGood ()
 
- Protected Attributes inherited from IOstream
streamAccess openClosed_
 
ios_base::iostate ioState_
 
int32 lineNumber_
 
- Static Protected Attributes inherited from IOstream
static word staticName_
 

Detailed Description

Definition at line 33 of file iIstream.hpp.

Constructor & Destructor Documentation

◆ iIstream() [1/2]

iIstream ( )
inline

Definition at line 51 of file iIstream.hpp.

◆ iIstream() [2/2]

iIstream ( const iIstream )
default

◆ ~iIstream()

virtual ~iIstream ( )
virtualdefault

Member Function Documentation

◆ putBack()

◆ getBack()

bool getBack ( token tok)

Definition at line 27 of file iIstream.cpp.

References fatalErrorInFunction.

Referenced by iTstream::read(), and Istream::read().

Here is the caller graph for this function:

◆ peekBack()

bool peekBack ( token tok)

Definition at line 46 of file iIstream.cpp.

References token::reset().

Here is the call graph for this function:

◆ resetPutBack()

void resetPutBack ( )
inline

Definition at line 80 of file iIstream.hpp.

References iIstream::putBack_, iIstream::putBackToken_, and token::reset().

Referenced by iTstream::reset(), and iTstream::rewind().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ read() [1/12]

virtual iIstream& read ( token )
pure virtual

Implemented in Istream, and iTstream.

Referenced by iEntry< Key, T * >::createEntry(), pFlow::operator>>(), dataEntry::readDataEntry(), iEntry< Key, T * >::readKeyword(), and token::token().

Here is the caller graph for this function:

◆ read() [2/12]

virtual iIstream& read ( char &  )
pure virtual

Implemented in Istream, and iTstream.

◆ read() [3/12]

virtual iIstream& read ( word )
pure virtual

Implemented in Istream, and iTstream.

◆ readString()

virtual iIstream& readString ( word )
pure virtual

Implemented in Istream, and iTstream.

◆ read() [4/12]

virtual iIstream& read ( int64 )
pure virtual

Implemented in Istream, and iTstream.

◆ read() [5/12]

virtual iIstream& read ( int32 )
pure virtual

Implemented in Istream, and iTstream.

◆ read() [6/12]

virtual iIstream& read ( int16 )
pure virtual

Implemented in Istream, and iTstream.

◆ read() [7/12]

virtual iIstream& read ( int8 )
pure virtual

Implemented in Istream, and iTstream.

◆ read() [8/12]

virtual iIstream& read ( label )
pure virtual

Implemented in Istream, and iTstream.

◆ read() [9/12]

virtual iIstream& read ( uint32 )
pure virtual

Implemented in Istream, and iTstream.

◆ read() [10/12]

virtual iIstream& read ( uint16 )
pure virtual

Implemented in Istream, and iTstream.

◆ read() [11/12]

virtual iIstream& read ( float &  )
pure virtual

Implemented in Istream, and iTstream.

◆ read() [12/12]

virtual iIstream& read ( double &  )
pure virtual

Implemented in Istream, and iTstream.

◆ rewind()

virtual void rewind ( )
pure virtual

Implemented in Istream, and iTstream.

◆ findToken()

bool findToken ( const word w)
virtual

Definition at line 60 of file iIstream.cpp.

References pFlow::endl(), token::error(), fatalErrorInFunction, token::isEndBlock(), token::isEndStatement(), token::isWord(), and token::wordToken().

Referenced by iIstream::findKeywordAndVal(), and Field< VectorDual, int8 >::readField().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ findTokenSilent()

bool findTokenSilent ( const word w,
int32  limitLine = 100 
)
virtual

Definition at line 93 of file iIstream.cpp.

References token::error(), token::isEndBlock(), token::isEndStatement(), token::isWord(), and token::wordToken().

Here is the call graph for this function:

◆ findTokenAndNext()

bool findTokenAndNext ( const word w,
word nextW,
bool  checkEndStatement = true 
)
virtual

Definition at line 122 of file iIstream.cpp.

References pFlow::endl(), token::error(), ioErrorInFile, token::isEndStatement(), token::isWord(), and token::wordToken().

Here is the call graph for this function:

◆ findTokenAndNextSilent()

bool findTokenAndNextSilent ( const word w,
word nextW,
int32  limitLine = 100 
)
virtual

Definition at line 168 of file iIstream.cpp.

References token::error(), token::isEndStatement(), token::isWord(), and token::wordToken().

Referenced by readControlDict::read(), and IOfileHeader::readHeader().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ findKeywordAndVal()

bool findKeywordAndVal ( const word keyword,
T &  val,
bool  checkEndStatement = true 
)

Definition at line 24 of file iIstreamI.hpp.

References iIstream::findToken(), token::good(), and token::isEndStatement().

Referenced by readControlDict::read().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ lookupData()

T lookupData ( const word keyword)

Definition at line 52 of file iIstreamI.hpp.

References fatalExit, and ioErrorInFile.

◆ lookupDataOrSet()

T lookupDataOrSet ( const word keyword,
const T &  setVal 
)

Definition at line 68 of file iIstreamI.hpp.

Referenced by readControlDict::read(), and pointStructure::readPointStructure().

Here is the caller graph for this function:

◆ nextData()

bool nextData ( const word keyword,
T &  data 
)

Definition at line 81 of file iIstreamI.hpp.

References pFlow::endl(), token::error(), token::good(), ioErrorInFile, token::isEndStatement(), token::isWord(), and token::wordToken().

Referenced by iBox< intType >::read(), box::read(), sphere::read(), and cylinder::read().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readBegin()

bool readBegin ( const char *  funcName)

Definition at line 203 of file iIstream.cpp.

References token::BEGIN_LIST, pFlow::endl(), fatalExit, and ioErrorInFile.

Referenced by pFlow::operator>>().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readEnd()

bool readEnd ( const char *  funcName)

Definition at line 223 of file iIstream.cpp.

References token::END_LIST, pFlow::endl(), fatalExit, and ioErrorInFile.

Referenced by pFlow::operator>>().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readBeginSquare()

bool readBeginSquare ( const char *  funcName)

Definition at line 242 of file iIstream.cpp.

References token::BEGIN_SQR, pFlow::endl(), fatalExit, and ioErrorInFile.

Here is the call graph for this function:

◆ readEndSquare()

bool readEndSquare ( const char *  funcName)

Definition at line 261 of file iIstream.cpp.

References token::END_SQR, pFlow::endl(), fatalExit, and ioErrorInFile.

Here is the call graph for this function:

◆ readBeginList()

char readBeginList ( const char *  funcName)

Definition at line 280 of file iIstream.cpp.

References token::BEGIN_BLOCK, token::BEGIN_LIST, pFlow::endl(), fatalExit, ioErrorInFile, and token::pToken().

Here is the call graph for this function:

◆ readEndList()

char readEndList ( const char *  funcName)

Definition at line 301 of file iIstream.cpp.

References token::END_BLOCK, token::END_LIST, pFlow::endl(), fatalExit, ioErrorInFile, and token::pToken().

Here is the call graph for this function:

◆ readEndStatement()

char readEndStatement ( const char *  funcName)

Definition at line 324 of file iIstream.cpp.

References CONSUME_PARAM, pFlow::endl(), fatalExit, ioErrorInFile, token::isEndStatement(), and token::pToken().

Referenced by timeInterval::read(), rotatingAxis::read(), line::read(), Field< VectorDual, int8 >::readNonUniform(), and Field< VectorDual, int8 >::readUniform().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator()()

pFlow::iIstream & operator() ( ) const

Definition at line 342 of file iIstream.cpp.

References fatalExit.

Member Data Documentation

◆ putBack_

bool putBack_
private

Definition at line 41 of file iIstream.hpp.

Referenced by iIstream::putBack(), and iIstream::resetPutBack().

◆ putBackToken_

token putBackToken_
private

Definition at line 44 of file iIstream.hpp.

Referenced by iIstream::putBack(), and iIstream::resetPutBack().


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