Generic output stream. More...

Inheritance diagram for OSstream:

[legend]

Collaboration diagram for OSstream:

Public Member Functions
	OSstream (ostream &os, const string &name, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
	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 &	write (const char)
	Write character. More...

virtual Ostream &	write (const char *)
	Write character string. More...

virtual Ostream &	write (const word &)
	Write word. More...

virtual Ostream &	write (const string &)
	Write string with double quotes. More...

virtual Ostream &	write (const verbatimString &)
	Write verbatimString with #{ }#. More...

virtual Ostream &	writeQuoted (const std::string &, const bool quoted=true)
	Write std::string with optional double quotes. More...

virtual Ostream &	write (const int32_t)
	Write int32_t. More...

virtual Ostream &	write (const int64_t)
	Write int64_t. More...

virtual Ostream &	write (const floatScalar)
	Write floatScalar. More...

virtual Ostream &	write (const doubleScalar)
	Write doubleScalar. More...

virtual Ostream &	write (const longDoubleScalar)
	Write longDoubleScalar. More...

virtual Ostream &	write (const char *, std::streamsize)
	Write binary block. More...

virtual void	indent ()
	Add indentation characters. 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...

virtual void	print (Ostream &) const
	Print description of IOstream to 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...

Ostream &	writeKeyword (const keyType &)
	Write the keyword followed by an appropriate indentation. More...

Ostream &	operator() () 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...

label &	lineNumber ()
	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< IOstream >	info () 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

Generic output stream.

Source files

Definition at line 51 of file OSstream.H.

Constructor & Destructor Documentation

◆ OSstream()

OSstream	(	ostream &	os,
		const string &	name,
		streamFormat	format = `ASCII`,
		versionNumber	version = `currentVersion`,
		compressionType	compression = `UNCOMPRESSED`
	)

inline

Set stream status.

Definition at line 31 of file OSstreamI.H.

Member Function Documentation

◆ 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.

Reimplemented in OFstream.

Definition at line 82 of file OSstream.H.

Referenced by meshObject::addPatch(), mappedPatchBase::calcMapping(), fvMotionSolver::cellMotionBoundaryTypes(), timeVaryingMappedFixedValuePointPatchField< Type >::checkTable(), meshObject::clear(), meshObject::clearUpto(), dynamicCode::copyAndFilter(), meshObject::distribute(), timeVaryingMappedFvPatchField< Type >::map(), meshToMesh::mapAndOpTgtToSrc(), fvMeshAdder::MapDimFields(), meshObject::mapMesh(), fvMeshAdder::MapPointFields(), fvMeshAdder::MapSurfaceFields(), fvMeshAdder::MapVolFields(), meshObject::movePoints(), MeshObject< fvMesh, MoveableMeshObject, CentredFitSnGradData< Polynomial > >::New(), ifEqEqOp< value >::operator()(), meshObject::reorderPatches(), motionSmootherAlgo::setDisplacement(), hexRef8::setRefinement(), meshObject::topoChange(), triSurface::triSurfInstance(), and timeVaryingMappedFixedValuePointPatchField< Type >::updateCoeffs().

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.

Reimplemented in OFstream.

Definition at line 89 of file OSstream.H.

◆ flags() [1/2]

std::ios_base::fmtflags flags ( ) const

virtual

Return flags of output stream.

Implements IOstream.

Definition at line 220 of file OSstream.C.

◆ write() [1/11]

Foam::Ostream & write ( const char c )

virtual

Write character.

Implements Ostream.

Reimplemented in OBJstream, and prefixOSstream.

Definition at line 32 of file OSstream.C.

References Foam::constant::universal::c, IOstream::lineNumber_, token::NL, and IOstream::setState().

Referenced by OSstream::endl(), prefixOSstream::write(), OBJstream::write(), OBJstream::writeQuoted(), and masterOFstream::~masterOFstream().

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.

Implements Ostream.

Reimplemented in ensightFile, OBJstream, and prefixOSstream.

Definition at line 44 of file OSstream.C.

References string::count(), IOstream::lineNumber_, token::NL, and IOstream::setState().

Here is the call graph for this function:

◆ write() [3/11]

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

virtual

Write word.

Implements Ostream.

Reimplemented in OBJstream, and prefixOSstream.

Definition at line 53 of file OSstream.C.

References IOstream::setState().

Here is the call graph for this function:

◆ write() [4/11]

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

virtual

Write string with double quotes.

Implements Ostream.

Reimplemented in ensightFile, OBJstream, and prefixOSstream.

Definition at line 61 of file OSstream.C.

References OSstream::writeQuoted().

Here is the call graph for this function:

◆ write() [5/11]

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

virtual

Write verbatimString with #{ }#.

Implements Ostream.

Reimplemented in prefixOSstream.

Definition at line 67 of file OSstream.C.

References token::BEGIN_BLOCK, token::END_BLOCK, token::HASH, IOstream::setState(), and OSstream::writeQuoted().

Here is the call graph for this function:

◆ writeQuoted()

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

virtual

Write std::string with optional double quotes.

Implements Ostream.

Reimplemented in OBJstream, and prefixOSstream.

Definition at line 78 of file OSstream.C.

References token::BEGIN_STRING, Foam::constant::universal::c, string::count(), token::END_STRING, IOstream::lineNumber_, token::NL, and IOstream::setState().

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/11]

Foam::Ostream & write ( const int32_t val )

virtual

Write int32_t.

Implements Ostream.

