Output to file stream, using an OSstream. More...
Public Member Functions | |
| ClassName ("OFstream") | |
| OFstream (const fileName &pathname, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED, const bool append=false) | |
| Construct from pathname. More... | |
| ~OFstream ()=default | |
| Destructor. More... | |
| virtual std::ostream & | stdStream () |
| Access to underlying std::ostream. More... | |
| virtual const std::ostream & | stdStream () const |
| Const access to underlying std::ostream. More... | |
| void | print (Ostream &os) const |
| Print description of IOstream to Ostream. More... | |
| virtual const fileName & | name () const |
| Read/write access to the name of the stream. More... | |
| virtual fileName & | name () |
| Read/write access to the name of the stream. More... | |
 Public Member Functions inherited from OSstream | |
| OSstream (std::ostream &os, const string &name, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED) | |
| Construct as wrapper around std::ostream and 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 bool | write (const token &tok) |
| Write token to stream or otherwise handle it. More... | |
| virtual Ostream & | write (const char c) |
| Write character. More... | |
| virtual Ostream & | write (const char *str) |
| Write character string. More... | |
| virtual Ostream & | write (const word &str) |
| Write word. More... | |
| virtual Ostream & | write (const string &str) |
| Write string (quoted) More... | |
| virtual Ostream & | writeQuoted (const std::string &str, const bool quoted=true) |
| Write std::string surrounded by quotes. More... | |
| virtual Ostream & | write (const int32_t val) |
| Write int32_t. More... | |
| virtual Ostream & | write (const int64_t val) |
| Write int64_t. More... | |
| virtual Ostream & | write (const floatScalar val) |
| Write floatScalar. More... | |
| virtual Ostream & | write (const doubleScalar val) |
| Write doubleScalar. More... | |
| virtual Ostream & | write (const char *data, std::streamsize count) |
| Write binary block. More... | |
| virtual Ostream & | writeRaw (const char *data, std::streamsize count) |
| Low-level raw binary output. More... | |
| virtual bool | beginRawWrite (std::streamsize count) |
| Begin marker for low-level raw binary output. More... | |
| virtual bool | endRawWrite () |
| End marker for low-level raw binary output. More... | |
| virtual void | indent () |
| Add indentation characters. More... | |
| virtual ios_base::fmtflags | flags (const ios_base::fmtflags f) |
| Set stream flags. More... | |
| virtual void | flush () |
| Flush stream. More... | |
| virtual void | endl () |
| Add newline and flush stream. More... | |
| virtual char | fill () const |
| Get the current padding character. More... | |
| virtual char | fill (const char fillch) |
| Set padding character for formatted field up to field width. More... | |
| virtual int | width () const |
| Get width of output field. More... | |
| virtual int | width (const int w) |
| Set width of output field. More... | |
| virtual int | precision () const |
| Get precision of output field. More... | |
| virtual int | precision (const int p) |
| Set precision of output field. More... | |
| Public Member Functions inherited from Ostream | |
| Ostream (streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED) | |
| Construct and set stream status. More... | |
| virtual | ~Ostream ()=default |
| Destructor. More... | |
| virtual Ostream & | write (const keyType &kw) |
| Write keyType. More... | |
| unsigned short | indentSize () const |
| Return indent level. More... | |
| unsigned short & | indentSize () |
| Access to indent size. More... | |
| unsigned short | indentLevel () const |
| Return indent level. More... | |
| unsigned short & | indentLevel () |
| Access to indent level. More... | |
| void | incrIndent () |
| 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... | |
| Ostream & | operator() () const |
| Return a non-const reference to const Ostream. More... | |
| Public Member Functions inherited from IOstream | |
| IOstream (const IOstreamOption option) | |
| Construct with specified stream option. More... | |
| IOstream (streamFormat format, versionNumber version, compressionType compression=UNCOMPRESSED) | |
| Construct with format, version. More... | |
| virtual | ~IOstream ()=default |
| 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 bool () const | |
| Return true if the stream has not failed. More... | |
| bool | operator! () const |
| Return true if the stream has failed. More... | |
| unsigned | labelByteSize () const |
| The label byte-size associated with the stream. More... | |
| unsigned | scalarByteSize () const |
| The scalar byte-size associated with the stream. More... | |
| void | setLabelByteSize (unsigned nbytes) |
| Set the label byte-size associated with the stream. More... | |
| void | setScalarByteSize (unsigned nbytes) |
| Set the scalar byte-size associated with the stream. More... | |
| template<class T = label> | |
| std::enable_if< std::is_integral< T >::value, bool >::type | checkLabelSize () const |
| template<class T = scalar> | |
| std::enable_if< std::is_floating_point< T >::value, bool >::type | checkScalarSize () const |
| label | lineNumber () const |
| Const access to the current stream line number. More... | |
| label & | lineNumber () |
| Non-const access to the current stream line number. More... | |
| label | lineNumber (const label num) |
| 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 f) |
| Unset flags of stream. More... | |
| void | print (Ostream &os, const int streamState) const |
| Print information about the stream state bits. More... | |
| InfoProxy< IOstream > | info () const |
| Return info proxy. More... | |
| Public Member Functions inherited from IOstreamOption | |
| IOstreamOption () noexcept | |
| Construct null. (default: ASCII, uncompressed, currentVersion) More... | |
| IOstreamOption (streamFormat format) noexcept | |
| Construct with format. (default: uncompressed, currentVersion) More... | |
| IOstreamOption (streamFormat format, compressionType compression, versionNumber version=currentVersion) noexcept | |
| Construct with format and compression, optionally with version. More... | |
| IOstreamOption (streamFormat format, versionNumber version, compressionType compression) noexcept | |
| Construct with format, version, compression. More... | |
| streamFormat | format () const noexcept |
| Get the current stream format. More... | |
| streamFormat | format (const streamFormat format) 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 &compressionName) |
| Set the stream compression, from string value. More... | |
| versionNumber | version () const noexcept |
| Get the stream version. More... | |
| versionNumber | version (const versionNumber verNum) noexcept |
| Set the stream version. 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, BINARY } |
| Data format (ascii | binary) More... | |
| enum | compressionType : char { UNCOMPRESSED = 0, COMPRESSED } |
| Compression treatment (UNCOMPRESSED | COMPRESSED) More... | |
| Static Public Member Functions inherited from IOstream | |
| static unsigned int | defaultPrecision () |
| Return the default precision. More... | |
| static unsigned int | defaultPrecision (unsigned int prec) |
| Reset the default precision. More... | |
| Static Public Member Functions inherited from IOstreamOption | |
| static streamFormat | formatEnum (const word &formatName) |
| The stream format enum corresponding to the string. More... | |
| static compressionType | compressionEnum (const word &compName) |
| The compression enum corresponding to the string. More... | |
| Static Public Attributes inherited from IOstream | |
| static unsigned int | precision_ |
| Default precision. More... | |
| Static Public Attributes inherited from IOstreamOption | |
| static const Enum< streamFormat > | formatNames |
| Stream format names (ascii, binary) More... | |
| static const versionNumber | originalVersion |
| The original version number. More... | |
| static const versionNumber | currentVersion |
| The current version number. More... | |
| Protected Member Functions inherited from OFstreamAllocator | |
| OFstreamAllocator (const fileName &pathname, IOstream::compressionType compression=IOstream::UNCOMPRESSED, const bool append=false) | |
| Construct from pathname. More... | |
| ~OFstreamAllocator () | |
| Destructor. More... | |
| void | deallocate () |
| Delete the stream pointer. 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 OFstreamAllocator | |
| std::ostream * | allocatedPtr_ |
| The allocated stream pointer (ofstream or ogzstream). More... | |
| Protected Attributes inherited from Ostream | |
| unsigned short | indentSize_ = 4 |
| Number of spaces per indent level. More... | |
| unsigned short | indentLevel_ = 0 |
| Current indent level. More... | |
| Protected Attributes inherited from IOstream | |
| streamAccess | openClosed_ |
| ios_base::iostate | ioState_ |
| unsigned short | labelByteSize_ |
| The label byte-size (could also be stored as byte) More... | |
| unsigned short | scalarByteSize_ |
| The scalar byte-size (could also be stored as byte) More... | |
| label | lineNumber_ |
| The file line. More... | |
| Static Protected Attributes inherited from Ostream | |
| 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... | |
| OFstream | ( | const fileName & | pathname, |
| streamFormat | format = ASCII, |
||
| versionNumber | version = currentVersion, |
||
| compressionType | compression = UNCOMPRESSED, |
||
| const bool | append = false |
||
| ) |
Construct from pathname.
Definition at line 124 of file OFstream.C.
References Foam::expressions::patchExpr::debug, Foam::endl(), InfoInFunction, and Foam::nl.
|
default |
Destructor.
| ClassName | ( | "OFstream" | ) |
|
virtual |
Access to underlying std::ostream.
Reimplemented from OSstream.
Definition at line 167 of file OFstream.C.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
Referenced by lumpedPointMovement::writeForcesAndMomentsVTP(), lumpedPointState::writeVTP(), lumpedPointMovement::writeVTP(), and lumpedPointMovement::writeZonesVTP().
|
virtual |
Const access to underlying std::ostream.
Reimplemented from OSstream.
Definition at line 178 of file OFstream.C.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
|
virtual |
Print description of IOstream to Ostream.
Reimplemented from OSstream.
Definition at line 189 of file OFstream.C.
References OSstream::print().
|
inline |
Read/write access to the name of the stream.
Definition at line 91 of file OSstream.H.
Referenced by polyDualMesh::calcFeatures(), processorPolyPatch::calcGeometry(), cyclicPolyPatch::coupledEdges(), cyclicPolyPatch::coupledPoints(), distributedTriSurfaceMesh::distribute(), meshRefinement::dumpIntersections(), processorPolyPatch::initOrder(), processorPolyPatch::order(), OBJsurfaceFormat< Face >::write(), OBJedgeFormat::write(), NASsurfaceFormat< Face >::write(), STARCDMeshWriter::write(), nastranWriter::write(), graph::write(), ensightWriter::writeCollated(), surfaceFeatures::writeObj(), extendedEdgeMesh::writeObj(), nastranWriter::writeTemplate(), and ensightWriter::writeUncollated().
|
inline |
Read/write access to the name of the stream.
Definition at line 98 of file OSstream.H.
1.8.17 