Output to file stream as an OSstream, normally using std::ofstream for the actual output. More...

#include <OFstream.H>

Inheritance diagram for OFstream:

[legend]

Collaboration diagram for OFstream:

[legend]

Public Member Functions
	ClassName ("OFstream")
	Declare type-name (with debug switch).
	OFstream (std::nullptr_t)
	Construct a null output file stream that behaves like `/dev/null`.
	OFstream (IOstreamOption::atomicType atomic, const fileName &pathname, IOstreamOption streamOpt=IOstreamOption(), IOstreamOption::appendType append=IOstreamOption::NO_APPEND)
	Construct with specified atomic behaviour from pathname, stream option, optional append (see note).
	OFstream (const fileName &pathname, IOstreamOption streamOpt=IOstreamOption(), IOstreamOption::appendType append=IOstreamOption::NO_APPEND)
	Construct from pathname and other specifications.
	OFstream (const fileName &pathname, IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED, IOstreamOption::appendType append=IOstreamOption::NO_APPEND)
	Construct from pathname, format (uncompressed), optional append (see note), atomic behaviour as per system default.
	OFstream (IOstreamOption::atomicType atomic, const fileName &pathname, IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED, IOstreamOption::appendType append=IOstreamOption::NO_APPEND)
	Construct with specified atomic behaviour from pathname, format (uncompressed), optional append (see note).
	~OFstream ()
	Destructor. Possibly invokes an atomic rename (preference defined during construction).
virtual const std::ostream &	stdStream () const override
	Const access to underlying std::ostream.
virtual std::ostream &	stdStream () override
	Access to underlying std::ostream.
virtual void	rewind ()
	Rewind the stream so that it may be written again. Reopens the file (truncation).
bool	is_appending () const noexcept
	True if opened in append mode and file already existed.
bool	is_atomic () const noexcept
	True if file creation behaves as atomic.
void	print (Ostream &os) const override
	Print stream description.
virtual const fileName &	name () const override
	Read/write access to the name of the stream.
virtual fileName &	name ()
	Read/write access to the name of the stream.
Public Member Functions inherited from OSstream
	OSstream (const OSstream &)=default
	Copy construct.