Reimplemented in prefixOSstream.

Definition at line 139 of file OSstream.C.

References IOstream::setState().

Here is the call graph for this function:

◆ write() [7/11]

Foam::Ostream & write ( const int64_t val )

virtual

Write int64_t.

Implements Ostream.

Reimplemented in prefixOSstream.

Definition at line 147 of file OSstream.C.

References IOstream::setState().

Here is the call graph for this function:

◆ write() [8/11]

Foam::Ostream & write ( const floatScalar val )

virtual

Write floatScalar.

Implements Ostream.

Reimplemented in prefixOSstream.

Definition at line 155 of file OSstream.C.

References IOstream::setState().

Here is the call graph for this function:

◆ write() [9/11]

Foam::Ostream & write ( const doubleScalar val )

virtual

Write doubleScalar.

Implements Ostream.

Reimplemented in prefixOSstream.

Definition at line 163 of file OSstream.C.

References IOstream::setState().

Here is the call graph for this function:

◆ write() [10/11]

Foam::Ostream & write ( const longDoubleScalar val )

virtual

Write longDoubleScalar.

Implements Ostream.

Reimplemented in prefixOSstream.

Definition at line 171 of file OSstream.C.

References IOstream::setState().

Here is the call graph for this function:

◆ write() [11/11]

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

virtual

Write binary block.

Implements Ostream.

Reimplemented in prefixOSstream, and ensightFile.

Definition at line 179 of file OSstream.C.

References Foam::abort(), token::BEGIN_LIST, IOstream::BINARY, token::END_LIST, Foam::FatalIOError, FatalIOErrorInFunction, IOstream::format(), and IOstream::setState().

Here is the call graph for this function:

◆ indent()

void indent ( )

virtual

Add indentation characters.

Implements Ostream.

Reimplemented in prefixOSstream.

Definition at line 198 of file OSstream.C.

References Ostream::indentLevel_, and Ostream::indentSize_.

Referenced by prefixOSstream::indent().

Here is the caller graph for this function:

◆ flags() [2/2]

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

virtual

Set flags of output stream.

Implements IOstream.

Definition at line 226 of file OSstream.C.

◆ flush()

void flush ( )

virtual

Flush stream.

Implements Ostream.

Definition at line 207 of file OSstream.C.

Referenced by DSMCCloud< ParcelType >::dumpParticlePositions(), externalCoupledTemperatureMixedFvPatchScalarField::transferData(), externalCoupledMixedFvPatchField< scalar >::transferData(), and Cloud< passiveParticle >::writePositions().

Here is the caller graph for this function:

◆ endl()

void endl ( )

virtual

Add newline and flush stream.

Implements Ostream.

Definition at line 213 of file OSstream.C.

References OSstream::write().

Here is the call graph for this function:

◆ width() [1/2]

int width ( ) const

virtual

Get width of output field.

Implements Ostream.

Definition at line 234 of file OSstream.C.

◆ width() [2/2]

int width ( const int w )

virtual

Set width of output field (and return old width)

Implements Ostream.

Definition at line 240 of file OSstream.C.

◆ precision() [1/2]

int precision ( ) const

virtual

Get precision of output field.

Implements Ostream.

Definition at line 246 of file OSstream.C.

Referenced by ensightAsciiStream::ensightAsciiStream(), ensightFile::ensightFile(), Foam::stringOps::getVariable(), Foam::stringOps::inplaceExpand(), and Time::readDict().

Here is the caller graph for this function:

◆ precision() [2/2]

int precision ( const int p )

virtual

Set precision of output field (and return old precision)

Implements Ostream.

Definition at line 252 of file OSstream.C.

◆ stdStream() [1/2]

virtual ostream& stdStream ( )

inlinevirtual

Access to underlying std::ostream.

Reimplemented in OFstream.

Definition at line 171 of file OSstream.H.

Referenced by OStringStream::rewind(), OStringStream::str(), decomposedBlockData::writeBlocks(), and OStringStream::~OStringStream().

Here is the caller graph for this function:

◆ stdStream() [2/2]

virtual const ostream& stdStream ( ) const

inlinevirtual

Const access to underlying std::ostream.

Reimplemented in OFstream.

Definition at line 177 of file OSstream.H.

References OSstream::operator=(), and OSstream::print().

Here is the call graph for this function:

◆ print()

void print ( Ostream & os ) const

virtual

Print description of IOstream to Ostream.

Reimplemented from IOstream.

Reimplemented in prefixOSstream, OFstream, and OStringStream.

Definition at line 43 of file SstreamsPrint.C.

References ISstream::name(), and IOstream::print().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const OSstream & )

delete

Disallow default bitwise assignment.

Referenced by OSstream::stdStream().

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()

Member Function Documentation

◆ name() [1/2]

◆ name() [2/2]

◆ flags() [1/2]

◆ write() [1/11]

◆ write() [2/11]

◆ write() [3/11]

◆ write() [4/11]

◆ write() [5/11]

◆ writeQuoted()

◆ write() [6/11]

◆ write() [7/11]

◆ write() [8/11]

◆ write() [9/11]

◆ write() [10/11]

◆ write() [11/11]

◆ indent()

◆ flags() [2/2]

◆ flush()

◆ endl()

◆ width() [1/2]

◆ width() [2/2]

◆ precision() [1/2]

◆ precision() [2/2]

◆ stdStream() [1/2]

◆ stdStream() [2/2]

◆ print()

◆ operator=()