Generic output stream. More...
Public Member Functions | |
OSstream (ostream &os, const string &name, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED) | |
Set stream status. 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 ios_base::fmtflags | flags () const |
Return flags of output stream. More... | |
virtual Ostream & | write (const token &) |
Write next token to stream. More... | |
virtual Ostream & | write (const char) |
Write character. More... | |
virtual Ostream & | write (const char *) |
Write character string. More... | |
virtual Ostream & | write (const word &) |
Write word. More... | |
virtual Ostream & | write (const string &) |
Write string. More... | |
virtual Ostream & | writeQuoted (const std::string &, const bool quoted=true) |
Write std::string surrounded by quotes. More... | |
virtual Ostream & | write (const int32_t) |
Write int32_t. More... | |
virtual Ostream & | write (const int64_t) |
Write int64_t. More... | |
virtual Ostream & | write (const floatScalar) |
Write floatScalar. More... | |
virtual Ostream & | write (const doubleScalar) |
Write doubleScalar. More... | |
virtual Ostream & | write (const longDoubleScalar) |
Write longDoubleScalar. More... | |
virtual Ostream & | write (const char *, std::streamsize) |
Write binary block. More... | |
virtual void | indent () |
Add indentation characters. More... | |
virtual ios_base::fmtflags | flags (const ios_base::fmtflags flags) |
Set flags of output stream. More... | |
virtual void | flush () |
Flush stream. More... | |
virtual void | endl () |
Add newline and flush stream. More... | |
virtual int | width () const |
Get width of output field. More... | |
virtual int | width (const int) |
Set width of output field (and return old width) More... | |
virtual int | precision () const |
Get precision of output field. More... | |
virtual int | precision (const int) |
Set precision of output field (and return old precision) More... | |
virtual ostream & | stdStream () |
Access to underlying std::ostream. More... | |
virtual const ostream & | stdStream () const |
Const access to underlying std::ostream. More... | |
virtual void | print (Ostream &) const |
Print description of IOstream to Ostream. More... | |
void | operator= (const OSstream &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from Ostream | |
Ostream (streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED) | |
Set stream status. More... | |
virtual | ~Ostream () |
Destructor. More... | |
virtual Ostream & | write (const keyType &) |
Write keyType. 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... | |
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 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... | |
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... | |
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... | |
void | print (Ostream &, const int streamState) const |
Check given stream state bits. More... | |
InfoProxy< IOstream > | info () const |
Return info proxy. 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... | |
Protected Attributes inherited from Ostream | |
unsigned short | indentLevel_ |
Current indent level. More... | |
Protected Attributes inherited from IOstream | |
label | lineNumber_ |
Static Protected Attributes inherited from Ostream | |
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... | |
|
inline |
Set stream status.
Definition at line 31 of file OSstreamI.H.
|
inlinevirtual |
Return the name of the stream.
Useful for Fstream to return the filename
Reimplemented from IOstream.
Reimplemented in OFstream.
Definition at line 82 of file OSstream.H.
Referenced by meshObject::addPatch(), mappedPatchBase::calcMapping(), cyclicPolyPatch::calcTransforms(), fvMotionSolver::cellMotionBoundaryTypes(), timeVaryingMappedFixedValuePointPatchField< Type >::checkTable(), meshObject::clear(), meshObject::clearUpto(), dynamicCode::copyAndFilter(), timeVaryingMappedFvPatchField< Type >::map(), meshToMesh::mapAndOpTgtToSrc(), fvMeshAdder::MapDimFields(), fvMeshAdder::MapPointFields(), fvMeshAdder::MapSurfaceFields(), fvMeshAdder::MapVolFields(), meshObject::movePoints(), MeshObject< fvMesh, MoveableMeshObject, CentredFitSnGradData< Polynomial > >::New(), ifEqEqOp< value >::operator()(), oldCyclicPolyPatch::order(), processorPolyPatch::order(), cyclicPolyPatch::order(), meshObject::reorderPatches(), motionSmootherAlgo::setDisplacementPatchFields(), hexRef8::setRefinement(), triSurface::triSurfInstance(), timeVaryingMappedFixedValuePointPatchField< Type >::updateCoeffs(), and meshObject::updateMesh().
|
inlinevirtual |
Return non-const access to the name of the stream.
Useful to alter the stream name
Reimplemented from IOstream.
Reimplemented in OFstream.
Definition at line 89 of file OSstream.H.
|
virtual |
|
virtual |
Write next token to stream.
Implements Ostream.
Reimplemented in prefixOSstream.
Definition at line 32 of file OSstream.C.
References token::BEGIN_BLOCK, token::END_BLOCK, token::HASH, token::stringToken(), token::type(), token::VARIABLE, token::VERBATIMSTRING, and OSstream::writeQuoted().
Referenced by searchableSurfaces::checkIntersection(), OSstream::endl(), prefixOSstream::write(), OBJstream::write(), OBJstream::writeQuoted(), and masterOFstream::~masterOFstream().
|
virtual |
Write character.
Implements Ostream.
Reimplemented in OBJstream, and prefixOSstream.
Definition at line 50 of file OSstream.C.
References Foam::constant::universal::c, IOstream::lineNumber_, token::NL, and IOstream::setState().
|
virtual |
Write character string.
Implements Ostream.
Reimplemented in ensightFile, OBJstream, and prefixOSstream.
Definition at line 62 of file OSstream.C.
References string::count(), IOstream::lineNumber_, token::NL, and IOstream::setState().
|
virtual |
Write word.
Implements Ostream.
Reimplemented in OBJstream, and prefixOSstream.
Definition at line 71 of file OSstream.C.
References IOstream::setState().
|
virtual |
Write string.
In the rare case that the string contains a final trailing backslash, it will be dropped to the appearance of an escaped double-quote.
Implements Ostream.
Reimplemented in ensightFile, OBJstream, and prefixOSstream.
Definition at line 79 of file OSstream.C.
References token::BEGIN_STRING, Foam::constant::universal::c, token::END_STRING, IOstream::lineNumber_, token::NL, IOstream::setState(), and OSstream::writeQuoted().
|
virtual |
Write std::string surrounded by quotes.
Optional write without quotes.
Implements Ostream.
Reimplemented in OBJstream, and prefixOSstream.
Definition at line 125 of file OSstream.C.
References token::BEGIN_STRING, Foam::constant::universal::c, string::count(), token::END_STRING, IOstream::lineNumber_, token::NL, and IOstream::setState().
Referenced by dynamicCode::copyAndFilter(), OSstream::write(), and prefixOSstream::writeQuoted().
|
virtual |
Write int32_t.
Implements Ostream.
Reimplemented in prefixOSstream.
Definition at line 186 of file OSstream.C.
References IOstream::setState().
|
virtual |
Write int64_t.
Implements Ostream.
Reimplemented in prefixOSstream.
Definition at line 194 of file OSstream.C.
References IOstream::setState().
|
virtual |
Write floatScalar.
Implements Ostream.
Reimplemented in prefixOSstream.
Definition at line 202 of file OSstream.C.
References IOstream::setState().
|
virtual |
Write doubleScalar.
Implements Ostream.
Reimplemented in prefixOSstream.
Definition at line 210 of file OSstream.C.
References IOstream::setState().
|
virtual |
Write longDoubleScalar.
Implements Ostream.
Reimplemented in prefixOSstream.
Definition at line 218 of file OSstream.C.
References IOstream::setState().
|
virtual |
Write binary block.
Implements Ostream.
Reimplemented in prefixOSstream, and ensightFile.
Definition at line 226 of file OSstream.C.
References Foam::abort(), token::BEGIN_LIST, IOstream::BINARY, token::END_LIST, Foam::FatalIOError, FatalIOErrorInFunction, IOstream::format(), and IOstream::setState().
|
virtual |
Add indentation characters.
Implements Ostream.
Reimplemented in prefixOSstream.
Definition at line 245 of file OSstream.C.
References Ostream::indentLevel_, and Ostream::indentSize_.
Referenced by prefixOSstream::indent().
|
virtual |
|
virtual |
Flush stream.
Implements Ostream.
Definition at line 254 of file OSstream.C.
Referenced by DSMCCloud< ParcelType >::dumpParticlePositions(), externalCoupledTemperatureMixedFvPatchScalarField::transferData(), externalCoupledMixedFvPatchField< scalar >::transferData(), and Cloud< streamLineParticle >::writePositions().
|
virtual |
Add newline and flush stream.
Implements Ostream.
Definition at line 260 of file OSstream.C.
References OSstream::write().
|
virtual |
|
virtual |
Set width of output field (and return old width)
Implements Ostream.
Definition at line 287 of file OSstream.C.
|
virtual |
Get precision of output field.
Implements Ostream.
Definition at line 293 of file OSstream.C.
Referenced by ensightAsciiStream::ensightAsciiStream(), ensightFile::ensightFile(), Foam::stringOps::getVariable(), Foam::stringOps::inplaceExpand(), NamedEnum< directionType, 3 >::names(), Time::readDict(), and ensightSetWriter< Type >::write().
|
virtual |
Set precision of output field (and return old precision)
Implements Ostream.
Definition at line 299 of file OSstream.C.
|
inlinevirtual |
Access to underlying std::ostream.
Reimplemented in OFstream.
Definition at line 175 of file OSstream.H.
Referenced by OStringStream::rewind(), OStringStream::str(), decomposedBlockData::writeBlocks(), and OStringStream::~OStringStream().
|
inlinevirtual |
Const access to underlying std::ostream.
Reimplemented in OFstream.
Definition at line 181 of file OSstream.H.
References OSstream::operator=(), and OSstream::print().
|
virtual |
Print description of IOstream to Ostream.
Reimplemented from IOstream.
Reimplemented in prefixOSstream, OFstream, and OStringStream.
Definition at line 43 of file SstreamsPrint.C.
References ISstream::name(), and IOstream::print().
Referenced by OStringStream::print(), OFstream::print(), prefixOSstream::print(), and OSstream::stdStream().
|
delete |
Disallow default bitwise assignment.
Referenced by OSstream::stdStream().