prefixOSstream Class Reference

Version of OSstream that prints a prefix on each line. More...

Inheritance diagram for prefixOSstream:
[legend]
Collaboration diagram for prefixOSstream:
[legend]

Public Member Functions

 prefixOSstream (std::ostream &os, const string &streamName, IOstreamOption streamOpt=IOstreamOption())
 Construct and set stream status. More...
 
 prefixOSstream (std::ostream &os, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 Construct and set stream status. More...
 
const stringprefix () const noexcept
 Return the stream prefix. More...
 
stringprefix () noexcept
 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 Ostreamwrite (const char c)
 Write character. More...
 
virtual Ostreamwrite (const char *str)
 Write character string. More...
 
virtual Ostreamwrite (const word &val)
 Write word. More...
 
virtual Ostreamwrite (const string &val)
 Write string. More...
 
virtual OstreamwriteQuoted (const std::string &val, const bool quoted=true)
 Write std::string surrounded by quotes. More...
 
virtual Ostreamwrite (const int32_t val)
 Write int32_t. More...
 
virtual Ostreamwrite (const int64_t val)
 Write int64_t. More...
 
virtual Ostreamwrite (const floatScalar val)
 Write floatScalar. More...
 
virtual Ostreamwrite (const doubleScalar val)
 Write doubleScalar. More...
 
virtual Ostreamwrite (const char *buf, std::streamsize count)
 Write binary block. More...
 
virtual void indent ()
 Add indentation characters. More...
 
virtual void print (Ostream &os) const
 Print stream description to Ostream. More...
 
- Public Member Functions inherited from OSstream
 OSstream (const OSstream &)=default
 Copy construct. More...
 
void operator= (const OSstream &)=delete
 No copy assignment. More...
 
 OSstream (std::ostream &os, const string &streamName, IOstreamOption streamOpt=IOstreamOption())
 Construct wrapper around std::ostream, set stream status. More...
 
 OSstream (std::ostream &os, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 Construct wrapper around std::ostream, set stream status. More...
 
virtual const fileNamename () const
 Get the name of the stream. More...
 
virtual fileNamename ()
 Return stream name for modification. More...
 
virtual ios_base::fmtflags flags () const
 Get stream flags. More...
 
virtual bool write (const token &tok)
 Write token to stream or otherwise handle it. More...
 
virtual Ostreamwrite (const char c)
 Write character. More...
 
virtual Ostreamwrite (const char *str)
 Write character string. More...
 
virtual Ostreamwrite (const word &str)
 Write word. More...
 
virtual Ostreamwrite (const string &str)
 Write string (quoted) More...
 
virtual OstreamwriteQuoted (const std::string &str, const bool quoted=true)
 Write std::string surrounded by quotes. More...
 
virtual Ostreamwrite (const int32_t val)
 Write int32_t. More...
 
virtual Ostreamwrite (const int64_t val)
 Write int64_t. More...
 
virtual Ostreamwrite (const floatScalar val)
 Write floatScalar. More...
 
virtual Ostreamwrite (const doubleScalar val)
 Write doubleScalar. More...
 
virtual Ostreamwrite (const char *data, std::streamsize count)
 Write binary block. More...
 
virtual OstreamwriteRaw (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 void indent ()
 Add indentation characters. 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...
 
virtual void print (Ostream &os) const
 Print stream description to Ostream. More...
 
- Public Member Functions inherited from Ostream
 Ostream (const Ostream &)=default
 Copy construct. More...
 
virtual ~Ostream ()=default
 Destructor. More...
 
 Ostream (IOstreamOption streamOpt=IOstreamOption())
 
 Ostream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 Construct with format, version (compression) More...
 
virtual bool write (const token &tok)=0
 Write token to stream or otherwise handle it. More...
 
virtual Ostreamwrite (const char c)=0
 Write character. More...
 
virtual Ostreamwrite (const char *str)=0
 Write character string. More...
 
virtual Ostreamwrite (const word &str)=0
 Write word. More...
 
virtual Ostreamwrite (const keyType &kw)
 Write keyType. More...
 
virtual Ostreamwrite (const string &str)=0
 Write string. More...
 
virtual OstreamwriteQuoted (const std::string &str, const bool quoted=true)=0
 Write std::string surrounded by quotes. More...
 
virtual Ostreamwrite (const int32_t val)=0
 Write int32_t. More...
 
virtual Ostreamwrite (const int64_t val)=0
 Write int64_t. More...
 
virtual Ostreamwrite (const floatScalar val)=0
 Write floatScalar. More...
 
virtual Ostreamwrite (const doubleScalar val)=0
 Write doubleScalar. More...
 
virtual Ostreamwrite (const char *data, std::streamsize count)=0
 Write binary block. More...
 
virtual OstreamwriteRaw (const char *data, std::streamsize count)=0
 Low-level raw binary output. More...
 
virtual bool beginRawWrite (std::streamsize count)=0
 Emit begin marker for low-level raw binary output. More...
 
virtual bool endRawWrite ()=0
 Emit end marker for low-level raw binary output. More...
 
virtual void indent ()=0
 Add indentation characters. More...
 
unsigned short indentSize () const noexcept
 Return indent size (spaces per level) More...
 
unsigned short indentSize (unsigned short val) noexcept
 Change indent size (spaces per level), return old value. More...
 
unsigned short indentLevel () const noexcept
 Return the indent level. More...
 
unsigned short indentLevel (unsigned short val) noexcept
 Change the indent level, return old value. More...
 
void incrIndent () noexcept
 Increment the indent level. More...
 
void decrIndent ()
 Decrement the indent level. More...
 
virtual OstreamwriteKeyword (const keyType &kw)
 Write the keyword followed by an appropriate indentation. More...
 
virtual OstreambeginBlock (const keyType &kw)
 Write begin block group with the given name. More...
 
virtual OstreambeginBlock ()
 Write begin block group without a name. More...
 
virtual OstreamendBlock ()
 Write end block group. More...
 
virtual OstreamendEntry ()
 Write end entry (';') followed by newline. More...
 
template<class T >
OstreamwriteEntry (const keyType &key, const T &value)
 Write a keyword/value entry. More...
 
template<class T >
OstreamwriteEntryIfDifferent (const word &key, const T &value1, const T &value2)
 Write a keyword/value entry only when the two values differ. More...
 
virtual void flush ()=0
 Flush stream. More...
 
virtual void endl ()=0
 Add newline and flush stream. More...
 
virtual char fill () const =0
 Get padding character. More...
 
virtual char fill (const char fillch)=0
 Set padding character for formatted field up to field width. More...
 
virtual int width () const =0
 Get width of output field. More...
 
virtual int width (const int w)=0
 Set width of output field (and return old width) More...
 
virtual int precision () const =0
 Get precision of output field. More...
 
virtual int precision (const int p)=0
 Set precision of output field (and return old precision) More...
 
Ostreamoperator() () const
 Return a non-const reference to const Ostream. More...
 
unsigned short & indentLevel () noexcept
 Access to indent level. More...
 
unsigned short & indentSize () noexcept
 Access to indent size. More...
 
- Public Member Functions inherited from IOstream
 IOstream (const IOstream &)=default
 Copy construct. More...
 
virtual ~IOstream ()=default
 Destructor. More...
 
 IOstream (IOstreamOption streamOpt=IOstreamOption())
 
 IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 Construct with format, version (compression) More...
 
virtual const fileNamename () const
 Return the name of the stream. More...
 
virtual fileNamename ()
 Return stream name for modification. More...
 
fileName relativeName () const
 Return the name of the stream relative to the current case. More...
 
virtual bool check (const char *operation) const
 Check IOstream status for given operation. More...
 
bool fatalCheck (const char *operation) const
 Check IOstream status for given operation. More...
 
bool opened () const noexcept
 True if stream has been opened. More...
 
bool closed () const noexcept
 True if stream is closed. More...
 
bool good () const noexcept
 True if next operation might succeed. More...
 
bool eof () const noexcept
 True if end of input seen. More...
 
bool fail () const noexcept
 True if next operation will fail. More...
 
bool bad () const noexcept
 True if stream is corrupted. More...
 
 operator bool () const noexcept
 Return true if the stream has not failed. More...
 
bool operator! () const noexcept
 Return true if the stream has failed. More...
 
unsigned labelByteSize () const noexcept
 The sizeof (label) in bytes associated with the stream. More...
 
unsigned scalarByteSize () const noexcept
 The sizeof (scalar) in bytes associated with the stream. More...
 
void setLabelByteSize (unsigned nbytes) noexcept
 Set the sizeof (label) in bytes associated with the stream. More...
 
void setScalarByteSize (unsigned nbytes) noexcept
 Set the sizeof (scalar) in bytes associated with the stream. More...
 
template<class T = label>
std::enable_if< std::is_integral< T >::value, bool >::type checkLabelSize () const noexcept
 
template<class T = scalar>
std::enable_if< std::is_floating_point< T >::value, bool >::type checkScalarSize () const noexcept
 
label lineNumber () const noexcept
 Const access to the current stream line number. More...
 
label & lineNumber () noexcept
 Non-const access to the current stream line number. More...
 
label lineNumber (const label num) noexcept
 Set the stream line number. More...
 
virtual ios_base::fmtflags flags () const =0
 Return flags of stream. More...
 
void setEof () noexcept
 Set stream state as reached 'eof'. More...
 
void setFail () noexcept
 Set stream state as 'failed'. More...
 
void setBad ()
 Set stream state to be 'bad'. More...
 
virtual ios_base::fmtflags flags (const ios_base::fmtflags f)=0
 Set flags of stream. 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...
 
virtual void print (Ostream &os) const
 Print stream description to Ostream. More...
 
void print (Ostream &os, const int streamState) const
 Print information about the stream state bits. More...
 
InfoProxy< IOstreaminfo () const
 Return info proxy. More...
 
- Public Member Functions inherited from IOstreamOption
constexpr IOstreamOption (streamFormat fmt=streamFormat::ASCII, compressionType comp=compressionType::UNCOMPRESSED) noexcept
 
constexpr IOstreamOption (streamFormat fmt, compressionType comp, versionNumber ver) noexcept
 Construct from components (format, compression, version) More...
 
constexpr IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept
 Construct from components (format, version, compression) More...
 
 IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept
 Copy construct with change of format. More...
 
streamFormat format () const noexcept
 Get the current stream format. More...
 
streamFormat format (const streamFormat fmt) 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 &compName)
 Set the stream compression from string value. More...
 
versionNumber version () const noexcept
 Get the stream version. More...
 
versionNumber version (const versionNumber ver) noexcept
 Set the stream version. More...
 
versionNumber version (const token &tok)
 Set the stream version from token. 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 = 0 , 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 () noexcept
 Return the default precision. More...
 
static unsigned int defaultPrecision (unsigned int prec) noexcept
 Reset the default precision. More...
 
- Static Public Member Functions inherited from IOstreamOption
static streamFormat formatEnum (const word &formatName, const streamFormat deflt=streamFormat::ASCII)
 
static streamFormat formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII)
 Failsafe construct streamFormat from optional dictionary lookup. More...
 
static compressionType compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED)
 The compression enum corresponding to the string. More...
 
