OFstream Class Reference

Output to file stream, using an OSstream. More...

Inheritance diagram for OFstream:

Collaboration diagram for OFstream:

Public Member Functions
	ClassName ("OFstream")
	OFstream (std::nullptr_t)
	OFstream (const fileName &pathname, IOstreamOption streamOpt=IOstreamOption(), const bool append=false)
	OFstream (const fileName &pathname, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED, const bool append=false)
	~OFstream ()=default
virtual std::ostream &	stdStream ()
virtual const std::ostream &	stdStream () const
virtual void	rewind ()
void	print (Ostream &os) const
virtual const fileName &	name () const
virtual fileName &	name ()
Public Member Functions inherited from OSstream
	OSstream (const OSstream &)=default
void	operator= (const OSstream &)=delete
	OSstream (std::ostream &os, const string &streamName, IOstreamOption streamOpt=IOstreamOption())
	OSstream (std::ostream &os, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
virtual const fileName &	name () const
virtual fileName &	name ()
virtual ios_base::fmtflags	flags () const
virtual bool	write (const token &tok)
virtual Ostream &	write (const char c)
virtual Ostream &	write (const char *str)
virtual Ostream &	write (const word &str)
virtual Ostream &	write (const string &str)
virtual Ostream &	writeQuoted (const std::string &str, const bool quoted=true)
virtual Ostream &	write (const int32_t val)
virtual Ostream &	write (const int64_t val)
virtual Ostream &	write (const floatScalar val)
virtual Ostream &	write (const doubleScalar val)
virtual Ostream &	write (const char *data, std::streamsize count)
virtual Ostream &	writeRaw (const char *data, std::streamsize count)
virtual bool	beginRawWrite (std::streamsize count)
virtual bool	endRawWrite ()
virtual void	indent ()
virtual ios_base::fmtflags	flags (const ios_base::fmtflags f)
virtual void	flush ()
virtual void	endl ()
virtual char	fill () const
virtual char	fill (const char fillch)
virtual int	width () const
virtual int	width (const int w)
virtual int	precision () const
virtual int	precision (const int p)
Public Member Functions inherited from Ostream
	Ostream (const Ostream &)=default
virtual	~Ostream ()=default
	Ostream (IOstreamOption streamOpt=IOstreamOption())
	Ostream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
virtual Ostream &	write (const keyType &kw)
unsigned short	indentSize () const noexcept
unsigned short	indentSize (unsigned short val) noexcept
unsigned short	indentLevel () const noexcept
unsigned short	indentLevel (unsigned short val) noexcept
void	incrIndent () noexcept
void	decrIndent ()
virtual Ostream &	writeKeyword (const keyType &kw)
virtual Ostream &	beginBlock (const keyType &kw)
virtual Ostream &	beginBlock ()
virtual Ostream &	endBlock ()
virtual Ostream &	endEntry ()
template<class T >
Ostream &	writeEntry (const keyType &key, const T &value)
template<class T >
Ostream &	writeEntryIfDifferent (const word &key, const T &value1, const T &value2)
Ostream &	operator() () const
unsigned short &	indentLevel () noexcept
unsigned short &	indentSize () noexcept
Public Member Functions inherited from IOstream
	IOstream (const IOstream &)=default
virtual	~IOstream ()=default
	IOstream (IOstreamOption streamOpt=IOstreamOption())
	IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
fileName	relativeName () const
virtual bool	check (const char *operation) const
bool	fatalCheck (const char *operation) const
bool	opened () const noexcept
bool	closed () const noexcept
bool	good () const noexcept
bool	eof () const noexcept
bool	fail () const noexcept
bool	bad () const noexcept
	operator bool () const noexcept
bool	operator! () const noexcept
unsigned	labelByteSize () const noexcept
unsigned	scalarByteSize () const noexcept
void	setLabelByteSize (unsigned nbytes) noexcept
void	setScalarByteSize (unsigned nbytes) noexcept
template<class T = label>
std::enable_if< std::is_integral< T >::value, bool >::type	checkLabelSize () const noexcept
template<class T = scalar>
std::enable_if< std::is_floating_point< T >::value, bool >::type	checkScalarSize () const noexcept
label	lineNumber () const noexcept
label &	lineNumber () noexcept
label	lineNumber (const label num) noexcept
void	setEof () noexcept
void	setFail () noexcept
void	setBad ()
ios_base::fmtflags	setf (const ios_base::fmtflags f)
ios_base::fmtflags	setf (const ios_base::fmtflags f, const ios_base::fmtflags mask)
void	unsetf (const ios_base::fmtflags f)
void	print (Ostream &os, const int streamState) const
InfoProxy< IOstream >	info () const
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
constexpr	IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept
	IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept
streamFormat	format () const noexcept
streamFormat	format (const streamFormat fmt) noexcept
streamFormat	format (const word &formatName)
compressionType	compression () const noexcept
compressionType	compression (const compressionType comp) noexcept
compressionType	compression (const word &compName)
versionNumber	version () const noexcept
versionNumber	version (const versionNumber ver) noexcept
versionNumber	version (const token &tok)

Additional Inherited Members
Public Types inherited from IOstream
enum	streamAccess : char { CLOSED = 0, OPENED }
Public Types inherited from IOstreamOption
enum	streamFormat : char { ASCII = 0, BINARY }
enum	compressionType : char { UNCOMPRESSED = 0, COMPRESSED }
Static Public Member Functions inherited from IOstream
static unsigned int	defaultPrecision () noexcept
static unsigned int	defaultPrecision (unsigned int prec) noexcept
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)
static compressionType	compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED)
static compressionType	compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED)
Static Public Attributes inherited from IOstream
static unsigned int	precision_
Static Public Attributes inherited from IOstreamOption
static const Enum< streamFormat >	formatNames
static const versionNumber	currentVersion
Protected Member Functions inherited from IOstream
void	setOpened () noexcept
void	setClosed () noexcept
void	setState (std::ios_base::iostate state) noexcept
void	setGood () noexcept
Protected Attributes inherited from Ostream
unsigned short	indentSize_ = 4
unsigned short	indentLevel_ = 0
Protected Attributes inherited from IOstream
std::ios_base::iostate	ioState_
streamAccess	openClosed_
unsigned char	sizeofLabel_
unsigned char	sizeofScalar_
label	lineNumber_
Static Protected Attributes inherited from Ostream
static constexpr const unsigned short	entryIndentation_ = 16
Static Protected Attributes inherited from IOstream
static fileName	staticName_

