An Ostream is an abstract base class for all output systems (streams, files, token lists, etc). More...
Public Member Functions | |
Ostream (streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED) | |
Set stream status. More... | |
virtual | ~Ostream () |
Destructor. More... | |
virtual Ostream & | write (const token &)=0 |
Write next token to stream. More... | |
virtual Ostream & | write (const char)=0 |
Write character. More... | |
virtual Ostream & | write (const char *)=0 |
Write character string. More... | |
virtual Ostream & | write (const word &)=0 |
Write word. More... | |
virtual Ostream & | write (const keyType &) |
Write keyType. More... | |
virtual Ostream & | write (const string &)=0 |
Write string. More... | |
virtual Ostream & | writeQuoted (const std::string &, const bool quoted=true)=0 |
Write std::string surrounded by quotes. More... | |
virtual Ostream & | write (const int32_t)=0 |
Write int32_t. More... | |
virtual Ostream & | write (const int64_t)=0 |
Write int64_t. More... | |
virtual Ostream & | write (const floatScalar)=0 |
Write floatScalar. More... | |
virtual Ostream & | write (const doubleScalar)=0 |
Write doubleScalar. More... | |
virtual Ostream & | write (const longDoubleScalar)=0 |
Write longDoubleScalar. More... | |
virtual Ostream & | write (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... | |
Ostream & | writeKeyword (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... | |
Ostream & | operator() () 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 fileName & | name () const |
Return the name of the stream. More... | |
virtual fileName & | name () |
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... | |
label & | lineNumber () |
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< IOstream > | info () 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... | |
An Ostream is an abstract base class for all output systems (streams, files, token lists, etc).
|
inline |
|
inlinevirtual |
Destructor.
Definition at line 90 of file Ostream.H.
References Ostream::indent(), Ostream::write(), and Ostream::writeQuoted().
Write next token to stream.
Implemented in UOPstream, OSstream, and prefixOSstream.
Referenced by snappyLayerDriver::addLayers(), hexRef8::consistentSlowRefinement2(), constAnIsoSolidTransport< Thermo >::constAnIsoSolidTransport(), constIsoSolidTransport< Thermo >::constIsoSolidTransport(), constTransport< Thermo >::constTransport(), snappySnapDriver::doSnap(), exponentialSolidTransport< Thermo >::exponentialSolidTransport(), hPowerThermo< EquationOfState >::hPowerThermo(), if(), meshToMesh::mapAndOpTgtToSrc(), meshRefinement::mergeBaffles(), meshRefinement::mergeEdgesUndo(), meshRefinement::mergePatchFacesUndo(), OBJstream::nVertices(), ListPlusEqOp< T, Size >::operator()(), Foam::operator<<(), pointFieldReconstructor::reconstructFields(), fvFieldReconstructor::reconstructFvSurfaceFields(), fvFieldReconstructor::reconstructFvVolumeFields(), fvFieldReconstructor::reconstructFvVolumeInternalFields(), Foam::reconstructLagrangianFieldFields(), Foam::reconstructLagrangianFields(), rotorDiskSource::setFaceArea(), refinementIterator::setRefinement(), hexRef8::setRefinement(), snappySnapDriver::smoothDisplacement(), snappyRefineDriver::snappyRefineDriver(), dsmcFields::write(), SHA1Digest::write(), XiReactionRate::write(), writeCellCentres::write(), functionEntry::write(), FallOffReactionRate< ReactionRate, FallOffFunction >::write(), ChemicallyActivatedReactionRate< ReactionRate, ChemicallyActivationFunction >::write(), WLFTransport< Thermo >::write(), perfectGas< Specie >::write(), dictionaryEntry::write(), rhoConst< Specie >::write(), sutherlandTransport< Thermo >::write(), hConstThermo< EquationOfState >::write(), eRefConstThermo< EquationOfState >::write(), hRefConstThermo< EquationOfState >::write(), eConstThermo< EquationOfState >::write(), incompressiblePerfectGas< Specie >::write(), perfectFluid< Specie >::write(), linear< Type >::write(), primitiveEntry::write(), age::write(), polynomialSolidTransport< Thermo, PolySize >::write(), polynomialTransport< Thermo, PolySize >::write(), adiabaticPerfectFluid< Specie >::write(), PengRobinsonGas< Specie >::write(), logPolynomialTransport< Thermo, PolySize >::write(), janafThermo< EquationOfState >::write(), NonEquilibriumReversibleReaction< ReactionType, ReactionThermo, ReactionRate >::write(), hPolynomialThermo< EquationOfState, PolySize >::write(), streamLine::write(), thermo< Thermo, Type >::write(), PackedList< 2 >::write(), UniformDimensionedField< vector >::writeData(), fixedCoeff::writeData(), powerLaw::writeData(), DarcyForchheimer::writeData(), powerLawLopesdaCosta::writeData(), solidification::writeData(), MRFZone::writeData(), Ostream::writeKeyword(), particle< Type >::writePosition(), and Ostream::~Ostream().
|
pure virtual |
Write character.
Implemented in UOPstream, OBJstream, OSstream, and prefixOSstream.
|
pure virtual |
Write character string.
Implemented in UOPstream, ensightFile, OBJstream, OSstream, and prefixOSstream.
Write word.
Implemented in UOPstream, OBJstream, OSstream, and prefixOSstream.
|
virtual |
Write keyType.
write regular expression as quoted string write plain word as word (unquoted)
Definition at line 48 of file Ostream.C.
References keyType::isPattern(), and Ostream::writeQuoted().
Write string.
Implemented in UOPstream, ensightFile, OSstream, OBJstream, and prefixOSstream.
|
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(), decomposedBlockData::writeData(), and Ostream::~Ostream().
|
pure virtual |
Write int32_t.
Implemented in UOPstream, OSstream, and prefixOSstream.
|
pure virtual |
Write int64_t.
Implemented in UOPstream, OSstream, and prefixOSstream.
|
pure virtual |
Write floatScalar.
Implemented in UOPstream, OSstream, and prefixOSstream.
|
pure virtual |
Write doubleScalar.
Implemented in UOPstream, OSstream, and prefixOSstream.
|
pure virtual |
Write longDoubleScalar.
Implemented in UOPstream, OSstream, and prefixOSstream.
|
pure virtual |
Write binary block.
Implemented in UOPstream, OSstream, prefixOSstream, and ensightFile.
|
pure virtual |
Add indentation characters.
Implemented in UOPstream, OSstream, and prefixOSstream.
Referenced by Foam::indent(), dictionaryEntry::write(), Ostream::writeKeyword(), and Ostream::~Ostream().
|
inline |
|
inline |
|
inline |
Incrememt the indent level.
Definition at line 160 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().
void decrIndent | ( | ) |
Decrememt the indent level.
Definition at line 34 of file Ostream.C.
References Foam::endl(), and Ostream::indentLevel_.
Referenced by Foam::decrIndent(), and Ostream::incrIndent().
Foam::Ostream & writeKeyword | ( | const keyType & | kw | ) |
Write the keyword followed by an appropriate indentation.
Definition at line 54 of file Ostream.C.
References Ostream::entryIndentation_, Ostream::indent(), keyType::isPattern(), token::SPACE, and Ostream::write().
Referenced by Ostream::incrIndent(), composite::write(), csvTableReader< Type >::write(), tabulatedAxialAngularSpring::write(), JanevReactionRate::write(), fixedNormalSlipPointPatchField< Type >::write(), primitiveEntry::write(), regionCoupledBase::write(), codedFixedValueFvPatchField< Type >::write(), codedFixedValuePointPatchField< Type >::write(), codedMixedFvPatchField< Type >::write(), waveSuperposition::write(), thermalBaffleFvPatchScalarField::write(), mappedPatchBase::write(), cyclicAMIPolyPatch::write(), UniformDimensionedField< vector >::writeData(), Function1< Foam::Vector >::writeData(), Foam::writeEntry(), and Foam::writeListEntries().
|
pure virtual |
Flush stream.
Implemented in UOPstream, and OSstream.
Referenced by Foam::flush(), Ostream::incrIndent(), wordRe::info(), STARCDsurfaceFormatCore::writeCase(), STARCDedgeFormat::writeCase(), and STARCDCore::writePoints().
|
pure virtual |
Add newline and flush stream.
Implemented in UOPstream, and OSstream.
Referenced by Foam::endl(), and Ostream::incrIndent().
|
pure virtual |
Get width of output field.
Implemented in UOPstream, and OSstream.
Referenced by Ostream::incrIndent(), writeFile::initStream(), and Foam::setw().
|
pure virtual |
|
pure virtual |
Get precision of output field.
Implemented in UOPstream, and OSstream.
Referenced by Ostream::incrIndent(), Foam::setprecision(), dimensionSet::write(), and STARCDCore::writePoints().
|
pure virtual |
|
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 198 of file Ostream.H.
Referenced by Ostream::incrIndent().
|
staticprotected |
Number of spaces per indent level.
Definition at line 63 of file Ostream.H.
Referenced by OSstream::indent().
|
staticprotected |
Indentation of the entry from the start of the keyword.
Definition at line 66 of file Ostream.H.
Referenced by Ostream::writeKeyword().
|
protected |
Current indent level.
Definition at line 69 of file Ostream.H.
Referenced by Ostream::decrIndent(), OSstream::indent(), and Ostream::indentLevel().