# PhasicFlow: iOstream Class Reference

iOstream Class Referenceabstract
Inheritance diagram for iOstream:
[legend]
Collaboration diagram for iOstream:
[legend]

## Public Member Functions

| iOstream ()
| iOstream (const iOstream &)=default
virtual | ~iOstream ()=default
virtual bool | write (const token &tok)=0
virtual iOstream & | write (const char c)=0
virtual iOstream & | write (const char *str)=0
virtual iOstream & | write (const word &str)=0
virtual iOstream & | writeQuoted (const word &str, const bool quoted=true)=0
virtual iOstream & | write (const int64 val)=0
virtual iOstream & | write (const int32 val)=0
virtual iOstream & | write (const label val)=0
virtual iOstream & | write (const uint32 val)=0
virtual iOstream & | write (const uint16 val)=0
virtual iOstream & | write (const float val)=0
virtual iOstream & | write (const double val)=0
virtual void | indent ()=0
unsigned short | indentSize () const
unsigned short & | indentSize ()
unsigned short | indentLevel () const
unsigned short & | indentLevel ()
void | incrIndent ()
void | decrIndent ()
virtual iOstream & | beginBlock (const word &kw)
virtual iOstream & | beginBlock ()
virtual iOstream & | endBlock ()
virtual iOstream & | beginList ()
virtual iOstream & | beginList (const word &kw)
virtual iOstream & | endList ()
virtual iOstream & | beginSquare ()
virtual iOstream & | beginSquare (const word &kw)
virtual iOstream & | endSquare ()
virtual iOstream & | endEntry ()
virtual iOstream & | newLine ()
virtual iOstream & | space (int32 n=1)
virtual iOstream & | writeWordKeyword (const word &kw)
template<class T >
iOstream & | writeWordEntry (const word &key, const T &value)
virtual void | flush ()=0
virtual void | endl ()=0
virtual char | fill () const =0
virtual char | fill (const char fillch)=0
virtual int | width () const =0
virtual int | width (const int w)=0
virtual int | precision () const =0
virtual int | precision (const int p)=0
iOstream & | operator() () const
Public Member Functions inherited from IOstream
| IOstream ()
| IOstream (const IOstream &)=default
virtual | ~IOstream ()=default
virtual const word & | name () const
virtual word & | name ()
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
int32 & | lineNumber ()
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)

## Protected Attributes

unsigned short | indentSize_ = 4
unsigned short | indentLevel_ = 0
Protected Attributes inherited from IOstream
streamAccess | openClosed_
ios_base::iostate | ioState_
int32 | lineNumber_

## Static Protected Attributes

static constexpr const unsigned short | entryIndentation_ = 16
Static Protected Attributes inherited from IOstream
static word | staticName_

## 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 ()

## Detailed Description

Definition at line 53 of file iOstream.hpp.

## Constructor & Destructor Documentation

## iOstream() [1/2]

iOstream | ( |  | ) |

inlineexplicit

Definition at line 75 of file iOstream.hpp.

## iOstream() [2/2]

iOstream | ( | const iOstream & |  | ) |

default

## ~iOstream()

virtual ~iOstream | ( |  | ) |

virtualdefault

## Member Function Documentation

## write() [1/11]

virtual bool write | ( | const token & | tok | ) |

pure virtual

Implemented in Ostream, and oTstream.

Referenced by pFlow::operator<<(), and dictionary::writeDictionary().

Here is the caller graph for this function:

## write() [2/11]

virtual iOstream& write | ( | const char | c | ) |

pure virtual

Implemented in Ostream, and oTstream.

## write() [3/11]

virtual iOstream& write | ( | const char * | str | ) |

pure virtual

Implemented in Ostream, and oTstream.

## write() [4/11]

virtual iOstream& write | ( | const word & | str | ) |

pure virtual

Implemented in Ostream, and oTstream.

## writeQuoted()

virtual iOstream& writeQuoted | ( | const word & | str,
|  | const bool | quoted = `true`
| ) |  |

