Ensight output with specialized write() for strings, integers and floats. Correctly handles binary write as well. More...
Public Member Functions | |
| ensightFile (const fileName &pathname, IOstream::streamFormat format=IOstream::BINARY) | |
| Construct from pathname. More... | |
| ~ensightFile () | |
| Destructor. More... | |
| virtual Ostream & | write (const char *buf, std::streamsize count) |
| Binary write. More... | |
| virtual Ostream & | writeKeyword (const string &key) |
| Write element keyword with trailing newline, optionally with undef. More... | |
| Ostream & | writeBinaryHeader () |
| Write "C Binary" for binary files (eg, geometry/measured) More... | |
| Ostream & | writeUndef () |
| Write undef value. More... | |
| Ostream & | write (const char *value) |
| Write C-string as "%80s" or as binary. More... | |
| Ostream & | write (const string &value) |
| Write string as "%80s" or as binary. More... | |
| Ostream & | write (const label value) |
| Write integer as "%10d" or as binary. More... | |
| Ostream & | write (const label value, const label fieldWidth) |
| Write integer with specified width or as binary. More... | |
| Ostream & | write (const scalar value) |
| Write float as "%12.5e" or as binary. More... | |
| void | newline () |
| Add carriage return to ascii stream. More... | |
 Public Member Functions inherited from OFstream | |
| ClassName ("OFstream") | |
| OFstream (const fileName &pathname, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED) | |
| Construct from pathname. More... | |
| ~OFstream () | |
| Destructor. More... | |
| const fileName & | name () const |
| Return the name of the stream. More... | |
| fileName & | name () |
| Return non-const access to the name of the stream. More... | |
| virtual ostream & | stdStream () |
| Access to underlying std::ostream. More... | |
| virtual const ostream & | stdStream () const |
| Const access to underlying std::ostream. More... | |
| void | print (Ostream &) const |
| Print description of IOstream to Ostream. More... | |
| Public Member Functions inherited from OSstream | |
| OSstream (ostream &os, const string &name, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED) | |
| Set stream status. 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 word &) |
| Write word. 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 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... | |
| 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... | |
Static Public Member Functions | |
| static bool | allowUndef () |
| Return setting for whether 'undef' values are allowed in results. More... | |
| static string | mask () |
| The '*' mask appropriate for subDir. More... | |
| static string | subDir (const label) |
| Consistent zero-padded numbers for subdirectories. More... | |
| static void | subDirWidth (const label) |
| Set width of subDir and mask. Default width is 8 digits. More... | |
| static label | subDirWidth () |
| Return current width of subDir and mask. More... | |
| static bool | allowUndef (bool) |
| static scalar | undefValue (const scalar) |
| Assign the value to represent undef in the results. 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... | |
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 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... | |
Ensight output with specialized write() for strings, integers and floats. Correctly handles binary write as well.
Definition at line 47 of file ensightFile.H.
| ensightFile | ( | const fileName & | pathname, |
| IOstream::streamFormat | format = IOstream::BINARY |
||
| ) |
Construct from pathname.
Definition at line 85 of file ensightFile.C.
References OSstream::precision(), Foam::scientific(), and IOstream::setf().
| ~ensightFile | ( | ) |
Destructor.
Definition at line 104 of file ensightFile.C.
|
static |
Return setting for whether 'undef' values are allowed in results.
Definition at line 110 of file ensightFile.C.
Referenced by ensightPart::writeScalarField(), and ensightPart::writeVectorField().
|
static |
The '*' mask appropriate for subDir.
Definition at line 43 of file ensightFile.C.
|
static |
Consistent zero-padded numbers for subdirectories.
Definition at line 49 of file ensightFile.C.
References n.
|
static |
Set width of subDir and mask. Default width is 8 digits.
Max width is 31 digits.
Definition at line 58 of file ensightFile.C.
|
static |
Return current width of subDir and mask.
Definition at line 76 of file ensightFile.C.
|
static |
Definition at line 116 of file ensightFile.C.
|
static |
Assign the value to represent undef in the results.
Returns the previous value NB: do not use values larger than floatScalarVGREAT
Definition at line 124 of file ensightFile.C.
References ensightFile::write().
|
virtual |
Binary write.
Reimplemented from OSstream.
Definition at line 136 of file ensightFile.C.
References OFstream::stdStream().
Referenced by ensightFile::undefValue(), ensightFile::write(), ensightFile::writeBinaryHeader(), ensightPartFaces::writeConnectivity(), ensightPart::writeFieldList(), ensightPart::writeGeometry(), ensightPart::writeHeader(), ensightGeoFile::writeKeyword(), ensightFile::writeKeyword(), ensightFile::writeUndef(), and ensightPartCells::~ensightPartCells().
|
virtual |
Write element keyword with trailing newline, optionally with undef.
Reimplemented in ensightGeoFile.
Definition at line 275 of file ensightFile.C.
References ensightFile::newline(), and ensightFile::write().
Referenced by ensightPart::writeField(), ensightPart::writeScalarField(), and ensightPart::writeVectorField().
| Foam::Ostream & writeBinaryHeader | ( | ) |
Write "C Binary" for binary files (eg, geometry/measured)
Definition at line 293 of file ensightFile.C.
References IOstream::BINARY, IOstream::format(), and ensightFile::write().
| Foam::Ostream & writeUndef | ( | ) |
Write undef value.
Definition at line 268 of file ensightFile.C.
References ensightFile::write().
Referenced by ensightPart::writeFieldList().
|
virtual |
Write C-string as "%80s" or as binary.
Reimplemented from OSstream.
Definition at line 146 of file ensightFile.C.
References ensightFile::write().
|
virtual |
Write string as "%80s" or as binary.
Reimplemented from OSstream.
Definition at line 152 of file ensightFile.C.
References IOstream::BINARY, IOstream::format(), n, OFstream::stdStream(), and ensightFile::write().
| Foam::Ostream & write | ( | const label | value | ) |
Write integer as "%10d" or as binary.
Definition at line 189 of file ensightFile.C.
References IOstream::BINARY, IOstream::format(), OFstream::stdStream(), and ensightFile::write().
| Foam::Ostream & write | ( | const label | value, |
| const label | fieldWidth | ||
| ) |
Write integer with specified width or as binary.
Definition at line 212 of file ensightFile.C.
References IOstream::BINARY, IOstream::format(), OFstream::stdStream(), and ensightFile::write().
| Foam::Ostream & write | ( | const scalar | value | ) |
Write float as "%12.5e" or as binary.
Definition at line 237 of file ensightFile.C.
References IOstream::BINARY, IOstream::format(), OFstream::stdStream(), and ensightFile::write().
| void newline | ( | ) |
Add carriage return to ascii stream.
Definition at line 259 of file ensightFile.C.
References IOstream::ASCII, IOstream::format(), Foam::nl, and OFstream::stdStream().
Referenced by ensightPartFaces::writeConnectivity(), ensightPart::writeFieldList(), ensightPart::writeGeometry(), ensightPart::writeHeader(), ensightGeoFile::writeKeyword(), ensightFile::writeKeyword(), and ensightPartCells::~ensightPartCells().
1.8.11
