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, streamFormat fmt, versionNumber ver=currentVersion, compressionType comp=compressionType::UNCOMPRESSED)
	Construct wrapper around std::ostream, 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 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 &str)
	Write word. More...

virtual Ostream &	write (const string &str)
	Write string (quoted) More...

virtual Ostream &	writeQuoted (const std::string &str, 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 *data, std::streamsize count)
	Write binary block. 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 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 (streamFormat fmt, versionNumber ver=currentVersion, compressionType comp=compressionType::UNCOMPRESSED)
	Construct with format, version (compression) 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 IOstream &)=default
	Copy construct. More...

virtual	~IOstream ()=default
	Destructor. More...

	IOstream (IOstreamOption streamOpt=IOstreamOption())

	IOstream (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED)
	Construct with format, version (compression) 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
	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
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 ()
	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, 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< streamFormat >	formatNames
	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 ()
	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...

Detailed Description

Generic output stream using a standard (STL) stream.

Source files

Definition at line 54 of file OSstream.H.

Constructor & Destructor Documentation

◆ OSstream() [1/3]

OSstream ( const OSstream & )

default

Copy construct.

◆ OSstream() [2/3]

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 34 of file OSstreamI.H.

◆ OSstream() [3/3]

OSstream	(	std::ostream &	os,
		const string &	streamName,
		streamFormat	fmt,
		versionNumber	ver = `currentVersion`,
		compressionType	comp = `compressionType::UNCOMPRESSED`
	)

inline

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

Definition at line 89 of file OSstream.H.

Member Function Documentation

◆ operator=()

void operator= ( const OSstream & )

delete

No copy assignment.

◆ name() [1/2]

virtual const fileName& name ( ) const

inlinevirtual

Return the name of the stream.

Useful for Fstream to return the filename

Reimplemented from IOstream.

Definition at line 107 of file OSstream.H.

Referenced by mappedPatchBase::calcMapping(), fvMotionSolver::cellMotionBoundaryTypes(), dynamicOversetFvMesh::checkCoupledBC(), meshObject::clear(), meshObject::clearUpto(), dynamicCode::copyAndFilter(), meshObject::movePoints(), averageNeighbourFvGeometryScheme::movePoints(), oldCyclicPolyPatch::order(), processorPolyPatch::order(), cyclicPolyPatch::order(), fvMeshDistribute::printFieldInfo(), boundaryMesh::readTriSurface(), motionSmootherAlgo::setDisplacement(), removeFaces::setRefinement(), hexRef8::setRefinement(), triSurface::triSurfInstance(), voxelMeshSearch::update(), trackingInverseDistance::update(), timeVaryingMappedFixedValuePointPatchField< Type >::updateCoeffs(), meshObject::updateMesh(), MappedFile< scalar >::value(), voxelMeshSearch::voxelMeshSearch(), and decomposedBlockData::writeBlocks().

Here is the caller graph for this function:

◆ name() [2/2]

virtual fileName& name ( )

inlinevirtual

Return non-const access to the name of the stream.

Useful to alter the stream name

Reimplemented from IOstream.

Definition at line 114 of file OSstream.H.

◆ flags() [1/2]

std::ios_base::fmtflags flags ( ) const

virtual

Return flags of output stream.

Implements IOstream.

Definition at line 282 of file OSstream.C.

◆ 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

Implements Ostream.

Reimplemented in prefixOSstream, and ensightFile.

Definition at line 36 of file OSstream.C.

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

Referenced by searchableSurfaces::checkIntersection(), GAMGSolver::GAMGSolver(), prefixOSstream::write(), OBJstream::write(), and OBJstream::writeQuoted().

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 )

virtual

Write character.

Implements Ostream.

Reimplemented in ensightFile, OBJstream, and prefixOSstream.

Definition at line 83 of file OSstream.C.

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

◆ write() [3/10]

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

virtual

Write character string.

Implements Ostream.

Reimplemented in ensightFile, OBJstream, and prefixOSstream.

Definition at line 95 of file OSstream.C.

References Foam::stringOps::count(), and token::NL.

Here is the call graph for this function:

◆ write() [4/10]

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

virtual

Write word.

Implements Ostream.

Reimplemented in prefixOSstream, ensightFile, and OBJstream.

Definition at line 104 of file OSstream.C.

◆ write() [5/10]

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

virtual

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 prefixOSstream, OSHA1stream, ensightFile, and OBJstream.

Definition at line 171 of file OSstream.C.

◆ writeQuoted()

Foam::Ostream & writeQuoted	(	const std::string &	str,
		const bool	quoted = `true`
	)

virtual

Write std::string surrounded by quotes.

Optional write without quotes.

Implements Ostream.

Reimplemented in prefixOSstream, and OBJstream.

Definition at line 113 of file OSstream.C.

References token::BEGIN_STRING, Foam::constant::universal::c, Foam::stringOps::count(), token::END_STRING, and token::NL.

Referenced by dynamicCode::copyAndFilter(), OSstream::write(), and prefixOSstream::writeQuoted().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write() [6/10]

Foam::Ostream & write ( const int32_t val )

virtual

Write int32_t.

Implements Ostream.

Reimplemented in ensightFile, and prefixOSstream.

Definition at line 177 of file OSstream.C.

◆ write() [7/10]

Foam::Ostream & write ( const int64_t val )

virtual

Write int64_t.

Implements Ostream.

Reimplemented in ensightFile, and prefixOSstream.

Definition at line 185 of file OSstream.C.

◆ write() [8/10]

Foam::Ostream & write ( const floatScalar val )

virtual

Write floatScalar.

Implements Ostream.

Reimplemented in ensightFile, and prefixOSstream.