static compressionType compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED)
 Failsafe construct compressionType from optional dictionary lookup. More...
 
- Static Public Attributes inherited from IOstream
static unsigned int precision_
 Default precision. More...
 
- Static Public Attributes inherited from IOstreamOption
static const Enum< streamFormatformatNames
 Stream format names (ascii, binary) More...
 
static const versionNumber currentVersion
 The current version number (2.0) More...
 
- Protected Member Functions inherited from IOstream
void setOpened () noexcept
 Set stream opened. More...
 
void setClosed () noexcept
 Set stream closed. More...
 
void setState (std::ios_base::iostate state) noexcept
 Set stream state. More...
 
void setGood () noexcept
 Set stream state 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
std::ios_base::iostate ioState_
 Mirror of internal stream io state. More...
 
streamAccess openClosed_
 The stream open/closed state. More...
 
unsigned char sizeofLabel_
 The sizeof (label), possibly read from the header. More...
 
unsigned char sizeofScalar_
 The sizeof (scalar), possibly read from the header. 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...
 

Detailed Description

Version of OSstream that 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.

Source files

Definition at line 54 of file prefixOSstream.H.

Constructor & Destructor Documentation

◆ prefixOSstream() [1/2]

prefixOSstream ( std::ostream &  os,
const string streamName,
IOstreamOption  streamOpt = IOstreamOption() 
)

