Version of OSstream which prints a prefix on each line. More...
#include <OpenFOAM/prefixOSstream.H>
Version of OSstream which prints a prefix on each line.
This is useful for running in parallel as it allows the processor number to be automatically prepended to each message line.
Definition at line 52 of file prefixOSstream.H.
Public Member Functions | |
prefixOSstream (ostream &os, const string &name, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED) | |
Set stream status. | |
const string & | prefix () const |
Return the prefix of the stream. | |
string & | prefix () |
Return non-const access to the prefix of the stream. | |
virtual Ostream & | write (const token &) |
Write next token to stream. | |
virtual Ostream & | write (const char) |
Write character. | |
virtual Ostream & | write (const char *) |
Write character string. | |
virtual Ostream & | write (const word &) |
Write word. | |
virtual Ostream & | write (const string &) |
Write string. | |
virtual Ostream & | writeQuoted (const std::string &, const bool quoted=true) |
Write std::string surrounded by quotes. | |
virtual Ostream & | write (const label) |
Write label. | |
virtual Ostream & | write (const floatScalar) |
Write floatScalar. | |
virtual Ostream & | write (const doubleScalar) |
Write doubleScalar. | |
virtual Ostream & | write (const char *, std::streamsize) |
Write binary block. | |
virtual void | indent () |
Add indentation characters. | |
virtual void | print (Ostream &) const |
Print description of IOstream to Ostream. | |
![]() | |
OSstream (ostream &os, const string &name, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED) | |
Set stream status. | |
virtual const fileName & | name () const |
Return the name of the stream. | |
virtual fileName & | name () |
Return non-const access to the name of the stream. | |
virtual ios_base::fmtflags | flags () const |
Return flags of output stream. | |
virtual ios_base::fmtflags | flags (const ios_base::fmtflags flags) |
Set flags of output stream. | |
virtual void | flush () |
Flush stream. | |
virtual void | endl () |
Add newline and flush stream. | |
virtual int | width () const |
Get width of output field. | |
virtual int | width (const int) |
Set width of output field (and return old width) | |
virtual int | precision () const |
Get precision of output field. | |
virtual int | precision (const int) |
Set precision of output field (and return old precision) | |
![]() | |
Ostream (streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED) | |
Set stream status. | |
virtual | ~Ostream () |
Destructor. | |
virtual Ostream & | write (const keyType &) |
Write keyType. | |
unsigned short | indentLevel () const |
Return indent level. | |
unsigned short & | indentLevel () |
Access to indent level. | |
void | incrIndent () |
Incrememt the indent level. | |
void | decrIndent () |
Decrememt the indent level. | |
Ostream & | writeKeyword (const keyType &) |
Write the keyword followed by an appropriate indentation. | |
Ostream & | operator() () const |
Return a non-const reference to const Ostream. | |
![]() | |
IOstream (streamFormat format, versionNumber version, compressionType compression=UNCOMPRESSED) | |
Construct setting format and version. | |
virtual | ~IOstream () |
virtual bool | check (const char *operation) const |
Check IOstream status for given operation. | |
void | fatalCheck (const char *operation) const |
Check IOstream status for given operation. | |
bool | opened () const |
Return true if stream has been opened. | |
bool | closed () const |
Return true if stream is closed. | |
bool | good () const |
Return true if next operation might succeed. | |
bool | eof () const |
Return true if end of input seen. | |
bool | fail () const |
Return true if next operation will fail. | |
bool | bad () const |
Return true if stream is corrupted. | |
operator void * () const | |
Return non-zero if the stream has not failed. | |
bool | operator! () const |
Return true if the stream has failed. | |
streamFormat | format () const |
Return current stream format. | |
streamFormat | format (const streamFormat fmt) |
Set the stream format. | |
streamFormat | format (const word &fmt) |
Set the stream format from word. | |
versionNumber | version () const |
Return the stream version. | |
versionNumber | version (const versionNumber ver) |
Set the stream version. | |
compressionType | compression () const |
Return the stream compression. | |
compressionType | compression (const compressionType cmp) |
Set the stream compression. | |
compressionType | compression (const word &cmp) |
Set the stream compression from word. | |
label | lineNumber () const |
Return current stream line number. | |
label & | lineNumber () |
Return current stream line number. | |
label | lineNumber (const label ln) |
Set the stream line number. | |
void | setEof () |
Set stream to have reached eof. | |
void | setFail () |
Set stream to have failed. | |
void | setBad () |
Set stream to be bad. | |
virtual ios::fmtflags | flags (const ios::fmtflags f)=0 |
Set flags of stream. | |
ios::fmtflags | setf (const ios::fmtflags f) |
Set flags of stream. | |
ios::fmtflags | setf (const ios::fmtflags f, const ios::fmtflags mask) |
Set flags of given field of stream. | |
void | unsetf (const ios::fmtflags uf) |
Unset flags of stream. | |
void | print (Ostream &, const int streamState) const |
Check given stream state bits. | |
InfoProxy< IOstream > | info () const |
Return info proxy. |
Additional Inherited Members | |
![]() | |
ostream & | stream () |
Return the stream reference. | |
const ostream & | stream () const |
Return the const stream reference. |
prefixOSstream | ( | ostream & | os, |
const string & | name, | ||
streamFormat | format = ASCII , |
||
versionNumber | version = currentVersion , |
||
compressionType | compression = UNCOMPRESSED |
||
) |
Set stream status.
Definition at line 45 of file prefixOSstream.C.
|
inline |
Return the prefix of the stream.
Definition at line 87 of file prefixOSstream.H.
Referenced by indexedOctree< Type >::print(), and PstreamImpl::setParRun().
|
inline |
Return non-const access to the prefix of the stream.
Definition at line 93 of file prefixOSstream.H.
|
virtual |
Write next token to stream.
Reimplemented from OSstream.
Definition at line 68 of file prefixOSstream.C.
Referenced by treeNode< Type >::distribute().
|
virtual |
Write character.
Reimplemented from OSstream.
Definition at line 74 of file prefixOSstream.C.
References token::NL, and OSstream::write().
|
virtual |
Write character string.
Reimplemented from OSstream.
Definition at line 88 of file prefixOSstream.C.
References token::NL, and OSstream::write().
|
virtual |
Write word.
Reimplemented from OSstream.
Definition at line 103 of file prefixOSstream.C.
References OSstream::write().
|
virtual |
Write string.
Reimplemented from OSstream.
Definition at line 110 of file prefixOSstream.C.
References OSstream::write().
|
virtual |
Write std::string surrounded by quotes.
Optional write without quotes.
Reimplemented from OSstream.
Definition at line 118 of file prefixOSstream.C.
References OSstream::writeQuoted().
|
virtual |
Write label.
Reimplemented from OSstream.
Definition at line 128 of file prefixOSstream.C.
References OSstream::write().
|
virtual |
Write floatScalar.
Reimplemented from OSstream.
Definition at line 135 of file prefixOSstream.C.
References OSstream::write().
|
virtual |
Write doubleScalar.
Reimplemented from OSstream.
Definition at line 142 of file prefixOSstream.C.
References OSstream::write().
|
virtual |
Write binary block.
Reimplemented from OSstream.
Definition at line 150 of file prefixOSstream.C.
References OSstream::write().
|
virtual |
Add indentation characters.
Reimplemented from OSstream.
Definition at line 160 of file prefixOSstream.C.
References OSstream::indent().
|
virtual |
Print description of IOstream to Ostream.
Reimplemented from OSstream.
Definition at line 61 of file prefixOSstream.C.
References OSstream::print().