An Ostream is an abstract base class for all output systems (streams, files, token lists, etc). More...

Inheritance diagram for Ostream:

[legend]

Collaboration diagram for Ostream:

Public Member Functions
	Ostream (const Ostream &)=default
	Copy construct. More...

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

	Ostream (IOstreamOption streamOpt=IOstreamOption())
	Default construct (ASCII, uncompressed), construct with specified stream option. More...

	Ostream (IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format (uncompressed) More...

virtual bool	write (const token &tok)=0
	Write token to stream or otherwise handle it. More...

virtual Ostream &	write (const char c)=0
	Write character. More...

virtual Ostream &	writeQuoted (const char *str, std::streamsize len, const bool quoted=true)=0
	Write character/string content, with/without surrounding quotes. More...

virtual Ostream &	writeQuoted (const std::string &str, const bool quoted=true)
	Write string content, with/without surrounding quotes. More...

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

virtual Ostream &	write (const word &str)=0
	Write word (unquoted) More...

virtual Ostream &	write (const std::string &str)=0
	Write string content (usually quoted) More...

virtual Ostream &	write (const keyType &kw)
	Write keyType. More...

virtual Ostream &	write (const int32_t val)=0
	Write int32_t. More...

virtual Ostream &	write (const int64_t val)=0
	Write int64_t. More...

virtual Ostream &	write (const float val)=0
	Write float. More...

virtual Ostream &	write (const double val)=0
	Write double. More...

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

virtual Ostream &	writeRaw (const char *data, std::streamsize count)=0
	Low-level raw binary output. More...

virtual bool	beginRawWrite (std::streamsize count)=0
	Emit begin marker for low-level raw binary output. More...

virtual bool	endRawWrite ()=0
	Emit end marker for low-level raw binary output. More...

virtual void	indent ()=0
	Add indentation characters. More...

unsigned short	indentSize () const noexcept
	Return indent size (spaces per level) More...

unsigned short	indentSize (unsigned short val) noexcept
	Change indent size (spaces per level), return old value. More...

unsigned short	indentLevel () const noexcept
	Return the indent level. More...

unsigned short	indentLevel (unsigned short val) noexcept
	Change the indent level, return old value. More...

void	incrIndent () noexcept
	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...

virtual void	flush ()=0
	Flush stream. More...

virtual void	endl ()=0
	Add newline and flush stream. More...

virtual char	fill () const =0
	Get padding character. More...

virtual char	fill (const char fillch)=0
	Set padding character for formatted field up to field width. More...

virtual int	width () const =0
	Get width of output field. More...

virtual int	width (const int w)=0
	Set width of output field (and return old width) More...

virtual int	precision () const =0
	Get precision of output field. More...

virtual int	precision (const int p)=0
	Set precision of output field (and return old precision) More...

Ostream &	operator() () const
	Return a non-const reference to const Ostream. More...

unsigned short &	indentLevel () noexcept
	Access to indent level. More...

unsigned short &	indentSize () noexcept
	Access to indent size. More...

Public Member Functions inherited from IOstream
	IOstream (const IOstream &)=default
	Copy construct. More...

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

	IOstream (IOstreamOption streamOpt=IOstreamOption())
	Default construct (ASCII, uncompressed), construct with specified stream option. More...

	IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format, version (compression) More...

virtual const fileName &	name () const
	The name of the stream. More...

fileName	relativeName () const
	Return the name of the stream relative to the current case. 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 noexcept
	True if stream has been opened. More...

bool	closed () const noexcept
	True if stream is closed. More...

bool	good () const noexcept
	True if next operation might succeed. More...

bool	eof () const noexcept
	True if end of input seen. More...

bool	fail () const noexcept
	True if next operation will fail. More...

bool	bad () const noexcept
	True if stream is corrupted. More...

	operator bool () const noexcept
	True if the stream has not failed. More...

bool	operator! () const noexcept
	True if the stream has failed. More...

unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes associated with the stream. More...

unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes associated with the stream. More...

void	setLabelByteSize (unsigned nbytes) noexcept
	Set the sizeof (label) in bytes associated with the stream. More...

void	setScalarByteSize (unsigned nbytes) noexcept
	Set the sizeof (scalar) in bytes associated with the stream. More...

template<class T = label>
std::enable_if_t< std::is_integral_v< T >, bool >	checkLabelSize () const noexcept
	Check if the label byte-size associated with the stream is the same as the given type. More...

template<class T = scalar>
std::enable_if_t< std::is_floating_point_v< T >, bool >	checkScalarSize () const noexcept
	Check if the scalar byte-size associated with the stream is the same as the given type. More...

label	lineNumber () const noexcept
	Const access to the current stream line number. More...

label &	lineNumber () noexcept
	Non-const access to the current stream line number. More...

label	lineNumber (const label num) noexcept
	Set the stream line number. More...

void	setEof () noexcept
	Set stream state as reached 'eof'. More...

void	setFail () noexcept
	Set stream state as 'failed'. More...

void	setBad () noexcept
	Set stream state to be 'bad'. More...

virtual std::ios_base::fmtflags	flags () const =0
	Return current stream flags. More...

virtual std::ios_base::fmtflags	flags (std::ios_base::fmtflags)=0
	Set stream flags, return old stream flags. More...

std::ios_base::fmtflags	setf (std::ios_base::fmtflags f)
	Set stream flag(s), return old stream flags. More...

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

std::ios_base::fmtflags	unsetf (std::ios_base::fmtflags f)
	Unset stream flags, return old stream flags. More...

virtual void	print (Ostream &os) const
	Print stream description to Ostream. More...

void	print (Ostream &os, const int streamState) const
	Print information about the stream state bits. More...

InfoProxy< IOstream >	info () const noexcept
	Return info proxy, used to print IOstream information to a stream. More...

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

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

Protected Attributes
unsigned short	indentSize_ = 4
	Number of spaces per indent level. More...

unsigned short	indentLevel_ = 0
	Current indent level. More...

Protected Attributes inherited from IOstream
std::ios_base::iostate	ioState_
	Mirror of internal stream io state. More...

streamAccess	openClosed_
	The stream open/closed state. More...

unsigned char	sizeofLabel_
	The sizeof (label), possibly read from the header. More...

unsigned char	sizeofScalar_
	The sizeof (scalar), possibly read from the header. More...

label	lineNumber_
	The file line. More...

Static Protected Attributes
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...

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

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

static unsigned int	defaultPrecision (unsigned int prec) noexcept
	Reset the default precision. More...

static unsigned int	minPrecision (unsigned int prec) noexcept
	Set the minimum default precision. More...

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). More...

