Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
Ostream Class Referenceabstract

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

Inheritance diagram for Ostream:
Inheritance graph
[legend]
Collaboration diagram for Ostream:
Collaboration graph
[legend]

Public Member Functions

 Ostream (streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
 Set stream status. More...
 
virtual ~Ostream ()
 Destructor. More...
 
virtual Ostreamwrite (const token &)=0
 Write next token to stream. More...
 
virtual Ostreamwrite (const char)=0
 Write character. More...
 
virtual Ostreamwrite (const char *)=0
 Write character string. More...
 
virtual Ostreamwrite (const word &)=0
 Write word. More...
 
virtual Ostreamwrite (const keyType &)
 Write keyType. More...
 
virtual Ostreamwrite (const string &)=0
 Write string. More...
 
virtual OstreamwriteQuoted (const std::string &, const bool quoted=true)=0
 Write std::string surrounded by quotes. More...
 
virtual Ostreamwrite (const int32_t)=0
 Write int32_t. More...
 
virtual Ostreamwrite (const int64_t)=0
 Write int64_t. More...
 
virtual Ostreamwrite (const floatScalar)=0
 Write floatScalar. More...
 
virtual Ostreamwrite (const doubleScalar)=0
 Write doubleScalar. More...
 
virtual Ostreamwrite (const char *, std::streamsize)=0
 Write binary block. More...
 
virtual void indent ()=0
 Add indentation characters. 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...
 
OstreamwriteKeyword (const keyType &)
 Write the keyword followed by an appropriate indentation. More...
 
virtual void flush ()=0
 Flush stream. More...
 
virtual void endl ()=0
 Add newline and flush stream. 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...
 
Ostreamoperator() () 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 const fileNamename () const
 Return the name of the stream. More...
 
virtual fileNamename ()
 Return non-const access to the name of the stream. 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...
 
labellineNumber ()
 Return current stream line number. More...
 
label lineNumber (const label ln)
 Set the stream line number. More...
 
virtual ios_base::fmtflags flags () const =0
 Return flags of stream. 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...
 
virtual ios_base::fmtflags flags (const ios_base::fmtflags f)=0
 Set flags of stream. 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...
 
virtual void print (Ostream &) const
 Print description of IOstream to Ostream. More...
 
void print (Ostream &, const int streamState) const
 Check given stream state bits. More...
 
InfoProxy< IOstreaminfo () const
 Return info proxy. More...
 

Protected Attributes

unsigned short indentLevel_
 Current indent level. More...
 
- Protected Attributes inherited from IOstream
label lineNumber_
 

Static Protected Attributes

static const unsigned short indentSize_ = 4
 Number of spaces per indent level. More...
 
static const unsigned short entryIndentation_ = 16
 Indentation of the entry from the start of the keyword. 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 originalVersion
 Original version number. More...
 
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...
 

Detailed Description

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

Source files

Definition at line 53 of file Ostream.H.

Constructor & Destructor Documentation

Ostream ( streamFormat  format = ASCII,
versionNumber  version = currentVersion,
compressionType  compression = UNCOMPRESSED 
)
inline

Set stream status.

Definition at line 78 of file Ostream.H.

virtual ~Ostream ( )
inlinevirtual

Destructor.

Definition at line 90 of file Ostream.H.

References Ostream::indent(), Ostream::write(), and Ostream::writeQuoted().

Here is the call graph for this function:

Member Function Documentation

virtual Ostream& write ( const token )
pure virtual

Write next token to stream.

Implemented in UOPstream, OSstream, and prefixOSstream.

Referenced by autoLayerDriver::addLayers(), interRegionHeatTransferModel::addSup(), autoRefineDriver::autoRefineDriver(), hexRef8::consistentSlowRefinement2(), trackedParticle::correctAfterParallelTransfer(), autoSnapDriver::doSnap(), directionInfo::edgeToFaceIndex(), findCellParticle::hitPatch(), if(), keyType::match(), meshRefinement::mergeBaffles(), meshRefinement::mergeEdgesUndo(), meshRefinement::mergePatchFacesUndo(), NamedEnum< Enum, nEnum >::names(), OBJstream::nVertices(), ListPlusEqOp< T, Size >::operator()(), Foam::operator<<(), pointFieldReconstructor::reconstructFields(), fvFieldReconstructor::reconstructFvSurfaceFields(), fvFieldReconstructor::reconstructFvVolumeFields(), fvFieldReconstructor::reconstructFvVolumeInternalFields(), Foam::reconstructLagrangianFieldFields(), Foam::reconstructLagrangianFields(), labelledTri::region(), rotorDiskSource::setFaceArea(), refinementIterator::setRefinement(), hexRef8::setRefinement(), autoSnapDriver::smoothDisplacement(), fieldCoordinateSystemTransform::transformField(), SHA1Digest::write(), FallOffReactionRate< ReactionRate, FallOffFunction >::write(), dsmcFields::write(), dictionaryEntry::write(), primitiveEntry::write(), NonEquilibriumReversibleReaction< ReactionType, ReactionThermo, ReactionRate >::write(), streamLine::write(), wallBoundedStreamLine::write(), PackedList< nBits >::write(), UniformDimensionedField< Type >::writeData(), fixedCoeff::writeData(), powerLaw::writeData(), DarcyForchheimer::writeData(), MRFZone::writeData(), FixedList< T, Size >::writeEntry(), solidParticle::writeFields(), molecule::writeFields(), interpolate::writeInterpolateField(), Ostream::writeKeyword(), particle< Type >::writePosition(), randomise::writeRandomField(), and Ostream::~Ostream().

virtual Ostream& write ( const char  )
pure virtual

Write character.

Implemented in UOPstream, OSstream, OBJstream, and prefixOSstream.

virtual Ostream& write ( const char *  )
pure virtual

Write character string.

Implemented in UOPstream, ensightFile, OSstream, OBJstream, and prefixOSstream.

virtual Ostream& write ( const word )
pure virtual

Write word.

Implemented in UOPstream, OSstream, OBJstream, and prefixOSstream.

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

Write keyType.

Definition at line 52 of file Ostream.C.

References keyType::isPattern(), and Ostream::writeQuoted().

Here is the call graph for this function:

virtual Ostream& write ( const string )
pure virtual

Write string.

Implemented in UOPstream, ensightFile, OSstream, OBJstream, and prefixOSstream.

virtual Ostream& writeQuoted ( const std::string &  ,
const bool  quoted = true 
)
pure virtual

Write std::string surrounded by quotes.

Optional write without quotes.

Implemented in UOPstream, OSstream, OBJstream, and prefixOSstream.

Referenced by Foam::operator<<(), Ostream::write(), codedFixedValueFvPatchField< Type >::write(), codedFixedValuePointPatchField< Type >::write(), codedMixedFvPatchField< Type >::write(), dynamicCode::writeCommentSHA1(), and Ostream::~Ostream().

Here is the caller graph for this function:

virtual Ostream& write ( const int32_t  )
pure virtual

Write int32_t.

Implemented in UOPstream, OSstream, and prefixOSstream.

virtual Ostream& write ( const int64_t  )
pure virtual

Write int64_t.

Implemented in UOPstream, OSstream, and prefixOSstream.

virtual Ostream& write ( const floatScalar  )
pure virtual

Write floatScalar.

Implemented in UOPstream, OSstream, and prefixOSstream.

virtual Ostream& write ( const doubleScalar  )
pure virtual

Write doubleScalar.

Implemented in UOPstream, OSstream, and prefixOSstream.

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

Write binary block.

Implemented in UOPstream, OSstream, prefixOSstream, and ensightFile.

virtual void indent ( )
pure virtual

Add indentation characters.

Implemented in UOPstream, OSstream, and prefixOSstream.

Referenced by Foam::indent(), dictionaryEntry::write(), Ostream::writeKeyword(), and Ostream::~Ostream().

Here is the caller graph for this function:

unsigned short indentLevel ( ) const
inline

Return indent level.

Definition at line 143 of file Ostream.H.

References Ostream::indentLevel_.

unsigned short& indentLevel ( )
inline

Access to indent level.

Definition at line 149 of file Ostream.H.

References Ostream::indentLevel_.

void incrIndent ( )
inline

Incrememt the indent level.

Definition at line 155 of file Ostream.H.

References Ostream::decrIndent(), Ostream::endl(), Ostream::flush(), Ostream::operator()(), p, Ostream::precision(), Ostream::width(), and Ostream::writeKeyword().

Referenced by Foam::incrIndent().

Here is the call graph for this function:

Here is the caller graph for this function:

void decrIndent ( )

Decrememt the indent level.

Definition at line 35 of file Ostream.C.

References Foam::endl(), and Ostream::indentLevel_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::Ostream & writeKeyword ( const keyType kw)

Write the keyword followed by an appropriate indentation.

Definition at line 59 of file Ostream.C.

References Ostream::entryIndentation_, Ostream::indent(), keyType::isPattern(), token::SPACE, and Ostream::write().

Referenced by Ostream::incrIndent(), Foam::operator<<(), phaseProperties::phaseProperties(), codedFixedValueFvPatchField< Type >::redirectPatchField(), codedFixedValuePointPatchField< Type >::redirectPatchField(), thirdBodyEfficiencies::write(), SRIFallOffFunction::write(), TroeFallOffFunction::write(), ArrheniusReactionRate::write(), axis::write(), LandauTellerReactionRate::write(), coupleGroupIdentifier::write(), sphericalAngularDamper::write(), JanevReactionRate::write(), powerSeriesReactionRate::write(), linearDamper::write(), solidArrheniusReactionRate::write(), LangmuirHinshelwoodReactionRate::write(), point::write(), csvTableReader< Type >::write(), tableReader< Type >::write(), line::write(), plane::write(), sphericalAngularSpring::write(), ReactionList< ThermoType >::write(), linearAxialAngularSpring::write(), boundaryPatch::write(), CloudSubModelBase< CloudType >::write(), linearSpring::write(), DispersionRASModel< CloudType >::write(), tabulatedAxialAngularSpring::write(), timeVaryingAlphaContactAngleFvPatchScalarField::write(), fixedShearStressFvPatchVectorField::write(), oscillatingDisplacementPointPatchVectorField::write(), waveDisplacementPointPatchVectorField::write(), constantAlphaContactAngleFvPatchScalarField::write(), surfZoneIdentifier::write(), dynamicAlphaContactAngleFvPatchScalarField::write(), interpolation2DTable< Type >::write(), mappedPatchFieldBase< Type >::write(), fixedNormalSlipPointPatchField< Type >::write(), oscillatingVelocityPointPatchVectorField::write(), genericPointPatchField< Type >::write(), solidBodyMotionDisplacementPointPatchVectorField::write(), angularOscillatingDisplacementPointPatchVectorField::write(), angularOscillatingVelocityPointPatchVectorField::write(), interpolationTable< Type >::write(), sixDoFRigidBodyMotionState::write(), radiationCoupledBase::write(), alphaContactAngleFvPatchScalarField::write(), patchIdentifier::write(), genericPolyPatch::write(), interpolationLookUpTable< Type >::write(), totalFlowRateAdvectiveDiffusiveFvPatchScalarField::write(), uniformInterpolatedDisplacementPointPatchVectorField::write(), fixedMeanFvPatchField< Type >::write(), primitiveEntry::write(), translatingWallVelocityFvPatchVectorField::write(), nutkFilmWallFunctionFvPatchScalarField::write(), freestreamFvPatchField< Type >::write(), solidReaction< ReactionThermo >::write(), genericFvPatchField< Type >::write(), sixDoFRigidBodyDisplacementPointPatchVectorField::write(), temperatureCoupledBase::write(), inletOutletFvPatchField< Type >::write(), outletInletFvPatchField< Type >::write(), outletMappedUniformInletFvPatchField< Type >::write(), nutUTabulatedWallFunctionFvPatchScalarField::write(), variableHeightFlowRateFvPatchScalarField::write(), fixedJumpAMIFvPatchField< Type >::write(), outletPhaseMeanVelocityFvPatchVectorField::write(), regionCoupledBase::write(), timeVaryingMappedFixedValuePointPatchField< Type >::write(), rotatingPressureInletOutletVelocityFvPatchVectorField::write(), fixedJumpFvPatchField< Type >::write(), surfaceSlipDisplacementPointPatchVectorField::write(), variableHeightFlowRateInletVelocityFvPatchVectorField::write(), uniformInletOutletFvPatchField< Type >::write(), STARCDCoordinateRotation::write(), alphatWallFunctionFvPatchScalarField::write(), surfaceDisplacementPointPatchVectorField::write(), EulerCoordinateRotation::write(), cylindricalInletVelocityFvPatchVectorField::write(), convectiveHeatTransferFvPatchScalarField::write(), turbulentIntensityKineticEnergyInletFvPatchScalarField::write(), kLowReWallFunctionFvPatchScalarField::write(), rotatingWallVelocityFvPatchVectorField::write(), axesRotation::write(), alphatFilmWallFunctionFvPatchScalarField::write(), pressureNormalInletOutletVelocityFvPatchVectorField::write(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::write(), turbulentMixingLengthFrequencyInletFvPatchScalarField::write(), fanPressureFvPatchScalarField::write(), mappedVariableThicknessWallPolyPatch::write(), SRFFreestreamVelocityFvPatchVectorField::write(), alphatJayatillekeWallFunctionFvPatchScalarField::write(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::write(), cylindrical::write(), codedFixedValueFvPatchField< Type >::write(), codedFixedValuePointPatchField< Type >::write(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::write(), SRFVelocityFvPatchVectorField::write(), nutURoughWallFunctionFvPatchScalarField::write(), codedMixedFvPatchField< Type >::write(), thermalBaffle1DFvPatchScalarField< solidType >::write(), turbulentHeatFluxTemperatureFvPatchScalarField::write(), uniformDensityHydrostaticPressureFvPatchScalarField::write(), timeVaryingMappedFixedValueFvPatchField< Type >::write(), turbulentInletFvPatchField< Type >::write(), syringePressureFvPatchScalarField::write(), phaseHydrostaticPressureFvPatchScalarField::write(), thermalBaffleFvPatchScalarField::write(), oldCyclicPolyPatch::write(), atmBoundaryLayer::write(), oscillatingFixedValueFvPatchField< Type >::write(), externalWallHeatFluxTemperatureFvPatchScalarField::write(), sixDoFRigidBodyMotion::write(), fvsPatchField< Type >::write(), cyclicACMIPolyPatch::write(), processorPolyPatch::write(), polyPatch::write(), coupledPolyPatch::write(), Reaction< ReactionThermo >::write(), externalCoupledMixedFvPatchField< Type >::write(), processorCyclicPolyPatch::write(), cyclicPolyPatch::write(), cyclicAMIPolyPatch::write(), pointPatchField< Type >::write(), mappedPatchBase::write(), fvPatchField< Type >::write(), UniformDimensionedField< Type >::writeData(), TableFile< Type >::writeData(), CompatibilityConstant< Type >::writeData(), CSV< Type >::writeData(), DataEntry< Type >::writeData(), MRFZone::writeData(), DimensionedField< Type, GeoMesh >::writeData(), ensightPart::writeData(), option::writeData(), surfZone::writeDict(), plane::writeDict(), coordinateSystem::writeDict(), TableBase< Type >::writeEntries(), FixedList< T, Size >::writeEntry(), UList< T >::writeEntry(), Field< Type >::writeEntry(), PackedList< nBits >::writeEntry(), fvPatchField< Type >::writeEntryIfDifferent(), fWallFunctionFvPatchScalarField::writeLocalEntries(), v2WallFunctionFvPatchScalarField::writeLocalEntries(), nutWallFunctionFvPatchScalarField::writeLocalEntries(), epsilonWallFunctionFvPatchScalarField::writeLocalEntries(), omegaWallFunctionFvPatchScalarField::writeLocalEntries(), and ensightPart::writeSummary().

Here is the call graph for this function:

virtual void flush ( )
pure virtual

Flush stream.

Implemented in UOPstream, and OSstream.

Referenced by Foam::flush(), Ostream::incrIndent(), wordRe::info(), STARCDsurfaceFormatCore::writeCase(), STARCDedgeFormat::writeCase(), and STARCDCore::writePoints().

Here is the caller graph for this function:

virtual void endl ( )
pure virtual

Add newline and flush stream.

Implemented in UOPstream, and OSstream.

Referenced by Foam::endl(), and Ostream::incrIndent().

Here is the caller graph for this function:

virtual int width ( ) const
pure virtual

Get width of output field.

Implemented in UOPstream, and OSstream.

Referenced by Ostream::incrIndent(), functionObjectFile::initStream(), and Foam::setw().

Here is the caller graph for this function:

virtual int width ( const int  w)
pure virtual

Set width of output field (and return old width)

Implemented in UOPstream, and OSstream.

virtual int precision ( ) const
pure virtual

Get precision of output field.

Implemented in UOPstream, and OSstream.

Referenced by Ostream::incrIndent(), Foam::setprecision(), dimensionSet::write(), and STARCDCore::writePoints().

Here is the caller graph for this function:

virtual int precision ( const int  p)
pure virtual

Set precision of output field (and return old precision)

Implemented in UOPstream, and OSstream.

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 193 of file Ostream.H.

Referenced by Ostream::incrIndent().

Here is the caller graph for this function:

Member Data Documentation

const unsigned short indentSize_ = 4
staticprotected

Number of spaces per indent level.

Definition at line 63 of file Ostream.H.

Referenced by OSstream::indent().

const unsigned short entryIndentation_ = 16
staticprotected

Indentation of the entry from the start of the keyword.

Definition at line 66 of file Ostream.H.

Referenced by Ostream::writeKeyword().

unsigned short indentLevel_
protected

Current indent level.

Definition at line 69 of file Ostream.H.

Referenced by Ostream::decrIndent(), OSstream::indent(), and Ostream::indentLevel().


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