void	operator= (const OSstream &)=delete
	No copy assignment.
	OSstream (std::ostream &os, const string &streamName, IOstreamOption streamOpt=IOstreamOption())
	Construct wrapper around std::ostream, set stream status.
	OSstream (std::ostream &os, const string &streamName, IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct wrapper around std::ostream, set stream status.
	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.
virtual std::ios_base::fmtflags	flags () const override
	Get current stream flags.
virtual std::ios_base::fmtflags	flags (std::ios_base::fmtflags f) override
	Set stream flags, return old stream flags.
void	syncState ()
	Set stream state to match that of the std::ostream.
virtual bool	write (const token &tok) override
	Write token to stream or otherwise handle it.
virtual Ostream &	write (const char c) override
	Write character.
virtual Ostream &	writeQuoted (const char *str, std::streamsize len, const bool quoted=true) override
	Write character/string content, with/without surrounding quotes.
virtual Ostream &	write (const char *str) override
	Write character string.
virtual Ostream &	write (const word &str) override
	Write word.
virtual Ostream &	write (const std::string &str) override
	Write string (quoted).
virtual Ostream &	write (const int32_t val) override
	Write int32_t.
virtual Ostream &	write (const int64_t val) override
	Write int64_t.
virtual Ostream &	write (const uint32_t val) override
	Write uint32_t.
virtual Ostream &	write (const uint64_t val) override
	Write uint64_t.
virtual Ostream &	write (const float val) override
	Write float.
virtual Ostream &	write (const double val) override
	Write double.
virtual Ostream &	write (const char *data, std::streamsize count) override
	Write binary block.
virtual Ostream &	writeRaw (const char *data, std::streamsize count) override
	Low-level raw binary output.
virtual bool	beginRawWrite (std::streamsize count) override
	Begin marker for low-level raw binary output.
virtual bool	endRawWrite () override
	End marker for low-level raw binary output.
virtual void	indent () override
	Add indentation characters.
virtual void	flush () override
	Flush stream.
virtual void	endl () override
	Add newline and flush stream.
virtual char	fill () const override
	Get the current padding character.
virtual char	fill (const char fillch) override
	Set padding character for formatted field up to field width.
virtual int	width () const override
	Get width of output field.
virtual int	width (const int w) override
	Set width of output field.
virtual int	precision () const override
	Get precision of output field.
virtual int	precision (const int p) override
	Set precision of output field.
virtual Ostream &	writeQuoted (const std::string &str, const bool quoted=true)
	Inherit write methods from Ostream.
Public Member Functions inherited from Ostream
	Ostream (const Ostream &)=default
	Copy construct.
virtual	~Ostream ()=default
	Destructor.
	Ostream (IOstreamOption streamOpt=IOstreamOption())
	Default construct (ASCII, uncompressed), construct with specified stream option.
	Ostream (IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format (uncompressed).
virtual Ostream &	write (const keyType &kw)
	Write keyType.
unsigned short	indentSize () const noexcept
	Return indent size (spaces per level).
unsigned short	indentSize (unsigned short val) noexcept
	Change indent size (spaces per level), return old value.
unsigned short	indentLevel () const noexcept
	Return the indent level.
unsigned short	indentLevel (unsigned short val) noexcept
	Change the indent level, return old value.
void	incrIndent () noexcept
	Increment the indent level.
void	decrIndent ()
	Decrement the indent level.
virtual Ostream &	writeKeyword (const keyType &kw)
	Write the keyword followed by an appropriate indentation.
virtual Ostream &	beginBlock (const keyType &kw)
	Write begin block group with the given name.
virtual Ostream &	beginBlock ()
	Write begin block group without a name.
virtual Ostream &	endBlock ()
	Write end block group.
virtual Ostream &	endEntry ()
	Write end entry (';') followed by newline.
template<class T>
Ostream &	writeEntry (const keyType &key, const T &value)
	Write a keyword/value entry.
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.
Ostream &	operator() () const
	Return a non-const reference to const Ostream.
unsigned short &	indentLevel () noexcept
	Access to indent level.
unsigned short &	indentSize () noexcept
	Access to indent size.
Public Member Functions inherited from IOstream
	IOstream (const IOstream &)=default
	Copy construct.
virtual	~IOstream ()=default
	Destructor.
	IOstream (IOstreamOption streamOpt=IOstreamOption())
	Default construct (ASCII, uncompressed), construct with specified stream option.
	IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format, version (compression).
fileName	relativeName () const
	Return the name of the stream relative to the current case.
virtual bool	check (const char *operation) const
	Check IOstream status for given operation.
bool	fatalCheck (const char *operation) const
	Check IOstream status for given operation.
bool	opened () const noexcept
	True if stream has been opened.
bool	closed () const noexcept
	True if stream is closed.
bool	good () const noexcept
	True if next operation might succeed.
bool	eof () const noexcept
	True if end of input seen.
bool	fail () const noexcept
	True if next operation will fail.
bool	bad () const noexcept
	True if stream is corrupted.
	operator bool () const noexcept
	True if the stream has not failed.
bool	operator! () const noexcept
	True if the stream has failed.
unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes associated with the stream.
unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes associated with the stream.
void	setLabelByteSize (unsigned nbytes) noexcept
	Set the sizeof (label) in bytes associated with the stream.
void	setScalarByteSize (unsigned nbytes) noexcept
	Set the sizeof (scalar) in bytes associated with the stream.
template<class T, class = std::enable_if_t<std::is_integral_v<T>>>
bool	checkLabelSize () const noexcept
	Test if the label byte-size associated with the stream is the same as the given type.
template<class T, class = std::enable_if_t<std::is_floating_point_v<T>>>
bool	checkScalarSize () const noexcept
	Test if the scalar byte-size associated with the stream is the same as the given type.
bool	checkNativeSizes () const noexcept
	Test if the label/scalar byte-size associated with the stream are the native label/scalar sizes.
bool	fatalCheckNativeSizes (const char *operation) const
	Assert that the label/scalar byte-size associated with the stream are the native label/scalar sizes.
label	lineNumber () const noexcept
	Const access to the current stream line number.
label &	lineNumber () noexcept
	Non-const access to the current stream line number.
label	lineNumber (const label num) noexcept
	Set the stream line number.
void	setEof () noexcept
	Set stream state as reached 'eof'.
void	setFail () noexcept
	Set stream state as 'failed'.
void	setBad () noexcept
	Set stream state to be 'bad'.
std::ios_base::fmtflags	setf (std::ios_base::fmtflags f)
	Set stream flag(s), return old stream flags.
std::ios_base::fmtflags	setf (const std::ios_base::fmtflags f, const std::ios_base::fmtflags mask)
	Set stream flag(s) with mask, return old stream flags.
std::ios_base::fmtflags	unsetf (std::ios_base::fmtflags f)
	Unset stream flags, return old stream flags.
void	print (Ostream &os, const int streamState) const
	Print information about the stream state bits.
InfoProxy< IOstream >	info () const noexcept
	Return info proxy, used to print IOstream information to a stream.
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.
constexpr	IOstreamOption (streamFormat fmt, compressionType comp, versionNumber ver) noexcept
	Construct from components (format, compression, version).
constexpr	IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept
	Construct from components (format, version, compression).
	IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept
	Copy construct with change of format.
streamFormat	format () const noexcept
	Get the current stream format.
streamFormat	format (const streamFormat fmt) noexcept
	Set the stream format.
streamFormat	format (const word &formatName)
	Set the stream format from string value.
compressionType	compression () const noexcept
	Get the stream compression.
compressionType	compression (const compressionType comp) noexcept
	Set the stream compression.
compressionType	compression (const word &compName)
	Set the stream compression from string value.
versionNumber	version () const noexcept
	Get the stream version.
versionNumber	version (const versionNumber ver) noexcept
	Set the stream version.
versionNumber	version (const token &tok)
	Set the stream version from token.

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 , COHERENT , UNKNOWN_FORMAT }
	Data format (ascii \| binary \| coherent). More...
enum	compressionType : char { UNCOMPRESSED = 0 , COMPRESSED }
	Compression treatment (UNCOMPRESSED \| COMPRESSED). More...
enum	appendType : char { NO_APPEND = 0 , APPEND_APP , APPEND_ATE , NON_APPEND = NO_APPEND , APPEND = APPEND_APP }
	File appending (NO_APPEND \| APPEND_APP \| APPEND_ATE). More...
enum	atomicType : char { NON_ATOMIC = 0 , ATOMIC }
	Atomic operations (output). More...
enum class	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.
static unsigned int	defaultPrecision (unsigned int prec) noexcept
	Reset the default precision.
static unsigned int	minPrecision (unsigned int prec) noexcept
	Set the minimum default precision.
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).
static floatFormat	floatFormatEnum (const word &key, const dictionary &dict, const floatFormat deflt=floatFormat::general)
	getOrDefault floatFormat from dictionary, warn only on bad enumeration.
