OSstream Class Reference

Generic output stream using a standard (STL) stream. More...

Inheritance diagram for OSstream:
Collaboration diagram for OSstream:

Public Member Functions

 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::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 Construct wrapper around std::ostream, set stream status. More...
 
 OSstream (std::ostream &os, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 Construct wrapper around std::ostream, set stream status. More...
 
virtual const fileNamename () const override
 Get the name of the output serial stream. (eg, the name of the Fstream file name) More...
 
virtual const std::ostream & stdStream () const
 Const access to underlying std::ostream. More...
 
virtual std::ostream & stdStream ()
 Access to underlying std::ostream. More...
 
virtual ios_base::fmtflags flags () const override
 Get stream flags. More...
 
virtual ios_base::fmtflags flags (const ios_base::fmtflags f) override
 Set stream flags. More...
 
void syncState ()
 Set stream state to match that of the std::ostream. More...
 
virtual bool write (const token &tok) override
 Write token to stream or otherwise handle it. More...
 
virtual Ostreamwrite (const char c) override
 Write character. More...
 
virtual OstreamwriteQuoted (const char *str, std::streamsize len, const bool quoted=true) override
 Write character/string content, with/without surrounding quotes. More...
 
virtual Ostreamwrite (const char *str) override
 Write character string. More...
 
virtual Ostreamwrite (const word &str) override
 Write word. More...
 
virtual Ostreamwrite (const std::string &str) override
 Write string (quoted) More...
 
virtual Ostreamwrite (const int32_t val) override
 Write int32_t. More...
 
virtual Ostreamwrite (const int64_t val) override
 Write int64_t. More...
 
virtual Ostreamwrite (const float val) override
 Write float. More...
 
virtual Ostreamwrite (const double val) override
 Write double. More...
 
virtual Ostreamwrite (const char *data, std::streamsize count) override
 Write binary block. More...
 
virtual OstreamwriteRaw (const char *data, std::streamsize count) override
 Low-level raw binary output. More...
 
virtual bool beginRawWrite (std::streamsize count) override
 Begin marker for low-level raw binary output. More...
 
virtual bool endRawWrite () override
 End marker for low-level raw binary output. More...
 
virtual void indent () override
 Add indentation characters. More...
 
virtual void flush () override
 Flush stream. More...
 
virtual void endl () override
 Add newline and flush stream. More...
 
virtual char fill () const override
 Get the current padding character. More...
 
virtual char fill (const char fillch) override
 Set padding character for formatted field up to field width. More...
 
virtual int width () const override
 Get width of output field. More...
 
virtual int width (const int w) override
 Set width of output field. More...
 
virtual int precision () const override
 Get precision of output field. More...
 
virtual int precision (const int p) override
 Set precision of output field. More...
 
virtual void print (Ostream &os) const override
 Print stream description to Ostream. More...
 
virtual OstreamwriteQuoted (const char *str, std::streamsize len, const bool quoted=true)=0
 Inherit write methods from Ostream. More...
 
virtual OstreamwriteQuoted (const std::string &str, const bool quoted=true)
 Inherit write methods from Ostream. More...
 
- Public Member Functions inherited from Ostream
 Ostream (const Ostream &)=default
 Copy construct. More...
 
virtual ~Ostream ()=default
 Destructor. More...
 
 Ostream (IOstreamOption streamOpt=IOstreamOption())
 Default construct (ASCII, uncompressed), construct with specified stream option. More...
 
 Ostream (IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 Construct with format (uncompressed) More...
 
virtual OstreamwriteQuoted (const std::string &str, const bool quoted=true)
 Write string content, with/without surrounding quotes. More...
 
virtual Ostreamwrite (const keyType &kw)
 Write keyType. 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...
 
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())
 Default construct (ASCII, uncompressed), construct with specified stream option. More...
 
 IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 Construct with format, version (compression) 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
 Check if the label byte-size associated with the stream is the same as the given type. More...
 
template<class T = scalar>
std::enable_if< std::is_floating_point< T >::value, bool >::type checkScalarSize () const noexcept
 Check if the scalar byte-size associated with the stream is the same as the given type. More...
 
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...
 
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...
 
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< IOstreaminfo () const noexcept
 Return info proxy, used to print IOstream information to a stream. More...
 
- Public Member Functions inherited from IOstreamOption
constexpr IOstreamOption (streamFormat fmt=streamFormat::ASCII, compressionType comp=compressionType::UNCOMPRESSED) noexcept
 Default construct (ASCII, UNCOMPRESSED, currentVersion) or construct with format, compression. More...
 
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...
 
enum  appendType : char { NON_APPEND = 0, APPEND }
 File appending (NON_APPEND | APPEND) More...
 
enum  atomicType : char { NON_ATOMIC = 0, ATOMIC }
 Atomic operations (output) More...
 
enum  floatFormat : unsigned { general = unsigned(0), fixed = unsigned(std::ios_base::fixed), scientific = unsigned(std::ios_base::scientific) }
 Float formats (eg, time directory name formats) 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 floatFormat floatFormatEnum (const word &fmtName, const floatFormat deflt=floatFormat::general)
 Lookup floatFormat enum corresponding to the string (general | fixed | scientific). More...
 
static floatFormat floatFormatEnum (const word &key, const dictionary &dict, const floatFormat deflt=floatFormat::general)
 getOrDefault floatFormat from dictionary, warn only on bad enumeration. More...
 
static streamFormat formatEnum (const word &fmtName, const streamFormat deflt=streamFormat::ASCII)
 Lookup streamFormat enum corresponding to the string (ascii | binary). More...
 
static streamFormat formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII)
 getOrDefault streamFormat from dictionary, warn only on bad enumeration. 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)
 getOrDefault compressionType from dictionary, warn only on bad enumeration. More...
 
