Version of OSstream which prints a prefix on each line. More...
Public Member Functions | |
prefixOSstream (ostream &os, const string &name, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED) | |
Set stream status. More... | |
const string & | prefix () const |
Return the prefix of the stream. More... | |
string & | prefix () |
Return non-const access to the prefix of the stream. More... | |
virtual Ostream & | write (const token &) |
Write next token to stream. More... | |
virtual Ostream & | write (const char) |
Write character. More... | |
virtual Ostream & | write (const char *) |
Write character string. More... | |
virtual Ostream & | write (const word &) |
Write word. More... | |
virtual Ostream & | write (const string &) |
Write string. More... | |
virtual Ostream & | writeQuoted (const std::string &, const bool quoted=true) |
Write std::string surrounded by quotes. More... | |
virtual Ostream & | write (const int32_t) |
Write int32_t. More... | |
virtual Ostream & | write (const int64_t) |
Write int64_t. More... | |
virtual Ostream & | write (const floatScalar) |
Write floatScalar. More... | |
virtual Ostream & | write (const doubleScalar) |
Write doubleScalar. More... | |
virtual Ostream & | write (const longDoubleScalar) |
Write longDoubleScalar. More... | |
virtual Ostream & | write (const char *, std::streamsize) |
Write binary block. More... | |
virtual void | indent () |
Add indentation characters. More... | |
virtual void | print (Ostream &) const |
Print description of IOstream to Ostream. More... | |
![]() | |
OSstream (ostream &os, const string &name, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED) | |
Set stream status. More... | |
virtual const fileName & | name () const |
Return the name of the stream. More... | |
virtual fileName & | name () |
Return non-const access to the name of the stream. More... | |
virtual ios_base::fmtflags | flags () const |
Return flags of output stream. More... | |
virtual ios_base::fmtflags | flags (const ios_base::fmtflags flags) |
Set flags of output stream. More... | |
virtual void | flush () |
Flush stream. More... | |
virtual void | endl () |
Add newline and flush stream. More... | |
virtual int | width () const |
Get width of output field. More... | |
virtual int | width (const int) |
Set width of output field (and return old width) More... | |
virtual int | precision () const |
Get precision of output field. More... | |
virtual int | precision (const int) |
Set precision of output field (and return old precision) More... | |
virtual ostream & | stdStream () |
Access to underlying std::ostream. More... | |
virtual const ostream & | stdStream () const |
Const access to underlying std::ostream. More... | |
void | operator= (const OSstream &)=delete |
Disallow default bitwise assignment. More... | |
![]() | |
Ostream (streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED) | |
Set stream status. More... | |
virtual | ~Ostream () |
Destructor. More... | |
virtual Ostream & | write (const keyType &) |
Write keyType. More... | |
unsigned short | indentLevel () const |
Return indent level. More... | |
unsigned short & | indentLevel () |
Access to indent level. More... | |
void | incrIndent () |
Incrememt the indent level. More... | |
void | decrIndent () |
Decrememt the indent level. More... | |
Ostream & | writeKeyword (const keyType &) |
Write the keyword followed by an appropriate indentation. More... | |
Ostream & | operator() () const |
Return a non-const reference to const Ostream. More... | |
![]() | |
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... | |
label & | lineNumber () |
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< IOstream > | info () const |
Return info proxy. More... | |
Additional Inherited Members | |
![]() | |
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 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 const versionNumber | originalVersion |
Original version number. More... | |
static const versionNumber | currentVersion |
Current version number. More... | |
static unsigned int | precision_ |
Default precision. More... | |
![]() | |
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... | |
![]() | |
unsigned short | indentLevel_ |
Current indent level. More... | |
![]() | |
label | lineNumber_ |
![]() | |
static const unsigned short | indentSize_ = 4 |
Number of spaces per indent level. More... | |
static const unsigned short | entryIndentation_ = 16 |
Indentation of the entry from the start of the keyword. More... | |
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 51 of file prefixOSstream.H.
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 86 of file prefixOSstream.H.
Referenced by NamedEnum< directionType, 3 >::names(), dynamicIndexedOctree< Foam::dynamicTreeDataPoint >::print(), and indexedOctree< Foam::treeDataFace >::print().
|
inline |
Return non-const access to the prefix of the stream.
Definition at line 92 of file prefixOSstream.H.
References prefixOSstream::indent(), prefixOSstream::print(), prefixOSstream::write(), and prefixOSstream::writeQuoted().
|
virtual |
Write next token to stream.
Reimplemented from OSstream.
Definition at line 68 of file prefixOSstream.C.
References token::BEGIN_BLOCK, token::END_BLOCK, token::HASH, token::stringToken(), token::type(), token::VARIABLE, token::VERBATIMSTRING, and prefixOSstream::writeQuoted().
Referenced by prefixOSstream::prefix(), and prefixOSstream::write().
|
virtual |
Write character.
Reimplemented from OSstream.
Definition at line 86 of file prefixOSstream.C.
References token::NL, and OSstream::write().
|
virtual |
Write character string.
Reimplemented from OSstream.
Definition at line 100 of file prefixOSstream.C.
References token::NL, and OSstream::write().
|
virtual |
Write word.
Reimplemented from OSstream.
Definition at line 115 of file prefixOSstream.C.
References OSstream::write().
|
virtual |
Write string.
Reimplemented from OSstream.
Definition at line 122 of file prefixOSstream.C.
References OSstream::write(), and prefixOSstream::writeQuoted().
|
virtual |
Write std::string surrounded by quotes.
Optional write without quotes.
Reimplemented from OSstream.
Definition at line 130 of file prefixOSstream.C.
References OSstream::writeQuoted().
Referenced by prefixOSstream::prefix(), and prefixOSstream::write().
|
virtual |
Write int32_t.
Reimplemented from OSstream.
Definition at line 140 of file prefixOSstream.C.
References OSstream::write().
|
virtual |
Write int64_t.
Reimplemented from OSstream.
Definition at line 147 of file prefixOSstream.C.
References OSstream::write().
|
virtual |
Write floatScalar.
Reimplemented from OSstream.
Definition at line 154 of file prefixOSstream.C.
References OSstream::write().
|
virtual |
Write doubleScalar.
Reimplemented from OSstream.
Definition at line 161 of file prefixOSstream.C.
References OSstream::write().
|
virtual |
Write longDoubleScalar.
Reimplemented from OSstream.
Definition at line 168 of file prefixOSstream.C.
References OSstream::write(), and prefixOSstream::write().
|
virtual |
Write binary block.
Reimplemented from OSstream.
Definition at line 176 of file prefixOSstream.C.
References OSstream::write().
|
virtual |
Add indentation characters.
Reimplemented from OSstream.
Definition at line 186 of file prefixOSstream.C.
References OSstream::indent().
Referenced by prefixOSstream::prefix().
|
virtual |
Print description of IOstream to Ostream.
Reimplemented from OSstream.
Definition at line 61 of file prefixOSstream.C.
References OSstream::print().
Referenced by prefixOSstream::prefix().