Definition at line 193 of file OSstream.C.

◆ write() [9/10]

Foam::Ostream & write ( const doubleScalar val )

virtual

Write doubleScalar.

Implements Ostream.

Reimplemented in ensightFile, and prefixOSstream.

Definition at line 201 of file OSstream.C.

◆ write() [10/10]

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

virtual

Write binary block.

Implements Ostream.

Reimplemented in ensightFile, and prefixOSstream.

Definition at line 209 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
	)

virtual

Low-level raw binary output.

Implements Ostream.

Definition at line 245 of file OSstream.C.

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

Here is the call graph for this function:

◆ beginRawWrite()

bool beginRawWrite ( std::streamsize count )

virtual

Begin marker for low-level raw binary output.

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

Implements Ostream.

Definition at line 219 of file OSstream.C.

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

Here is the call graph for this function:

◆ endRawWrite()

bool endRawWrite ( )

virtual

End marker for low-level raw binary output.

Implements Ostream.

Definition at line 235 of file OSstream.C.

References token::END_LIST.

◆ indent()

void indent ( )

virtual

Add indentation characters.

Implements Ostream.

Reimplemented in prefixOSstream.

Definition at line 260 of file OSstream.C.

Referenced by prefixOSstream::indent().

Here is the caller graph for this function:

◆ flags() [2/2]

std::ios_base::fmtflags flags ( const ios_base::fmtflags f )

virtual

Set stream flags.

Implements IOstream.

Definition at line 288 of file OSstream.C.

References f().

Here is the call graph for this function:

◆ flush()

void flush ( )

virtual

Flush stream.

Implements Ostream.

Definition at line 269 of file OSstream.C.

Referenced by DSMCCloud< ParcelType >::dumpParticlePositions(), and Cloud< passivePositionParticle >::writePositions().

Here is the caller graph for this function:

◆ endl()

void endl ( )

virtual

Add newline and flush stream.

Implements Ostream.

Definition at line 275 of file OSstream.C.

References Foam::vtk::write().

Here is the call graph for this function:

◆ fill() [1/2]

char fill ( ) const

virtual

Get the current padding character.

Implements Ostream.

Definition at line 296 of file OSstream.C.

◆ fill() [2/2]

char fill ( const char fillch )

virtual

Set padding character for formatted field up to field width.

Returns: previous padding character

Implements Ostream.

Definition at line 302 of file OSstream.C.

◆ width() [1/2]

int width ( ) const

virtual

Get width of output field.

Implements Ostream.

Definition at line 308 of file OSstream.C.

Referenced by snappyVoxelMeshDriver::snappyVoxelMeshDriver().

Here is the caller graph for this function:

◆ width() [2/2]

int width ( const int w )

virtual

Set width of output field.

Returns: previous width

Implements Ostream.

Definition at line 314 of file OSstream.C.

◆ precision() [1/2]

int precision ( ) const

virtual

Get precision of output field.

Implements Ostream.

Definition at line 320 of file OSstream.C.

Referenced by Foam::entryToString(), Time::readDict(), ensightSetWriter< Type >::write(), FLMAsurfaceFormat< Face >::write(), ensightWriter::writeCollated(), and ensightWriter::writeUncollated().

Here is the caller graph for this function:

◆ precision() [2/2]

int precision ( const int p )

virtual

Set precision of output field.

Returns: old precision

Implements Ostream.

Definition at line 326 of file OSstream.C.

References p.

◆ stdStream() [1/2]

virtual std::ostream& stdStream ( )

inlinevirtual

Access to underlying std::ostream.

Reimplemented in OFstream.

Definition at line 222 of file OSstream.H.

Referenced by Time::printExecutionTime(), FIRECore::putFireLabel(), FIRECore::putFireLabels(), FIRECore::putFirePoint(), FIRECore::putFireString(), and decomposedBlockData::writeBlocks().

Here is the caller graph for this function:

◆ stdStream() [2/2]

virtual const std::ostream& stdStream ( ) const

inlinevirtual

Const access to underlying std::ostream.

Reimplemented in OFstream.

Definition at line 228 of file OSstream.H.

◆ print()

void print ( Ostream & os ) const

virtual

Print stream description to Ostream.

Reimplemented from IOstream.

Reimplemented in OListStream, OCountStream, UOListStream, OStringStream, prefixOSstream, and OFstream.

Definition at line 45 of file SstreamsPrint.C.

References Foam::name(), 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:

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

src/OpenFOAM/db/IOstreams/Sstreams/OSstream.H
src/OpenFOAM/db/IOstreams/Sstreams/OSstream.C
src/OpenFOAM/db/IOstreams/Sstreams/OSstreamI.H
src/OpenFOAM/db/IOstreams/Sstreams/SstreamsPrint.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OSstream() [1/3]

◆ OSstream() [2/3]

◆ OSstream() [3/3]

Member Function Documentation

◆ operator=()

◆ name() [1/2]

◆ name() [2/2]

◆ flags() [1/2]

◆ write() [1/10]

◆ write() [2/10]

◆ write() [3/10]

◆ write() [4/10]

◆ write() [5/10]

◆ writeQuoted()

◆ write() [6/10]

◆ write() [7/10]

◆ write() [8/10]

◆ write() [9/10]

◆ write() [10/10]

◆ writeRaw()

◆ beginRawWrite()

◆ endRawWrite()

◆ indent()

◆ flags() [2/2]

◆ flush()

◆ endl()

◆ fill() [1/2]

◆ fill() [2/2]

◆ width() [1/2]

◆ width() [2/2]

◆ precision() [1/2]

◆ precision() [2/2]

◆ stdStream() [1/2]

◆ stdStream() [2/2]

◆ print()