pure virtual

Implemented in Ostream, and oTstream.

## write() [5/11]

virtual iOstream& write | ( | const int64 | val | ) |

pure virtual

Implemented in Ostream, and oTstream.

## write() [6/11]

virtual iOstream& write | ( | const int32 | val | ) |

pure virtual

Implemented in Ostream, and oTstream.

## write() [7/11]

virtual iOstream& write | ( | const label | val | ) |

pure virtual

Implemented in Ostream, and oTstream.

## write() [8/11]

virtual iOstream& write | ( | const uint32 | val | ) |

pure virtual

Implemented in Ostream, and oTstream.

## write() [9/11]

virtual iOstream& write | ( | const uint16 | val | ) |

pure virtual

Implemented in Ostream, and oTstream.

## write() [10/11]

virtual iOstream& write | ( | const float | val | ) |

pure virtual

Implemented in Ostream, and oTstream.

## write() [11/11]

virtual iOstream& write | ( | const double | val | ) |

pure virtual

Implemented in Ostream, and oTstream.

## indent()

virtual void indent | ( |  | ) |

pure virtual

Implemented in oTstream, and Ostream.

Referenced by pFlow::indent().

Here is the caller graph for this function:

## indentSize() [1/2]

unsigned short indentSize | ( |  | ) | const

inline

Definition at line 137 of file iOstream.hpp.

References iOstream::indentSize_.

## indentSize() [2/2]

unsigned short& indentSize | ( |  | ) |

inline

Definition at line 143 of file iOstream.hpp.

References iOstream::indentSize_.

## indentLevel() [1/2]

unsigned short indentLevel | ( |  | ) | const

inline

Definition at line 149 of file iOstream.hpp.

References iOstream::indentLevel_.

## indentLevel() [2/2]

unsigned short& indentLevel | ( |  | ) |

inline

Definition at line 155 of file iOstream.hpp.

References iOstream::indentLevel_.

## incrIndent()

void incrIndent | ( |  | ) |

inline

Definition at line 161 of file iOstream.hpp.

References iOstream::indentLevel_.

Referenced by pFlow::incrIndent(), and stlFile::writeFacet().

Here is the caller graph for this function:

## decrIndent()

void decrIndent | ( |  | ) |

Definition at line 27 of file iOstream.cpp.

References iOstream::indentLevel_.

Referenced by pFlow::decrIndent(), and stlFile::writeFacet().

Here is the caller graph for this function:

## beginBlock() [1/2]

pFlow::iOstream & beginBlock | ( | const word & | kw | ) |

virtual

Definition at line 70 of file iOstream.cpp.

References pFlow::beginBlock(), and pFlow::indent().

Referenced by pFlow::beginBlock(), and dictionary::writeDictionary().

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

## beginBlock() [2/2]

pFlow::iOstream & beginBlock | ( |  | ) |

virtual

Definition at line 79 of file iOstream.cpp.

References token::BEGIN_BLOCK, pFlow::incrIndent(), and pFlow::indent().

Here is the call graph for this function:

## endBlock()

pFlow::iOstream & endBlock | ( |  | ) |

virtual

Definition at line 88 of file iOstream.cpp.

References pFlow::decrIndent(), token::END_BLOCK, and pFlow::indent().

Referenced by pFlow::endBlock(), and dictionary::writeDictionary().

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

## beginList() [1/2]

pFlow::iOstream & beginList | ( |  | ) |

virtual

Definition at line 125 of file iOstream.cpp.

References token::BEGIN_LIST.

## beginList() [2/2]

pFlow::iOstream & beginList | ( | const word & | kw | ) |

virtual

Definition at line 134 of file iOstream.cpp.

## endList()

pFlow::iOstream & endList | ( |  | ) |

virtual

Definition at line 144 of file iOstream.cpp.

References token::END_LIST.

## beginSquare() [1/2]

pFlow::iOstream & beginSquare | ( |  | ) |