- Static Public Attributes inherited from IOstream
static unsigned int precision_
 Default precision. More...
 
- Static Public Attributes inherited from IOstreamOption
static const Enum< floatFormatfloatFormatNames
 Names for float formats (general, fixed, scientific) More...
 
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

Generic output stream using a standard (STL) stream.

Source files

Definition at line 50 of file OSstream.H.

Constructor & Destructor Documentation

◆ OSstream() [1/4]

OSstream ( const OSstream )
default

Copy construct.

◆ OSstream() [2/4]

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

Construct wrapper around std::ostream, set stream status.

Default stream options (ASCII, uncompressed)

Definition at line 27 of file OSstreamI.H.

◆ OSstream() [3/4]

OSstream ( std::ostream &  os,
const string streamName,
IOstreamOption::streamFormat  fmt,
IOstreamOption::compressionType  cmp = IOstreamOption::UNCOMPRESSED 
)
inline

Construct wrapper around std::ostream, set stream status.

Definition at line 94 of file OSstream.H.

◆ OSstream() [4/4]

Construct wrapper around std::ostream, set stream status.

Definition at line 108 of file OSstream.H.

Member Function Documentation

◆ operator=()

void operator= ( const OSstream )
delete

No copy assignment.

◆ name()

◆ stdStream() [1/2]

virtual const std::ostream& stdStream ( ) const
inlinevirtual

Const access to underlying std::ostream.

Reimplemented in OFstream.

Definition at line 136 of file OSstream.H.

◆ stdStream() [2/2]

virtual std::ostream& stdStream ( )
inlinevirtual

Access to underlying std::ostream.

Reimplemented in OFstream.

Definition at line 141 of file OSstream.H.

◆ flags() [1/2]

virtual ios_base::fmtflags flags ( ) const
inlineoverridevirtual

Get stream flags.

Implements IOstream.

Definition at line 149 of file OSstream.H.

Referenced by objective::write().

Here is the caller graph for this function:

◆ flags() [2/2]

virtual ios_base::fmtflags flags ( const ios_base::fmtflags  f)
inlineoverridevirtual

