Output to file stream. More...

Inheritance diagram for OFstream:

[legend]

Collaboration diagram for OFstream:

Public Member Functions
	ClassName ("OFstream")

	OFstream (const fileName &filePath, const streamFormat format=ASCII, const versionNumber version=currentVersion, const compressionType compression=UNCOMPRESSED, const bool append=false)
	Construct from filePath. More...

	~OFstream ()
	Destructor. More...

const fileName &	name () const
	Return the name of the stream. More...

fileName &	name ()
	Return non-const access to the name of the stream. More...

virtual ostream &	stdStream ()
	Access to underlying std::ostream. More...

virtual const ostream &	stdStream () const
	Const access to underlying std::ostream. More...

void	print (Ostream &) const
	Print description of IOstream to Ostream. More...

Public Member Functions inherited from OSstream
	OSstream (ostream &os, const string &name, const streamFormat format=ASCII, const versionNumber version=currentVersion, const compressionType compression=UNCOMPRESSED)
	Set stream status. More...

	OSstream (const OSstream &)=default
	Copy construct. 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 uint32_t)
	Write int32_t. More...

virtual Ostream &	write (const uint64_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...

void	operator= (const OSstream &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from Ostream
	Ostream (const streamFormat format=ASCII, const versionNumber version=currentVersion, const compressionType compression=UNCOMPRESSED, const bool global=false)
	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 (const streamFormat format, const versionNumber version, const compressionType compression=UNCOMPRESSED, const bool global=false)
	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...

bool	global () const
	Return global state. More...

bool &	global ()
	Return global state. 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

Output to file stream.

Source files

Definition at line 83 of file OFstream.H.

Constructor & Destructor Documentation

◆ OFstream()

OFstream	(	const fileName &	filePath,
		const streamFormat	format = `ASCII`,
		const versionNumber	version = `currentVersion`,
		const compressionType	compression = `UNCOMPRESSED`,
		const bool	append = `false`
	)

Construct from filePath.

Definition at line 114 of file OFstream.C.

References Foam::endl(), IOstream::good(), IOstream::info(), InfoInFunction, IOstream::lineNumber_, IOstream::setBad(), IOstream::setClosed(), IOstream::setOpened(), and IOstream::setState().

Here is the call graph for this function:

◆ ~OFstream()

~OFstream ( )

Destructor.

Definition at line 153 of file OFstream.C.

Member Function Documentation

◆ ClassName()

ClassName ( "OFstream" )

◆ name() [1/2]

const fileName& name ( ) const

inlinevirtual

Return the name of the stream.

Reimplemented from OSstream.

Definition at line 121 of file OFstream.H.

Referenced by nearWallFields::calcAddressing(), cyclicPolyPatch::coupledEdges(), cyclicPolyPatch::coupledPoints(), meshRefinement::dumpIntersections(), probes::prepare(), motionSmootherAlgo::setDisplacement(), hexRef8::setRefinement(), externalCoupledMixedFvPatchField< Type >::transferData(), externalCoupledTemperatureMixedFvPatchScalarField::transferData(), OBJedgeFormat::write(), OBJsurfaceFormat< Face >::write(), ensightSetWriter::write(), ensightSurfaceWriter::write(), externalCoupledMixedFvPatchField< Type >::writeGeometry(), treeBoundBox::writeOBJ(), surfaceFeatures::writeObj(), and extendedEdgeMesh::writeObj().

Here is the caller graph for this function:

◆ name() [2/2]

fileName& name ( )

inlinevirtual

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

Reimplemented from OSstream.

Definition at line 127 of file OFstream.H.

◆ stdStream() [1/2]

std::ostream & stdStream ( )

virtual

Access to underlying std::ostream.

Reimplemented from OSstream.

Definition at line 159 of file OFstream.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ stdStream() [2/2]

const std::ostream & stdStream ( ) const

virtual

Const access to underlying std::ostream.

Reimplemented from OSstream.

Definition at line 170 of file OFstream.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ print()

void print ( Ostream & os ) const

virtual

Print description of IOstream to Ostream.

Reimplemented from OSstream.

Definition at line 181 of file OFstream.C.

References OSstream::print().

Here is the call graph for this function:

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

src/OpenFOAM/db/IOstreams/Fstreams/OFstream.H
src/OpenFOAM/db/IOstreams/Fstreams/OFstream.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OFstream()

◆ ~OFstream()

Member Function Documentation

◆ ClassName()

◆ name() [1/2]

◆ name() [2/2]

◆ stdStream() [1/2]

◆ stdStream() [2/2]

◆ print()