static floatFormat	floatFormatEnum (const word &key, const dictionary &dict, const floatFormat deflt=floatFormat::general)
	getOrDefault floatFormat from dictionary, warn only on bad enumeration. More...

static streamFormat	formatEnum (const word &fmtName, const streamFormat deflt=streamFormat::ASCII)
	Lookup streamFormat enum corresponding to the string (ascii \| binary). More...

static streamFormat	formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII)
	getOrDefault streamFormat from dictionary, warn only on bad enumeration. 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)
	getOrDefault compressionType from dictionary, warn only on bad enumeration. More...

Static Public Attributes inherited from IOstream
static unsigned int	precision_
	Default precision. More...

Static Public Attributes inherited from IOstreamOption
static const Enum< floatFormat >	floatFormatNames
	Names for float formats (general, fixed, scientific) More...

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 () noexcept
	Set stream opened. More...

void	setClosed () noexcept
	Set stream closed. More...

void	setState (std::ios_base::iostate state) noexcept
	Set stream state. More...

void	setGood () noexcept
	Set stream state to be good. More...

Detailed Description

An Ostream is an abstract base class for all output systems (streams, files, token lists, etc).

Source files

Definition at line 56 of file Ostream.H.

Constructor & Destructor Documentation

◆ Ostream() [1/3]

Ostream ( const Ostream & )

default

Copy construct.

◆ ~Ostream()

virtual ~Ostream ( )

virtualdefault

Destructor.

◆ Ostream() [2/3]

Ostream ( IOstreamOption streamOpt = IOstreamOption() )

inlineexplicit

Default construct (ASCII, uncompressed), construct with specified stream option.

Definition at line 101 of file Ostream.H.

◆ Ostream() [3/3]