Set stream flags.

Implements IOstream.

Definition at line 157 of file OSstream.H.

References f().

Here is the call graph for this function:

◆ syncState()

void syncState ( )
inline

Set stream state to match that of the std::ostream.

Definition at line 165 of file OSstream.H.

References IOstream::setState().

Referenced by OCharStream::release(), OSpanStream::reset(), OCountStream::rewind(), OCharStream::rewind(), OSpanStream::rewind(), and OCharStream::swap().

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

◆ write() [1/10]

bool write ( const token tok)
overridevirtual

Write token to stream or otherwise handle it.

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

Implements Ostream.

Reimplemented in ensightFile, and prefixOSstream.

Definition at line 29 of file OSstream.C.

References token::BEGIN_BLOCK, token::END_BLOCK, token::HASH, token::stringToken(), token::type(), token::wordToken(), and OSstream::writeQuoted().

Referenced by prefixOSstream::write(), OBJstream::write(), and OBJstream::writeComment().

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

◆ write() [2/10]

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

Write character.

Implements Ostream.

Reimplemented in ensightFile, OBJstream, and prefixOSstream.

Definition at line 89 of file OSstream.C.

References Foam::constant::universal::c, and token::NL.

◆ writeQuoted() [1/3]

Foam::Ostream & writeQuoted ( const char *  str,
std::streamsize  len,
const bool  quoted = true 
)
overridevirtual

Write character/string content, with/without surrounding quotes.

Implements Ostream.

Reimplemented in OBJstream, and prefixOSstream.

Definition at line 101 of file OSstream.C.

References Foam::constant::universal::c, Foam::BitOps::count(), token::DQUOTE, and token::NL.

Referenced by OSstream::write(), OSHA1stream::write(), prefixOSstream::writeQuoted(), and OBJstream::writeQuoted().

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

◆ write() [3/10]

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

Write character string.

Implements Ostream.

Reimplemented in ensightFile, OBJstream, and prefixOSstream.

Definition at line 174 of file OSstream.C.

References Foam::BitOps::count().

Here is the call graph for this function:

◆ write() [4/10]

Foam::Ostream & write ( const word str)
overridevirtual

Write word.

Implements Ostream.

Reimplemented in ensightFile, OBJstream, and prefixOSstream.

Definition at line 189 of file OSstream.C.

◆ write() [5/10]

Foam::Ostream & write ( const std::string &  str)
overridevirtual

Write string (quoted)

In the rare case that the string contains a final trailing backslash, it will be dropped to the appearance of an escaped double-quote.

Implements Ostream.

Reimplemented in ensightFile, OSHA1stream, OBJstream, and prefixOSstream.

Definition at line 199 of file OSstream.C.

◆ write() [6/10]

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

Write int32_t.

Implements Ostream.

Reimplemented in ensightFile, and prefixOSstream.

Definition at line 205 of file OSstream.C.

◆ write() [7/10]

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

Write int64_t.

Implements Ostream.

Reimplemented in ensightFile, and prefixOSstream.

Definition at line 213 of file OSstream.C.

◆ write() [8/10]

Foam::Ostream & write ( const float  val)
overridevirtual

Write float.

Implements Ostream.

Reimplemented in ensightFile, and prefixOSstream.

Definition at line 221 of file OSstream.C.

◆ write() [9/10]

Foam::Ostream & write ( const double  val)
overridevirtual

Write double.

Implements Ostream.

Reimplemented in ensightFile, and prefixOSstream.

Definition at line 229 of file OSstream.C.

◆ write() [10/10]

Foam::Ostream & write ( const char *  data,
std::streamsize  count 
)
overridevirtual

Write binary block.

Implements Ostream.

Reimplemented in ensightFile, and prefixOSstream.

Definition at line 237 of file OSstream.C.

References Foam::BitOps::count().

Here is the call graph for this function:

◆ writeRaw()