Construct and set stream status.

Definition at line 47 of file prefixOSstream.C.

◆ prefixOSstream() [2/2]

Construct and set stream status.

Definition at line 83 of file prefixOSstream.H.

Member Function Documentation

◆ prefix() [1/2]

const string & prefix ( ) const
inlinenoexcept

Return the stream prefix.

Definition at line 101 of file prefixOSstream.H.

◆ prefix() [2/2]

string & prefix ( )
inlinenoexcept

Return non-const access to the stream prefix.

Definition at line 107 of file prefixOSstream.H.

◆ write() [1/10]

bool write ( const token tok)
virtual

Write token to stream or otherwise handle it.

Returns
false if the token type was not handled by this method

Reimplemented from OSstream.

Definition at line 69 of file prefixOSstream.C.

References ObukhovLength::write().

Here is the call graph for this function:

◆ write() [2/10]

Foam::Ostream & write ( const char  c)
virtual

Write character.

Reimplemented from OSstream.

Definition at line 75 of file prefixOSstream.C.

References token::NL, and ObukhovLength::write().

Here is the call graph for this function:

◆ write() [3/10]

Foam::Ostream & write ( const char *  str)
virtual

Write character string.

Reimplemented from OSstream.

Definition at line 89 of file prefixOSstream.C.