Ostream	(	IOstreamOption::streamFormat	fmt,
		IOstreamOption::compressionType	cmp = `IOstreamOption::UNCOMPRESSED`
	)

inlineexplicit

Construct with format (uncompressed)

Definition at line 110 of file Ostream.H.

Member Function Documentation

◆ write() [1/11]

virtual bool write ( const token & tok )

pure virtual

Write token to stream or otherwise handle it.

Returns: false if the token type was not handled by this method

Implemented in OTstream, prefixOSstream, OSstream, UOPstreamBase, and ensightFile.

Referenced by snappyLayerDriver::addLayers(), interRegionHeatTransferModel::addSup(), distanceSurface::createGeometry(), snappySnapDriver::doSnap(), if(), interpolationTable< scalar >::interpolationTable(), Foam::MapLagrangianFields(), Foam::operator<<(), refinementIterator::setRefinement(), snappySnapDriver::smoothDisplacement(), ObukhovLength::write(), derivedFields::write(), DESModelRegions::write(), extractEulerianParticles::write(), CelikEtaIndex::write(), CelikNuIndex::write(), PopeIndex::write(), XiReactionRate::write(), forces::write(), electricPotential::write(), surfaceCourantNumber::write(), ensightMesh::write(), fixedNormalInletOutletVelocityFvPatchVectorField::write(), freestreamFvPatchField< Type >::write(), scaledFixedValueFvPatchField< Type >::write(), cyclicAMIPolyPatch::write(), cyclicPolyPatch::write(), sixDoFRigidBodyMotion::write(), scene::write(), mappedPatchBase::write(), FallOffReactionRate< ReactionRate, FallOffFunction >::write(), NonEquilibriumReversibleReaction< ReactionType, ReactionThermo, ReactionRate >::write(), SHA1::write(), UniformDimensionedField< Type >::writeData(), dimensioned< Type >::writeEntry(), fieldAverage::writeFieldType(), OSstream::writeRaw(), and vtkWriter::writeTemplate().

Here is the caller graph for this function:

◆ write() [2/11]

virtual Ostream& write ( const char c )

pure virtual

Write character.

Implemented in ensightFile, OTstream, prefixOSstream, OSstream, UOPstreamBase, and OBJstream.

◆ writeQuoted() [1/2]

virtual Ostream& writeQuoted	(	const char *	str,
		std::streamsize	len,
		const bool	quoted = `true`
	)

pure virtual

Write character/string content, with/without surrounding quotes.

Implemented in OTstream, prefixOSstream, OSstream, UOPstreamBase, and OBJstream.

Referenced by JSONformatter::write(), JSONformatter::writeDict(), JSONformatter::writeEntry(), and JSONformatter::writeKeyword().

Here is the caller graph for this function:

◆ writeQuoted() [2/2]

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

virtual

Write string content, with/without surrounding quotes.

Definition at line 44 of file Ostream.C.

◆ write() [3/11]

virtual Ostream& write ( const char * str )

pure virtual

Write character string.

Implemented in OTstream, prefixOSstream, OSstream, UOPstreamBase, OBJstream, and ensightFile.

◆ write() [4/11]

virtual Ostream& write ( const word & str )

pure virtual

Write word (unquoted)

Implemented in prefixOSstream, OTstream, OSstream, UOPstreamBase, OBJstream, and ensightFile.

◆ write() [5/11]

virtual Ostream& write ( const std::string & str )

pure virtual

Write string content (usually quoted)

Implemented in prefixOSstream, OTstream, OSstream, UOPstreamBase, OSHA1stream, OBJstream, and ensightFile.

◆ write() [6/11]

Foam::Ostream & write ( const keyType & kw )

virtual

Write keyType.

A plain word is written unquoted. A regular expression is written as a quoted string.

Definition at line 54 of file Ostream.C.

References keyType::isPattern().

Here is the call graph for this function:

◆ write() [7/11]

virtual Ostream& write ( const int32_t val )

pure virtual

Write int32_t.

Implemented in OTstream, prefixOSstream, OSstream, UOPstreamBase, and ensightFile.

◆ write() [8/11]

virtual Ostream& write ( const int64_t val )

pure virtual

Write int64_t.

Implemented in OTstream, prefixOSstream, OSstream, UOPstreamBase, and ensightFile.