static streamFormat	formatEnum (const word &fmtName, const streamFormat deflt=streamFormat::ASCII)
	Lookup streamFormat enum corresponding to the string (ascii \| binary).
static streamFormat	formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII)
	getOrDefault streamFormat from dictionary, warn only on bad enumeration.
static compressionType	compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED)
	The compression enum corresponding to the string.
static compressionType	compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED)
	getOrDefault compressionType from dictionary, warn only on bad enumeration.
Static Public Attributes inherited from IOstream
static unsigned int	precision_
	Default precision.
Static Public Attributes inherited from IOstreamOption
static const Enum< floatFormat >	floatFormatNames
	Names for float formats (general, fixed, scientific).
static const Enum< streamFormat >	formatNames
	Stream format names (ascii, binary).
static const versionNumber	currentVersion
	The current version number (2.0).
Protected Member Functions inherited from IOstream
void	setOpened () noexcept
	Set stream opened.
void	setClosed () noexcept
	Set stream closed.
void	setState (std::ios_base::iostate state) noexcept
	Set stream state.
void	setGood () noexcept
	Set stream state to be good.
Protected Attributes inherited from Ostream
unsigned short	indentSize_ = 4
	Number of spaces per indent level.
unsigned short	indentLevel_ = 0
	Current indent level.
