Version of OSstream which prints a prefix on each line. More...
Public Member Functions | |
prefixOSstream (std::ostream &os, const string &name, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED) | |
Construct and set stream status. More... | |
const string & | prefix () const |
Return the stream prefix. More... | |
string & | prefix () |
Return non-const access to the stream prefix. More... | |
virtual bool | write (const token &tok) |
Write token to stream or otherwise handle it. More... | |
virtual Ostream & | write (const char c) |
Write character. More... | |
virtual Ostream & | write (const char *str) |
Write character string. More... | |
virtual Ostream & | write (const word &val) |
Write word. More... | |
virtual Ostream & | write (const string &val) |
Write string. More... | |
virtual Ostream & | writeQuoted (const std::string &val, const bool quoted=true) |
Write std::string surrounded by quotes. More... | |
virtual Ostream & | write (const int32_t val) |
Write int32_t. More... | |
virtual Ostream & | write (const int64_t val) |
Write int64_t. More... | |
virtual Ostream & | write (const floatScalar val) |
Write floatScalar. More... | |
virtual Ostream & | write (const doubleScalar val) |
Write doubleScalar. More... | |
virtual Ostream & | write (const char *buf, std::streamsize count) |
Write binary block. More... | |
virtual void | indent () |
Add indentation characters. More... | |
virtual void | print (Ostream &os) const |
Print description of IOstream to Ostream. More... | |
Public Member Functions inherited from OSstream | |
OSstream (std::ostream &os, const string &name, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED) | |
Construct as wrapper around std::ostream and 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 Ostream & | writeRaw (const char *data, std::streamsize count) |
Low-level raw binary output. More... | |
virtual bool | beginRawWrite (std::streamsize count) |
Begin marker for low-level raw binary output. More... | |
virtual bool | endRawWrite () |
End marker for low-level raw binary output. More... | |
virtual ios_base::fmtflags | flags (const ios_base::fmtflags f) |
Set stream flags. More... | |
virtual void | flush () |
Flush stream. More... | |
virtual void | endl () |
Add newline and flush stream. More... | |
virtual char | fill () const |
Get the current padding character. More... | |
virtual char | fill (const char fillch) |
Set padding character for formatted field up to field width. More... | |
virtual int | width () const |
Get width of output field. More... | |
virtual int | width (const int w) |
Set width of output field. More... | |
virtual int | precision () const |
Get precision of output field. More... | |
virtual int | precision (const int p) |
Set precision of output field. More... | |
virtual std::ostream & | stdStream () |
Access to underlying std::ostream. More... | |
virtual const std::ostream & | stdStream () const |
Const access to underlying std::ostream. More... | |
Public Member Functions inherited from Ostream | |
Ostream (streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED) | |
Construct and set stream status. More... | |
virtual | ~Ostream ()=default |
Destructor. More... | |
virtual Ostream & | write (const keyType &kw) |
Write keyType. More... | |
unsigned short | indentSize () const |
Return indent level. More... | |
unsigned short & | indentSize () |
Access to indent size. More... | |
unsigned short | indentLevel () const |
Return indent level. More... | |
unsigned short & | indentLevel () |
Access to indent level. More... | |
void | incrIndent () |
Increment the indent level. More... | |
void | decrIndent () |
Decrement the indent level. More... | |
virtual Ostream & | writeKeyword (const keyType &kw) |
Write the keyword followed by an appropriate indentation. More... | |
virtual Ostream & | beginBlock (const keyType &kw) |
Write begin block group with the given name. More... | |
virtual Ostream & | beginBlock () |
Write begin block group without a name. More... | |
virtual Ostream & | endBlock () |
Write end block group. More... | |
virtual Ostream & | endEntry () |
Write end entry (';') followed by newline. More... | |
template<class T > | |
Ostream & | writeEntry (const keyType &key, const T &value) |
Write a keyword/value entry. More... | |
template<class T > | |
Ostream & | writeEntryIfDifferent (const word &key, const T &value1, const T &value2) |
Write a keyword/value entry only when the two values differ. More... | |
Ostream & | operator() () const |
Return a non-const reference to const Ostream. More... | |
Public Member Functions inherited from IOstream | |
IOstream (const IOstreamOption option) | |
Construct with specified stream option. More... | |
IOstream (streamFormat format, versionNumber version, compressionType compression=UNCOMPRESSED) | |
Construct with format, version. More... | |
virtual | ~IOstream ()=default |
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 bool () const | |
Return true if the stream has not failed. More... | |
bool | operator! () const |
Return true if the stream has failed. More... | |
unsigned | labelByteSize () const |
The label byte-size associated with the stream. More... | |
unsigned | scalarByteSize () const |
The scalar byte-size associated with the stream. More... | |
void | setLabelByteSize (unsigned nbytes) |
Set the label byte-size associated with the stream. More... | |
void | setScalarByteSize (unsigned nbytes) |
Set the scalar byte-size associated with the stream. More... | |
template<class T = label> | |
std::enable_if< std::is_integral< T >::value, bool >::type | checkLabelSize () const |
template<class T = scalar> | |
std::enable_if< std::is_floating_point< T >::value, bool >::type | checkScalarSize () const |
label | lineNumber () const |
Const access to the current stream line number. More... | |
label & | lineNumber () |
Non-const access to the current stream line number. More... | |
label | lineNumber (const label num) |
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 f) |
Unset flags of stream. More... | |
void | print (Ostream &os, const int streamState) const |
Print information about the stream state bits. More... | |
InfoProxy< IOstream > | info () const |
Return info proxy. More... | |
Public Member Functions inherited from IOstreamOption | |
IOstreamOption () noexcept | |
Construct null. (default: ASCII, uncompressed, currentVersion) More... | |
IOstreamOption (streamFormat format) noexcept | |
Construct with format. (default: uncompressed, currentVersion) More... | |
IOstreamOption (streamFormat format, compressionType compression, versionNumber version=currentVersion) noexcept | |
Construct with format and compression, optionally with version. More... | |
IOstreamOption (streamFormat format, versionNumber version, compressionType compression) noexcept | |
Construct with format, version, compression. More... | |
streamFormat | format () const noexcept |
Get the current stream format. More... | |
streamFormat | format (const streamFormat format) noexcept |
Set the stream format. More... | |
streamFormat | format (const word &formatName) |
Set the stream format, from string value. More... | |
compressionType | compression () const noexcept |
Get the stream compression. More... | |
compressionType | compression (const compressionType comp) noexcept |
Set the stream compression. More... | |
compressionType | compression (const word &compressionName) |
Set the stream compression, from string value. More... | |
versionNumber | version () const noexcept |
Get the stream version. More... | |
versionNumber | version (const versionNumber verNum) noexcept |
Set the stream version. More... | |
Additional Inherited Members | |
Public Types inherited from IOstream | |
enum | streamAccess : char { CLOSED = 0, OPENED } |
Enumeration for stream open/closed state. More... | |
Public Types inherited from IOstreamOption | |
enum | streamFormat : char { ASCII, BINARY } |
Data format (ascii | binary) More... | |
enum | compressionType : char { UNCOMPRESSED = 0, COMPRESSED } |
Compression treatment (UNCOMPRESSED | COMPRESSED) More... | |
Static Public Member Functions inherited from IOstream | |
static unsigned int | defaultPrecision () |
Return the default precision. More... | |
static unsigned int | defaultPrecision (unsigned int prec) |
Reset the default precision. More... | |
Static Public Member Functions inherited from IOstreamOption | |
static streamFormat | formatEnum (const word &formatName) |
The stream format enum corresponding to the string. More... | |
static compressionType | compressionEnum (const word &compName) |
The compression enum corresponding to the string. More... | |
Static Public Attributes inherited from IOstream | |
static unsigned int | precision_ |
Default precision. More... | |
Static Public Attributes inherited from IOstreamOption | |
static const Enum< streamFormat > | formatNames |
Stream format names (ascii, binary) More... | |
static const versionNumber | originalVersion |
The original version number. More... | |
static const versionNumber | currentVersion |
The current version number. More... | |
Protected Member Functions inherited from IOstream | |
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... | |
Protected Attributes inherited from Ostream | |
unsigned short | indentSize_ = 4 |
Number of spaces per indent level. More... | |
unsigned short | indentLevel_ = 0 |
Current indent level. More... | |
Protected Attributes inherited from IOstream | |
streamAccess | openClosed_ |
ios_base::iostate | ioState_ |
unsigned short | labelByteSize_ |
The label byte-size (could also be stored as byte) More... | |
unsigned short | scalarByteSize_ |
The scalar byte-size (could also be stored as byte) More... | |
label | lineNumber_ |
The file line. More... | |
Static Protected Attributes inherited from Ostream | |
static constexpr const unsigned short | entryIndentation_ = 16 |
Indentation of the entry from the start of the keyword. More... | |
Static Protected Attributes inherited from IOstream | |
static fileName | staticName_ |
Name for any generic stream - normally treat as readonly. 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 53 of file prefixOSstream.H.
prefixOSstream | ( | std::ostream & | os, |
const string & | name, | ||
streamFormat | format = ASCII , |
||
versionNumber | version = currentVersion , |
||
compressionType | compression = UNCOMPRESSED |
||
) |
Construct and set stream status.
Definition at line 47 of file prefixOSstream.C.
|
inline |
Return the stream prefix.
Definition at line 88 of file prefixOSstream.H.
Referenced by dynamicIndexedOctree< Foam::dynamicTreeDataPoint >::print(), and indexedOctree< Foam::treeDataFace >::print().
|
inline |
Return non-const access to the stream prefix.
Definition at line 94 of file prefixOSstream.H.
Write token to stream or otherwise handle it.
Reimplemented from OSstream.
Definition at line 70 of file prefixOSstream.C.
References token::BEGIN_BLOCK, token::END_BLOCK, token::HASH, token::stringToken(), token::type(), and Foam::vtk::write().
|
virtual |
Write character.
Reimplemented from OSstream.
Definition at line 108 of file prefixOSstream.C.
References Foam::constant::universal::c, token::NL, and OSstream::write().
|
virtual |
Write character string.
Reimplemented from OSstream.
Definition at line 122 of file prefixOSstream.C.
References token::NL, and OSstream::write().
|
virtual |
Write word.
Reimplemented from OSstream.
Definition at line 137 of file prefixOSstream.C.
References Foam::val, and OSstream::write().
|
virtual |
Write string.
Reimplemented from OSstream.
Definition at line 144 of file prefixOSstream.C.
References Foam::val, and OSstream::write().
|
virtual |
Write std::string surrounded by quotes.
Optional write without quotes.
Reimplemented from OSstream.
Definition at line 152 of file prefixOSstream.C.
References Foam::val, and OSstream::writeQuoted().
|
virtual |
Write int32_t.
Reimplemented from OSstream.
Definition at line 162 of file prefixOSstream.C.
References Foam::val, and OSstream::write().
|
virtual |
Write int64_t.
Reimplemented from OSstream.
Definition at line 169 of file prefixOSstream.C.
References Foam::val, and OSstream::write().
|
virtual |
Write floatScalar.
Reimplemented from OSstream.
Definition at line 176 of file prefixOSstream.C.
References Foam::val, and OSstream::write().
|
virtual |
Write doubleScalar.
Reimplemented from OSstream.
Definition at line 183 of file prefixOSstream.C.
References Foam::val, and OSstream::write().
|
virtual |
Write binary block.
Reimplemented from OSstream.
Definition at line 191 of file prefixOSstream.C.
References Foam::BitOps::count(), and OSstream::write().
|
virtual |
Add indentation characters.
Reimplemented from OSstream.
Definition at line 201 of file prefixOSstream.C.
References OSstream::indent().
|
virtual |
Print description of IOstream to Ostream.
Reimplemented from OSstream.
Definition at line 63 of file prefixOSstream.C.
References OSstream::print().