◆ write() [9/11]

virtual Ostream& write ( const float val )

pure virtual

Write float.

Implemented in OTstream, prefixOSstream, OSstream, UOPstreamBase, and ensightFile.

◆ write() [10/11]

virtual Ostream& write ( const double val )

pure virtual

Write double.

Implemented in OTstream, prefixOSstream, OSstream, UOPstreamBase, and ensightFile.

◆ write() [11/11]

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

pure virtual

Write binary block.

Implemented in OTstream, OSstream, UOPstreamBase, prefixOSstream, and ensightFile.

◆ writeRaw()

virtual Ostream& writeRaw	(	const char *	data,
		std::streamsize	count
	)

pure virtual

Low-level raw binary output.

Implemented in OTstream, OSstream, and UOPstreamBase.

◆ beginRawWrite()

virtual bool beginRawWrite ( std::streamsize count )

pure virtual

Emit begin marker for low-level raw binary output.

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

Implemented in OTstream, OSstream, and UOPstreamBase.

◆ endRawWrite()

virtual bool endRawWrite ( )

pure virtual

Emit end marker for low-level raw binary output.

Implemented in OTstream, OSstream, and UOPstreamBase.

◆ indent()

virtual void indent ( )

pure virtual

Add indentation characters.

Implemented in OTstream, prefixOSstream, OSstream, and UOPstreamBase.

◆ indentSize() [1/3]

unsigned short indentSize ( ) const

inlinenoexcept

Return indent size (spaces per level)

Definition at line 233 of file Ostream.H.

References Ostream::indentSize_.

◆ indentSize() [2/3]

unsigned short indentSize ( unsigned short val )

inlinenoexcept

Change indent size (spaces per level), return old value.

Definition at line 241 of file Ostream.H.

References Ostream::indentSize_.

◆ indentLevel() [1/3]

unsigned short indentLevel ( ) const

inlinenoexcept

Return the indent level.

Definition at line 251 of file Ostream.H.

References Ostream::indentLevel_.

◆ indentLevel() [2/3]

unsigned short indentLevel ( unsigned short val )

inlinenoexcept

Change the indent level, return old value.

Definition at line 259 of file Ostream.H.

References Ostream::indentLevel_.

◆ incrIndent()

void incrIndent ( )

inlinenoexcept

Increment the indent level.

Definition at line 269 of file Ostream.H.

References Ostream::indentLevel_.

Referenced by Foam::incrIndent().

Here is the caller graph for this function:

◆ decrIndent()

void decrIndent ( )

Decrement the indent level.

Definition at line 30 of file Ostream.C.

References Ostream::indentLevel_.

Referenced by Foam::decrIndent().

Here is the caller graph for this function:

◆ writeKeyword()

Foam::Ostream & writeKeyword ( const keyType & kw )

virtual

Write the keyword followed by an appropriate indentation.

Reimplemented in ensightGeoFile, and ensightFile.

Definition at line 60 of file Ostream.C.

References Foam::indent(), keyType::isPattern(), and token::SPACE.

Referenced by patchIdentifier::write(), zoneIdentifier::write(), JanevReactionRate::write(), LangmuirHinshelwoodReactionRate::write(), primitiveEntry::write(), ensightCells::writeBox(), UniformDimensionedField< Type >::writeData(), Function1< Type >::writeData(), ensightCells::writeDict(), ensightFaces::writeDict(), Ostream::writeEntry(), dimensioned< Type >::writeEntry(), and Field< Type >::writeEntry().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ beginBlock() [1/2]

Foam::Ostream & beginBlock ( const keyType & kw )

virtual

Write begin block group with the given name.

Increments indentation, adds newline.

Definition at line 90 of file Ostream.C.

References Foam::beginBlock(), Foam::indent(), and keyType::isPattern().