Protected Attributes inherited from IOstream
std::ios_base::iostate	ioState_
	Mirror of internal stream io state.
streamAccess	openClosed_
	The stream open/closed state.
unsigned char	sizeofLabel_
	The sizeof (label), possibly read from the header.
unsigned char	sizeofScalar_
	The sizeof (scalar), possibly read from the header.
label	lineNumber_
	The file line.
Static Protected Attributes inherited from Ostream
static constexpr const unsigned short	entryIndentation_ = 16
	Indentation of the entry from the start of the keyword.
Static Protected Attributes inherited from IOstream
static fileName	staticName_
	Name for any generic stream - normally treat as readonly.

Detailed Description

Output to file stream as an OSstream, normally using std::ofstream for the actual output.

Note

The atomic output works by creating an intermediate temporary file, which is renamed as an atomic operation when closing. It is not possible, or particularly desirable, to have an atomic in combination with append behaviour. If both are specified, append has priority.

An output file can be opened in two different append modes, both of which preserve existing files:

A common append mode is APPEND_APP, which corresponds to the std::ios_base::app flag. A seek-to-end is performed at every write. It is thus not possible to use any manual seeks to overwrite parts of the file.
The other append mode is APPEND_ATE, which roughly corresponds to the std::ios_base::ate flag behaviour. A seek-to-end is performed immediately after opening, but not subsequently. Manual seeks can be used to overwrite parts of the file.

Source files

Definition at line 71 of file OFstream.H.

Constructor & Destructor Documentation

◆ OFstream() [1/5]

OFstream ( std::nullptr_t )

explicit

Construct a null output file stream that behaves like /dev/null.

Definition at line 35 of file OFstream.C.

References ofstreamPointer::get(), IOstream::lineNumber_, ofstreamPointer::ofstreamPointer(), OSstream::OSstream(), IOstream::setOpened(), and IOstream::setState().

Referenced by OBJstream::OBJstream(), OFstream(), OFstream(), and OFstream().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OFstream() [2/5]

OFstream	(	IOstreamOption::atomicType	atomic,
		const fileName &	pathname,
		IOstreamOption	streamOpt = IOstreamOption(),
		IOstreamOption::appendType	append = IOstreamOption::NO_APPEND )

Construct with specified atomic behaviour from pathname, stream option, optional append (see note).

Definition at line 50 of file OFstream.C.

References append(), Foam::endl(), ofstreamPointer::get(), IOstream::good(), IOstream::info(), InfoInFunction, IOstream::lineNumber_, ofstreamPointer::ofstreamPointer(), IOstream::opened(), OSstream::OSstream(), IOstream::setBad(), IOstream::setClosed(), IOstream::setOpened(), and IOstream::setState().

Here is the call graph for this function:

◆ OFstream() [3/5]

OFstream	(	const fileName &	pathname,
		IOstreamOption	streamOpt = IOstreamOption(),
		IOstreamOption::appendType	append = IOstreamOption::NO_APPEND )

inlineexplicit

Construct from pathname and other specifications.

See note on append mode.

Definition at line 108 of file OFstream.H.

References append(), IOstreamOption::NO_APPEND, IOstreamOption::NON_ATOMIC, and OFstream().

Here is the call graph for this function:

◆ OFstream() [4/5]

OFstream	(	const fileName &	pathname,
		IOstreamOption::streamFormat	fmt,
		IOstreamOption::compressionType	cmp = IOstreamOption::UNCOMPRESSED,
		IOstreamOption::appendType	append = IOstreamOption::NO_APPEND )

inline

Construct from pathname, format (uncompressed), optional append (see note), atomic behaviour as per system default.

Definition at line 123 of file OFstream.H.

References append(), IOstreamOption::NO_APPEND, OFstream(), and IOstreamOption::UNCOMPRESSED.

Here is the call graph for this function:

◆ OFstream() [5/5]

OFstream	(	IOstreamOption::atomicType	atomic,
		const fileName &	pathname,
		IOstreamOption::streamFormat	fmt,
		IOstreamOption::compressionType	cmp = IOstreamOption::UNCOMPRESSED,
		IOstreamOption::appendType	append = IOstreamOption::NO_APPEND )