Foam::Ostream & writeRaw ( const char *  data,
std::streamsize  count 
)
overridevirtual

Low-level raw binary output.

Implements Ostream.

Definition at line 271 of file OSstream.C.

References Foam::BitOps::count(), and Ostream::write().

Referenced by decomposedBlockData::writeData().

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

◆ beginRawWrite()

bool beginRawWrite ( std::streamsize  count)
overridevirtual

Begin marker for low-level raw binary output.

The count indicates the number of bytes for subsequent writeRaw calls.

Implements Ostream.

Definition at line 247 of file OSstream.C.

References Foam::abort(), token::BEGIN_LIST, IOstreamOption::BINARY, Foam::FatalIOError, FatalIOErrorInFunction, and format().

Here is the call graph for this function:

◆ endRawWrite()

bool endRawWrite ( )
overridevirtual

End marker for low-level raw binary output.

Implements Ostream.

Definition at line 262 of file OSstream.C.

References token::END_LIST.

◆ indent()

void indent ( )
overridevirtual

Add indentation characters.

Implements Ostream.

Reimplemented in prefixOSstream.

Definition at line 285 of file OSstream.C.

Referenced by prefixOSstream::indent(), Foam::indent(), Foam::printDOT(), and Foam::writeHeaderEntry().

Here is the caller graph for this function:

◆ flush()

void flush ( )
overridevirtual

Flush stream.

Implements Ostream.

Definition at line 295 of file OSstream.C.

Referenced by DSMCCloud< ParcelType >::dumpParticlePositions(), and Foam::flush().

Here is the caller graph for this function:

◆ endl()

void endl ( )
overridevirtual

Add newline and flush stream.

Implements Ostream.

Definition at line 301 of file OSstream.C.

References Foam::vtk::write().

Referenced by Foam::endl().

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

◆ fill() [1/2]

char fill ( ) const
overridevirtual

Get the current padding character.

Implements Ostream.

Definition at line 310 of file OSstream.C.

◆ fill() [2/2]

char fill ( const char  fillch)
overridevirtual

Set padding character for formatted field up to field width.

Returns
previous padding character

Implements Ostream.

Definition at line 316 of file OSstream.C.

◆ width() [1/2]

int width ( ) const
overridevirtual

Get width of output field.

Implements Ostream.

Definition at line 322 of file OSstream.C.

Referenced by snappyVoxelMeshDriver::snappyVoxelMeshDriver().

Here is the caller graph for this function:

◆ width() [2/2]

int width ( const int  w)
overridevirtual

Set width of output field.

Returns
previous width

Implements Ostream.

Definition at line 328 of file OSstream.C.

◆ precision() [1/2]

int precision ( ) const
overridevirtual

Get precision of output field.

Implements Ostream.

Definition at line 334 of file OSstream.C.

Referenced by Foam::entryToString(), GAMGAgglomeration::printLevels(), Time::readDict(), ensightCase::setTimeFormat(), ITstream::toString(), dimensionSet::write(), and PDRblock::writeBlockMeshDict().

Here is the caller graph for this function:

◆ precision() [2/2]

int precision ( const int  p)
overridevirtual

Set precision of output field.

Returns
old precision

Implements Ostream.

Definition at line 340 of file OSstream.C.

References p.

◆ print()

void print ( Ostream os) const
overridevirtual

Print stream description to Ostream.

Reimplemented from IOstream.

Reimplemented in OSpanStream, OCharStream, OStringStream, OCountStream, prefixOSstream, and OFstream.

Definition at line 39 of file SstreamsPrint.C.

References Foam::name(), os(), and IOstream::print().

Referenced by OFstream::print(), prefixOSstream::print(), and OStringStream::print().

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

◆ writeQuoted() [2/3]

virtual Ostream& writeQuoted

Inherit write methods from Ostream.

◆ writeQuoted() [3/3]

Foam::Ostream & writeQuoted

Inherit write methods from Ostream.

Definition at line 45 of file Ostream.C.


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