References token::NL, and ObukhovLength::write().

Here is the call graph for this function:

◆ write() [4/10]

Foam::Ostream & write ( const word val)
virtual

Write word.

Reimplemented from OSstream.

Definition at line 104 of file prefixOSstream.C.

References ObukhovLength::write().

Here is the call graph for this function:

◆ write() [5/10]

Foam::Ostream & write ( const string val)
virtual

Write string.

Reimplemented from OSstream.

Definition at line 111 of file prefixOSstream.C.

References ObukhovLength::write().

Here is the call graph for this function:

◆ writeQuoted()

Foam::Ostream & writeQuoted ( const std::string &  val,
const bool  quoted = true 
)
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().

Here is the call graph for this function:

◆ write() [6/10]

Foam::Ostream & write ( const int32_t  val)
virtual

Write int32_t.

Reimplemented from OSstream.

Definition at line 129 of file prefixOSstream.C.

References ObukhovLength::write().

Here is the call graph for this function:

◆ write() [7/10]

Foam::Ostream & write ( const int64_t  val)
virtual

Write int64_t.

Reimplemented from OSstream.

Definition at line 136 of file prefixOSstream.C.

References ObukhovLength::write().

Here is the call graph for this function:

◆ write() [8/10]

Foam::Ostream & write ( const floatScalar  val)
virtual

Write floatScalar.

Reimplemented from OSstream.

Definition at line 143 of file prefixOSstream.C.

References ObukhovLength::write().

Here is the call graph for this function:

◆ write() [9/10]

Foam::Ostream & write ( const doubleScalar  val)
virtual

Write doubleScalar.

Reimplemented from OSstream.

Definition at line 150 of file prefixOSstream.C.

References ObukhovLength::write().

Here is the call graph for this function:

◆ write() [10/10]

Foam::Ostream & write ( const char *  buf,
std::streamsize  count 
)
virtual

Write binary block.

Reimplemented from OSstream.

Definition at line 157 of file prefixOSstream.C.

References ObukhovLength::write().

Here is the call graph for this function:

◆ indent()

void indent ( )
virtual

Add indentation characters.

Reimplemented from OSstream.

Definition at line 168 of file prefixOSstream.C.

References OSstream::indent().

Here is the call graph for this function:

◆ print()

void print ( Ostream os) const
virtual

Print stream description to Ostream.

Reimplemented from OSstream.

Definition at line 62 of file prefixOSstream.C.

References os(), and objectiveManager::print().

Here is the call graph for this function:

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