Referenced by Foam::beginBlock(), Foam::operator<<(), Foam::printDOT(), Foam::printGraph_impl(), fixedNormalInletOutletVelocityFvPatchVectorField::write(), freestreamFvPatchField< Type >::write(), outletMappedUniformInletFvPatchField< Type >::write(), scaledFixedValueFvPatchField< Type >::write(), sixDoFRigidBodyMotion::write(), surfZone::write(), surfacePatch::write(), polynomialSolidTransport< Thermo, PolySize >::write(), tabulatedAnIsoSolidTransport< Thermo >::write(), tabulatedSolidTransport< Thermo >::write(), adiabaticPerfectFluid< Specie >::write(), Boussinesq< Specie >::write(), icoPolynomial< Specie, PolySize >::write(), icoTabulated< Specie >::write(), incompressiblePerfectGas< Specie >::write(), linear< Type >::write(), perfectFluid< Specie >::write(), rhoConst< Specie >::write(), rPolynomial< Specie >::write(), FallOffReactionRate< ReactionRate, FallOffFunction >::write(), NonEquilibriumReversibleReaction< ReactionType, ReactionThermo, ReactionRate >::write(), ReactionList< ThermoType >::write(), specie::write(), eConstThermo< EquationOfState >::write(), hConstThermo< EquationOfState >::write(), hPolynomialThermo< EquationOfState, PolySize >::write(), hTabulatedThermo< EquationOfState >::write(), janafThermo< EquationOfState >::write(), logPolynomialTransport< Thermo, PolySize >::write(), polynomialTransport< Thermo, PolySize >::write(), sutherlandTransport< Thermo >::write(), tabulatedTransport< Thermo >::write(), WLFTransport< Thermo >::write(), profilingInformation::write(), dictionary::write(), mapDistributePolyMesh::writeCellMapEntries(), MRFZone::writeData(), LookupField< Type >::writeData(), MappedFile< Type >::writeData(), profiling::writeData(), attachDetach::writeDict(), layerAdditionRemoval::writeDict(), perfectInterface::writeDict(), setUpdater::writeDict(), slidingInterface::writeDict(), enginePiston::writeDict(), engineValve::writeDict(), colourTable::writeDict(), cellZone::writeDict(), faceZone::writeDict(), pointZone::writeDict(), plane::writeDict(), ensightCells::writeDict(), ensightFaces::writeDict(), PDRblock::gridControl::writeDict(), GeometricBoundaryField< Type, PatchField, GeoMesh >::writeEntries(), mapDistribute::writeEntries(), mapDistributeBase::writeEntries(), GeometricBoundaryField< Type, PatchField, GeoMesh >::writeEntry(), profilingSysInfo::writeEntry(), coordinateSystem::writeEntry(), cpuInfo::writeEntry(), memInfo::writeEntry(), faBoundaryMesh::writeEntry(), dictionary::writeEntry(), polyBoundaryMesh::writeEntry(), mapDistributePolyMesh::writeFaceMapEntries(), Foam::writeFuncsImpl(), IOobject::writeHeader(), decomposedBlockData::writeHeader(), mapDistributePolyMesh::writePatchMapEntries(), and mapDistributePolyMesh::writePointMapEntries().

Here is the call graph for this function:

◆ beginBlock() [2/2]

Foam::Ostream & beginBlock ( )

virtual

Write begin block group without a name.

Increments indentation, adds newline.

Definition at line 99 of file Ostream.C.

References token::BEGIN_BLOCK, Foam::incrIndent(), and Foam::indent().

Here is the call graph for this function:

◆ endBlock()

Foam::Ostream & endBlock ( )

virtual

Write end block group.

Decrements indentation, adds newline.

Definition at line 108 of file Ostream.C.

References Foam::decrIndent(), token::END_BLOCK, and Foam::indent().