virtual

Definition at line 153 of file iOstream.cpp.

References token::BEGIN_SQR.

## beginSquare() [2/2]

pFlow::iOstream & beginSquare | ( | const word & | kw | ) |

virtual

Definition at line 162 of file iOstream.cpp.

## endSquare()

pFlow::iOstream & endSquare | ( |  | ) |

virtual

Definition at line 172 of file iOstream.cpp.

References token::END_SQR.

## endEntry()

pFlow::iOstream & endEntry | ( |  | ) |

virtual

Definition at line 97 of file iOstream.cpp.

References token::END_STATEMENT.

Referenced by pFlow::endEntry(), dataEntry::writeDataEntry(), Field< VectorDual, int8 >::writeField(), and iOstream::writeWordEntry().

Here is the caller graph for this function:

## newLine()

pFlow::iOstream & newLine | ( |  | ) |

virtual

Definition at line 105 of file iOstream.cpp.

References token::NL.

## space()

pFlow::iOstream & space | ( | int32 | n = `1` | ) |

virtual

Definition at line 112 of file iOstream.cpp.

References n, and token::SPACE.

## writeWordKeyword()

pFlow::iOstream & writeWordKeyword | ( | const word & | kw | ) |

virtual

Definition at line 41 of file iOstream.cpp.

References pFlow::indent(), and token::SPACE.

Referenced by Field< VectorDual, int8 >::writeField(), iEntry< Key, T * >::writeKeyword(), and iOstream::writeWordEntry().

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

## writeWordEntry()

iOstream& writeWordEntry | ( | const word & | key,
|  | const T & | value
| ) |  |

inline

Definition at line 217 of file iOstream.hpp.

References iOstream::endEntry(), and iOstream::writeWordKeyword().

Referenced by timeInterval::write(), iBox< intType >::write(), box::write(), sphere::write(), line::write(), rotatingAxis::write(), vibrating::write(), cylinder::write(), IOfileHeader::writeHeader(), and pointStructure::writePointStructure().

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

## flush()

virtual void flush | ( |  | ) |

pure virtual

Implemented in oTstream, and Ostream.

Referenced by pFlow::flush().

Here is the caller graph for this function:

## endl()

virtual void endl | ( |  | ) |

pure virtual

Implemented in oTstream, and Ostream.

Referenced by pFlow::endl().

Here is the caller graph for this function:

## fill() [1/2]

virtual char fill | ( |  | ) | const

pure virtual

Implemented in oTstream, and Ostream.

## fill() [2/2]

virtual char fill | ( | const char | fillch | ) |

pure virtual

Implemented in oTstream, and Ostream.

## width() [1/2]

virtual int width | ( |  | ) | const

pure virtual

Implemented in oTstream, and Ostream.

## width() [2/2]

virtual int width | ( | const int | w | ) |

pure virtual

Implemented in oTstream, and Ostream.

## precision() [1/2]

virtual int precision | ( |  | ) | const

pure virtual

Implemented in oTstream, and Ostream.

## precision() [2/2]

virtual int precision | ( | const int | p | ) |

pure virtual

Implemented in oTstream, and Ostream.

## operator()()

iOstream& operator() | ( |  | ) | const

inline

Definition at line 255 of file iOstream.hpp.

## Member Data Documentation

## entryIndentation_

constexpr const unsigned short entryIndentation_ = 16

staticconstexprprotected

Definition at line 62 of file iOstream.hpp.

## indentSize_

unsigned short indentSize_ = 4

protected

Definition at line 65 of file iOstream.hpp.

Referenced by iOstream::indentSize().

## indentLevel_

unsigned short indentLevel_ = 0

protected

Definition at line 68 of file iOstream.hpp.

Referenced by iOstream::decrIndent(), iOstream::incrIndent(), and iOstream::indentLevel().

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

- src/phasicFlow/streams/iStream/iOstream.hpp
- src/phasicFlow/streams/iStream/iOstream.cpp