Detailed Description

Output to file stream, using an OSstream.

Source files

• OFstream.H
• OFstream.C

Definition at line 49 of file OFstream.H.

Constructor & Destructor Documentation

OFstream() [1/3]

OFstream ( std::nullptr_t  )

explicit

Definition at line 36 of file OFstream.C.

References Foam::PtrListOps::get().

Here is the call graph for this function:

OFstream() [2/3]

OFstream ( const fileName &  pathname, IOstreamOption  streamOpt = IOstreamOption(), const bool  append = false  )

explicit

Definition at line 51 of file OFstream.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::PtrListOps::get(), and InfoInFunction.

Here is the call graph for this function:

OFstream() [3/3]

OFstream ( const fileName &  pathname, IOstreamOption::streamFormat  fmt, IOstreamOption::versionNumber  ver = IOstreamOption::currentVersion, IOstreamOption::compressionType  cmp = IOstreamOption::UNCOMPRESSED, const bool  append = false  )

inline

Definition at line 76 of file OFstream.H.

~OFstream()

~OFstream ( )

default

Member Function Documentation

ClassName()

ClassName

(

"OFstream"

)

stdStream() [1/2]

const std::ostream & stdStream ( )

virtual

Reimplemented from OSstream.

Definition at line 95 of file OFstream.C.

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

Referenced by Time::printExecutionTime(), scene::write(), lumpedPointMovement::writeForcesAndMomentsVTP(), and lumpedPointState::writeVTP().

Here is the call graph for this function:

Here is the caller graph for this function:

stdStream() [2/2]

virtual const std::ostream& stdStream ( ) const

virtual

Reimplemented from OSstream.

rewind()

void rewind ( )

virtual

Definition at line 125 of file OFstream.C.

References IOstreamOption::COMPRESSED, ofstreamPointer::get(), Foam::name(), ofstreamPointer::reopen(), ofstreamPointer::reopen_gz(), and ofstreamPointer::whichCompression().

Here is the call graph for this function:

print()

void print ( Ostream &  os ) const

virtual

Reimplemented from OSstream.

Definition at line 156 of file OFstream.C.

References os(), and OSstream::print().

Referenced by decompositionInformation::printSummary().

Here is the call graph for this function:

Here is the caller graph for this function:

name() [1/2]

virtual const fileName& name

inline

Definition at line 103 of file OSstream.H.

Referenced by snappyLayerDriver::addLayers(), nearWallFields::calcAddressing(), polyDualMesh::calcFeatures(), processorPolyPatch::calcGeometry(), mappedPatchBase::calcMapping(), exact::correct(), cyclicPolyPatch::coupledEdges(), cyclicPolyPatch::coupledPoints(), distributedTriSurfaceMesh::distribute(), meshRefinement::dumpIntersections(), particleDistribution::generateDistribution(), processorPolyPatch::initOrder(), triangle2D::interArea(), averageNeighbourFvGeometryScheme::movePoints(), oldCyclicPolyPatch::order(), processorPolyPatch::order(), cyclicPolyPatch::order(), motionSmootherAlgo::setDisplacement(), removeFaces::setRefinement(), hexRef8::setRefinement(), trackingInverseDistance::update(), cellVolumeWeight::update(), inverseDistance::update(), ensightSetWriter< Type >::write(), graph::write(), PDRblock::writeBlockMeshDict(), ensightWriter::writeCollated(), engineValve::writeDict(), isoAdvection::writeIsoFaces(), surfaceFeatures::writeObj(), extendedEdgeMesh::writeObj(), sampledSets::writeSampleFile(), ensightWriter::writeUncollated(), and interfaceTrackingFvMesh::writeVTKControlPoints().

Here is the caller graph for this function:

name() [2/2]

virtual fileName& name

inline

Definition at line 109 of file OSstream.H.

---

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