prefixOSstream Class Reference

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

Inheritance diagram for prefixOSstream:
Collaboration diagram for prefixOSstream:

Public Member Functions

 prefixOSstream (ostream &os, const string &name, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
 Set stream status. More...
 
const stringprefix () const
 Return the prefix of the stream. More...
 
stringprefix ()
 Return non-const access to the prefix of the stream. More...
 
virtual Ostreamwrite (const char)
 Write character. More...
 
virtual Ostreamwrite (const char *)
 Write character string. More...
 
virtual Ostreamwrite (const word &)
 Write word. More...
 
virtual Ostreamwrite (const string &)
 Write string. More...
 
virtual Ostreamwrite (const verbatimString &)
 Write verbatimString. More...
 
virtual OstreamwriteQuoted (const std::string &, const bool quoted=true)
 Write std::string surrounded by quotes. More...
 
virtual Ostreamwrite (const int32_t)
 Write int32_t. More...
 
virtual Ostreamwrite (const int64_t)
 Write int64_t. More...
 
virtual Ostreamwrite (const floatScalar)
 Write floatScalar. More...
 
virtual Ostreamwrite (const doubleScalar)
 Write doubleScalar. More...
 
virtual Ostreamwrite (const longDoubleScalar)
 Write longDoubleScalar. More...
 
virtual Ostreamwrite (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...
 
- Public Member Functions inherited from OSstream
 OSstream (ostream &os, const string &name, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
 Set stream status. More...
 
virtual const fileNamename () const
 Return the name of the stream. More...
 
virtual fileNamename ()
 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...
 
- Public Member Functions inherited from Ostream
 Ostream (streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
 Set stream status. More...
 
virtual ~Ostream ()
 Destructor. 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...
 
OstreamwriteKeyword (const keyType &)
 Write the keyword followed by an appropriate indentation. More...
 
Ostreamoperator() () const
 Return a non-const reference to const Ostream. More...
 
- Public Member Functions inherited from IOstream
 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...
 
labellineNumber ()
 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< IOstreaminfo () const
 Return info proxy. More...
 

Additional Inherited Members

- Public Types inherited from IOstream
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 Public Member Functions inherited from IOstream
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 Public Attributes inherited from IOstream
static const versionNumber currentVersion
 Current version number. More...
 
static unsigned int precision_
 Default precision. 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 indentLevel_
 Current indent level. More...
 
- Protected Attributes inherited from IOstream
label lineNumber_
 
- Static Protected Attributes inherited from Ostream
static const unsigned short indentSize_ = 4
 Number of spaces per indent level. More...
 

Detailed Description

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.

Source files

Definition at line 51 of file prefixOSstream.H.

Constructor & Destructor Documentation

◆ prefixOSstream()

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.

Member Function Documentation

◆ prefix() [1/2]

const string& prefix ( ) const
inline

Return the prefix of the stream.

Definition at line 86 of file prefixOSstream.H.

Referenced by NamedEnum< compressibleField, 8 >::names(), dynamicIndexedOctree< Foam::dynamicTreeDataPoint >::print(), and indexedOctree< Foam::treeDataFace >::print().

Here is the caller graph for this function:

◆ prefix() [2/2]

string& prefix ( )
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().

Here is the call graph for this function:

◆ write() [1/11]

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

Write character.

Reimplemented from OSstream.

Definition at line 68 of file prefixOSstream.C.

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

Referenced by prefixOSstream::prefix(), and prefixOSstream::write().

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

◆ write() [2/11]

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

Write character string.

Reimplemented from OSstream.

Definition at line 82 of file prefixOSstream.C.

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

Here is the call graph for this function:

◆ write() [3/11]

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

Write word.

Reimplemented from OSstream.

Definition at line 97 of file prefixOSstream.C.

References OSstream::write().

Here is the call graph for this function:

◆ write() [4/11]

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

Write string.

Reimplemented from OSstream.

Definition at line 104 of file prefixOSstream.C.

References OSstream::write().

Here is the call graph for this function:

◆ write() [5/11]

Foam::Ostream & write ( const verbatimString vs)
virtual

Write verbatimString.

Reimplemented from OSstream.

Definition at line 111 of file prefixOSstream.C.

References OSstream::write(), and prefixOSstream::writeQuoted().

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 119 of file prefixOSstream.C.

References OSstream::writeQuoted().

Referenced by prefixOSstream::prefix(), and prefixOSstream::write().

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

◆ write() [6/11]

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

Write int32_t.

Reimplemented from OSstream.

Definition at line 129 of file prefixOSstream.C.

References OSstream::write().

Here is the call graph for this function:

◆ write() [7/11]

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

Write int64_t.

Reimplemented from OSstream.

Definition at line 136 of file prefixOSstream.C.

References OSstream::write().

Here is the call graph for this function:

◆ write() [8/11]

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

Write floatScalar.

Reimplemented from OSstream.

Definition at line 143 of file prefixOSstream.C.

References OSstream::write().

Here is the call graph for this function:

◆ write() [9/11]

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

Write doubleScalar.

Reimplemented from OSstream.

Definition at line 150 of file prefixOSstream.C.

References OSstream::write().

Here is the call graph for this function:

◆ write() [10/11]

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

Write longDoubleScalar.

Reimplemented from OSstream.

Definition at line 157 of file prefixOSstream.C.

References OSstream::write(), and prefixOSstream::write().

Here is the call graph for this function:

◆ write() [11/11]

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

Write binary block.

Reimplemented from OSstream.

Definition at line 165 of file prefixOSstream.C.

References OSstream::write().

Here is the call graph for this function:

◆ indent()

void indent ( )
virtual

Add indentation characters.

Reimplemented from OSstream.

Definition at line 175 of file prefixOSstream.C.

References OSstream::indent().

Referenced by prefixOSstream::prefix().

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

◆ print()

void print ( Ostream os) const
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().

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

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