Referenced by Foam::endBlock(), Foam::operator<<(), Foam::printDOT(), Foam::printGraph_impl(), fixedNormalInletOutletVelocityFvPatchVectorField::write(), freestreamFvPatchField< Type >::write(), outletMappedUniformInletFvPatchField< Type >::write(), scaledFixedValueFvPatchField< Type >::write(), sixDoFRigidBodyMotion::write(), surfZone::write(), surfacePatch::write(), polynomialSolidTransport< Thermo, PolySize >::write(), tabulatedAnIsoSolidTransport< Thermo >::write(), tabulatedSolidTransport< Thermo >::write(), adiabaticPerfectFluid< Specie >::write(), Boussinesq< Specie >::write(), icoPolynomial< Specie, PolySize >::write(), icoTabulated< Specie >::write(), incompressiblePerfectGas< Specie >::write(), linear< Type >::write(), perfectFluid< Specie >::write(), rhoConst< Specie >::write(), rPolynomial< Specie >::write(), FallOffReactionRate< ReactionRate, FallOffFunction >::write(), NonEquilibriumReversibleReaction< ReactionType, ReactionThermo, ReactionRate >::write(), specie::write(), eConstThermo< EquationOfState >::write(), hConstThermo< EquationOfState >::write(), hPolynomialThermo< EquationOfState, PolySize >::write(), hTabulatedThermo< EquationOfState >::write(), janafThermo< EquationOfState >::write(), logPolynomialTransport< Thermo, PolySize >::write(), polynomialTransport< Thermo, PolySize >::write(), sutherlandTransport< Thermo >::write(), tabulatedTransport< Thermo >::write(), WLFTransport< Thermo >::write(), profilingInformation::write(), dictionary::write(), mapDistributePolyMesh::writeCellMapEntries(), MRFZone::writeData(), profiling::writeData(), attachDetach::writeDict(), layerAdditionRemoval::writeDict(), perfectInterface::writeDict(), setUpdater::writeDict(), slidingInterface::writeDict(), enginePiston::writeDict(), engineValve::writeDict(), colourTable::writeDict(), cellZone::writeDict(), faceZone::writeDict(), pointZone::writeDict(), plane::writeDict(), ensightCells::writeDict(), ensightFaces::writeDict(), PDRblock::gridControl::writeDict(), GeometricBoundaryField< Type, PatchField, GeoMesh >::writeEntries(), mapDistribute::writeEntries(), mapDistributeBase::writeEntries(), GeometricBoundaryField< Type, PatchField, GeoMesh >::writeEntry(), profilingSysInfo::writeEntry(), coordinateSystem::writeEntry(), cpuInfo::writeEntry(), memInfo::writeEntry(), faBoundaryMesh::writeEntry(), dictionary::writeEntry(), polyBoundaryMesh::writeEntry(), mapDistributePolyMesh::writeFaceMapEntries(), Foam::writeFuncsImpl(), IOobject::writeHeader(), decomposedBlockData::writeHeader(), mapDistributePolyMesh::writePatchMapEntries(), and mapDistributePolyMesh::writePointMapEntries().

Here is the call graph for this function:

◆ endEntry()

Foam::Ostream & endEntry ( )

virtual

Write end entry (';') followed by newline.

Definition at line 117 of file Ostream.C.

References token::END_STATEMENT.

Referenced by Foam::endEntry(), Foam::operator<<(), patchIdentifier::write(), zoneIdentifier::write(), primitiveEntry::write(), engineValve::writeDict(), PDRblock::gridControl::writeDict(), Ostream::writeEntry(), faBoundaryMesh::writeEntry(), faBoundaryMeshEntries::writeEntry(), dimensioned< Type >::writeEntry(), Field< Type >::writeEntry(), polyBoundaryMesh::writeEntry(), polyBoundaryMeshEntries::writeEntry(), and Foam::writeMaps().

Here is the caller graph for this function:

◆ writeEntry()

Ostream& writeEntry	(	const keyType &	key,
		const T &	value
	)

inline

Write a keyword/value entry.

The following two are functionally equivalent:

os.writeEntry(key, value);
 
os.writeKeyword(key) << value << endEntry;

Definition at line 321 of file Ostream.H.

References Ostream::endEntry(), Foam::glTF::key(), and Ostream::writeKeyword().

Here is the call graph for this function:

◆ writeEntryIfDifferent()

Ostream& writeEntryIfDifferent	(	const word &	key,
		const T &	value1,
		const T &	value2
	)

inline

Write a keyword/value entry only when the two values differ.

Parameters

key	the name of the entry
value1	the reference value
value2	the value to write if it differs from value1

Definition at line 335 of file Ostream.H.

References Foam::glTF::key(), and Ostream::writeEntry().

Here is the call graph for this function:

◆ flush()

virtual void flush ( )

pure virtual

Flush stream.

Implemented in OTstream, OSstream, and UOPstreamBase.

◆ endl()

virtual void endl ( )

pure virtual

Add newline and flush stream.

Implemented in OTstream, OSstream, and UOPstreamBase.

◆ fill() [1/2]

virtual char fill ( ) const

pure virtual

Get padding character.

Implemented in OTstream, OSstream, and UOPstreamBase.

Referenced by Foam::setfill().

Here is the caller graph for this function:

◆ fill() [2/2]

virtual char fill ( const char fillch )

pure virtual

Set padding character for formatted field up to field width.

Implemented in OTstream, UOPstreamBase, and OSstream.

◆ width() [1/2]

virtual int width ( ) const

pure virtual

Get width of output field.

Implemented in OTstream, OSstream, and UOPstreamBase.

Referenced by ensightWrite::read(), and Foam::setw().

Here is the caller graph for this function:

◆ width() [2/2]

virtual int width ( const int w )

pure virtual

Set width of output field (and return old width)

Implemented in OTstream, UOPstreamBase, and OSstream.

◆ precision() [1/2]

virtual int precision ( ) const

pure virtual

Get precision of output field.

Implemented in OTstream, OSstream, and UOPstreamBase.

Referenced by Foam::setprecision().

Here is the caller graph for this function:

◆ precision() [2/2]

virtual int precision ( const int p )

pure virtual

Set precision of output field (and return old precision)

Implemented in OTstream, UOPstreamBase, and OSstream.

◆ operator()()

Ostream& operator() ( ) const

inline

Return a non-const reference to const Ostream.

Needed for write functions where the stream argument is temporary: e.g. thing thisThing(OFstream("thingFileName")());

Definition at line 402 of file Ostream.H.

◆ indentLevel() [3/3]

unsigned short& indentLevel ( )

inlinenoexcept

Access to indent level.

Definition at line 413 of file Ostream.H.

References Ostream::indentLevel_.

◆ indentSize() [3/3]

unsigned short& indentSize ( )

inlinenoexcept

Access to indent size.

Definition at line 421 of file Ostream.H.

References Ostream::indentSize_.

Member Data Documentation

◆ entryIndentation_

constexpr const unsigned short entryIndentation_ = 16

staticconstexprprotected

Indentation of the entry from the start of the keyword.

Definition at line 67 of file Ostream.H.

◆ indentSize_

unsigned short indentSize_ = 4

protected

Number of spaces per indent level.

Definition at line 72 of file Ostream.H.

Referenced by Ostream::indentSize().

◆ indentLevel_

unsigned short indentLevel_ = 0

protected

Current indent level.

Definition at line 77 of file Ostream.H.

Referenced by Ostream::decrIndent(), Ostream::incrIndent(), and Ostream::indentLevel().

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

src/OpenFOAM/db/IOstreams/IOstreams/Ostream.H
src/OpenFOAM/db/IOstreams/IOstreams/Ostream.C

Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Ostream() [1/3]

◆ ~Ostream()

◆ Ostream() [2/3]

◆ Ostream() [3/3]

Member Function Documentation

◆ write() [1/11]

◆ write() [2/11]

◆ writeQuoted() [1/2]

◆ writeQuoted() [2/2]

◆ write() [3/11]

◆ write() [4/11]

◆ write() [5/11]

◆ write() [6/11]

◆ write() [7/11]

◆ write() [8/11]

◆ write() [9/11]

◆ write() [10/11]

◆ write() [11/11]

◆ writeRaw()

◆ beginRawWrite()

◆ endRawWrite()

◆ indent()

◆ indentSize() [1/3]

◆ indentSize() [2/3]

◆ indentLevel() [1/3]

◆ indentLevel() [2/3]

◆ incrIndent()

◆ decrIndent()

◆ writeKeyword()

◆ beginBlock() [1/2]

◆ beginBlock() [2/2]

◆ endBlock()

◆ endEntry()

◆ writeEntry()

◆ writeEntryIfDifferent()

◆ flush()

◆ endl()

◆ fill() [1/2]

◆ fill() [2/2]

◆ width() [1/2]

◆ width() [2/2]

◆ precision() [1/2]

◆ precision() [2/2]

◆ operator()()

◆ indentLevel() [3/3]

◆ indentSize() [3/3]

Member Data Documentation

◆ entryIndentation_

◆ indentSize_

◆ indentLevel_