A simple container for options an IOstream can normally have. More...
Classes | |
class | versionNumber |
Representation of a major/minor version number. More... | |
Public Types | |
enum | streamFormat : char { ASCII = 0, BINARY } |
Data format (ascii | binary) More... | |
enum | compressionType : char { UNCOMPRESSED = 0, COMPRESSED } |
Compression treatment (UNCOMPRESSED | COMPRESSED) More... | |
enum | appendType : char { NO_APPEND = 0, APPEND_APP, APPEND_ATE, NON_APPEND = NO_APPEND, APPEND = APPEND_APP } |
File appending (NO_APPEND | APPEND_APP | APPEND_ATE) More... | |
enum | atomicType : char { NON_ATOMIC = 0, ATOMIC } |
Atomic operations (output) More... | |
enum | floatFormat : unsigned { general = unsigned(0), fixed = unsigned(std::ios_base::fixed), scientific = unsigned(std::ios_base::scientific) } |
Float formats (eg, time directory name formats) More... | |
Public Member Functions | |
constexpr | IOstreamOption (streamFormat fmt=streamFormat::ASCII, compressionType comp=compressionType::UNCOMPRESSED) noexcept |
Default construct (ASCII, UNCOMPRESSED, currentVersion) or construct with format, compression. More... | |
constexpr | IOstreamOption (streamFormat fmt, compressionType comp, versionNumber ver) noexcept |
Construct from components (format, compression, version) More... | |
constexpr | IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept |
Construct from components (format, version, compression) More... | |
IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept | |
Copy construct with change of format. More... | |
streamFormat | format () const noexcept |
Get the current stream format. More... | |
streamFormat | format (const streamFormat fmt) 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 &compName) |
Set the stream compression from string value. More... | |
versionNumber | version () const noexcept |
Get the stream version. More... | |
versionNumber | version (const versionNumber ver) noexcept |
Set the stream version. More... | |
versionNumber | version (const token &tok) |
Set the stream version from token. More... | |
Static Public Member Functions | |
static floatFormat | floatFormatEnum (const word &fmtName, const floatFormat deflt=floatFormat::general) |
Lookup floatFormat enum corresponding to the string (general | fixed | scientific). More... | |
static floatFormat | floatFormatEnum (const word &key, const dictionary &dict, const floatFormat deflt=floatFormat::general) |
getOrDefault floatFormat from dictionary, warn only on bad enumeration. More... | |
static streamFormat | formatEnum (const word &fmtName, const streamFormat deflt=streamFormat::ASCII) |
Lookup streamFormat enum corresponding to the string (ascii | binary). More... | |
static streamFormat | formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII) |
getOrDefault streamFormat from dictionary, warn only on bad enumeration. More... | |
static compressionType | compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED) |
The compression enum corresponding to the string. More... | |
static compressionType | compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED) |
getOrDefault compressionType from dictionary, warn only on bad enumeration. More... | |
Static Public Attributes | |
static const Enum< floatFormat > | floatFormatNames |
Names for float formats (general, fixed, scientific) More... | |
static const Enum< streamFormat > | formatNames |
Stream format names (ascii, binary) More... | |
static const versionNumber | currentVersion |
The current version number (2.0) More... | |
A simple container for options an IOstream can normally have.
The format (ASCII | BINARY) is typically controlled by enumerated names (ascii, binary).
The compression (UNCOMPRESSED | COMPRESSED) is typically controlled by switch values (true/false, on/off, ...).
Definition at line 59 of file IOstreamOption.H.
enum streamFormat : char |
Data format (ascii | binary)
Enumerator | |
---|---|
ASCII | "ascii" (normal default) |
BINARY | "binary" |
Definition at line 68 of file IOstreamOption.H.
enum compressionType : char |
Compression treatment (UNCOMPRESSED | COMPRESSED)
Enumerator | |
---|---|
UNCOMPRESSED | compression = false |
COMPRESSED | compression = true |
Definition at line 77 of file IOstreamOption.H.
enum appendType : char |
File appending (NO_APPEND | APPEND_APP | APPEND_ATE)
Enumerator | |
---|---|
NO_APPEND | no append (truncates existing) |
APPEND_APP | append (seek end each write) |
APPEND_ATE | append (seek end after open) |
NON_APPEND | old name for NO_APPEND |
APPEND | old name for APPEND_APP |
Definition at line 86 of file IOstreamOption.H.
enum atomicType : char |
Atomic operations (output)
Enumerator | |
---|---|
NON_ATOMIC | atomic = false |
ATOMIC | atomic = true |
Definition at line 98 of file IOstreamOption.H.
|
strong |
Float formats (eg, time directory name formats)
Enumerator | |
---|---|
general | default float notation |
fixed | fixed-point notation |
scientific | scientific notation |
Definition at line 107 of file IOstreamOption.H.
|
inlinenoexcept |
Default construct (ASCII, UNCOMPRESSED, currentVersion) or construct with format, compression.
Definition at line 354 of file IOstreamOption.H.
Referenced by threadedCollatedOFstream::~threadedCollatedOFstream().
|
inlinenoexcept |
Construct from components (format, compression, version)
Definition at line 368 of file IOstreamOption.H.
|
inlinenoexcept |
Construct from components (format, version, compression)
Definition at line 383 of file IOstreamOption.H.
|
inlinenoexcept |
Copy construct with change of format.
Definition at line 397 of file IOstreamOption.H.
|
static |
Lookup floatFormat enum corresponding to the string (general | fixed | scientific).
If the string is not recognized, emit warning and return default. Silent if the string itself is empty.
Definition at line 57 of file IOstreamOption.C.
References Foam::nl, and WarningInFunction.
Referenced by Time::readDict(), and ensightCase::options::timeFormat().
|
static |
getOrDefault floatFormat from dictionary, warn only on bad enumeration.
key | Lookup key. Uses LITERAL (not REGEX) |
dict | dictionary |
Definition at line 96 of file IOstreamOption.C.
References dict, and Foam::glTF::key().
|
static |
Lookup streamFormat enum corresponding to the string (ascii | binary).
If the string is not recognized, emit warning and return default. Silent if the string itself is empty.
Definition at line 108 of file IOstreamOption.C.
References Foam::nl, and WarningInFunction.
Referenced by IOstreamOption::format(), vtkCloud::read(), vtkWrite::read(), and vtkWriter::vtkWriter().
|
static |
getOrDefault streamFormat from dictionary, warn only on bad enumeration.
key | Lookup key. Uses LITERAL (not REGEX) |
dict | dictionary |
Definition at line 147 of file IOstreamOption.C.
References dict, and Foam::glTF::key().
|
static |
The compression enum corresponding to the string.
Expects switch values (true/false, on/off, ...)
If the string is not recognized, emit warning and return default. Silent if the string itself is empty.
Definition at line 159 of file IOstreamOption.C.
References Foam::ListOps::find(), Switch::good(), Foam::nl, and WarningInFunction.
Referenced by IOstreamOption::compression().
|
static |
getOrDefault compressionType from dictionary, warn only on bad enumeration.
key | Lookup key. Uses LITERAL (not REGEX) |
dict | dictionary |
Definition at line 193 of file IOstreamOption.C.
References dict, and Foam::glTF::key().
|
inlinenoexcept |
Get the current stream format.
Definition at line 410 of file IOstreamOption.H.
Referenced by CollidingParcel< ParcelType >::CollidingParcel(), ensightReadFile::detectBinaryHeader(), DSMCParcel< ParcelType >::DSMCParcel(), codeStream::evaluate(), findCellParticle::findCellParticle(), FIRECore::getFireLabel(), FIRECore::getFirePoint(), FIRECore::getFireString(), decomposedBlockData::getNumBlocks(), Foam::getPrimitive(), ensightReadFile::getTimeStepFooter(), injectedParticle::injectedParticle(), KinematicParcel< ParcelType >::KinematicParcel(), molecule::molecule(), MPPICParcel< ParcelType >::MPPICParcel(), Foam::operator<<(), Foam::operator>>(), IOobject::parseHeader(), Foam::printMaps(), Foam::processFlags(), Foam::putPrimitive(), ReactingParcel< ParcelType >::ReactingParcel(), decomposedBlockData::readBlock(), exprResultGlobals::readData(), particle< Type >::readData(), Time::readDict(), Foam::readEnsightString(), ensightSurfaceReader::readGeometry(), IOobject::readHeader(), List< Field< scalar > >::readList(), DynamicList< Foam::vector >::readList(), PackedList< 2 >::readList(), FixedList< point, 2 >::readList(), UList< Foam::vector >::readList(), Matrix< RectangularMatrix< Type >, Type >::readMatrix(), Foam::setformat(), decomposedBlockData::skipBlockEntry(), solidParticle::solidParticle(), SprayParcel< ParcelType >::SprayParcel(), ThermoParcel< ParcelType >::ThermoParcel(), trackedParticle::trackedParticle(), wallBoundedParticle::wallBoundedParticle(), OBJsurfaceFormat< Face >::write(), X3DsurfaceFormat< Face >::write(), SMESHsurfaceFormat< Face >::write(), OBJedgeFormat::write(), OFFsurfaceFormat< Face >::write(), AC3DsurfaceFormat< Face >::write(), GTSsurfaceFormat< Face >::write(), TRIsurfaceFormat< Face >::write(), STARCDsurfaceFormat< Face >::write(), ABAQUSsurfaceFormat< Face >::write(), NASsurfaceFormat< Face >::write(), STARCDedgeFormat::write(), FIREMeshWriter::write(), csvTableReader< Type >::write(), STLsurfaceFormat< Face >::write(), dimensionSet::write(), decomposedBlockData::writeData(), decomposedBlockData::writeExtraHeaderContent(), decomposedBlockData::writeHeader(), IOobject::writeHeaderContent(), Foam::writeMaps(), CompactListList< T >::writeMatrix(), CompactIOField< T, BaseType >::writeObject(), CompactIOList< face, label >::writeObject(), rigidBodyMeshMotionSolver::writeObject(), rigidBodyMeshMotion::writeObject(), distributedTriSurfaceMesh::writeObject(), injectedParticle::writePosition(), and particle< Type >::writePosition().
|
inlinenoexcept |
|
inline |
Set the stream format from string value.
If the string is not recognized, emit warning and leave unchanged. Silent if the string itself is empty.
Definition at line 431 of file IOstreamOption.H.
References IOstreamOption::formatEnum().
|
inlinenoexcept |
Get the stream compression.
Definition at line 441 of file IOstreamOption.H.
Referenced by IFstream::IFstream(), ofstreamPointer::ofstreamPointer(), masterUncollatedFileOperation::readAndSend(), IFstream::readContents(), Time::readDict(), FIREMeshWriter::write(), STLsurfaceFormat< Face >::write(), faBoundaryMeshEntries::writeObject(), polyBoundaryMeshEntries::writeObject(), faBoundaryMesh::writeObject(), and polyBoundaryMesh::writeObject().
|
inlinenoexcept |
Set the stream compression.
Definition at line 448 of file IOstreamOption.H.
|
inline |
Set the stream compression from string value.
If the string is not recognized, emit warning and leave unchanged. Silent if the string itself is empty.
Definition at line 462 of file IOstreamOption.H.
References IOstreamOption::compressionEnum().
|
inlinenoexcept |
Get the stream version.
Definition at line 472 of file IOstreamOption.H.
Referenced by collatedFileOperation::appendObject(), decomposedBlockData::getNumBlocks(), IOobject::parseHeader(), decomposedBlockData::readBlock(), Time::readDict(), IOobject::readHeader(), Foam::setversion(), decomposedBlockData::writeData(), IOobject::writeHeaderContent(), and threadedCollatedOFstream::~threadedCollatedOFstream().
|
inlinenoexcept |
|
inline |
Set the stream version from token.
Definition at line 491 of file IOstreamOption.H.
|
static |
Names for float formats (general, fixed, scientific)
Definition at line 223 of file IOstreamOption.H.
|
static |
Stream format names (ascii, binary)
Definition at line 228 of file IOstreamOption.H.
Referenced by Foam::operator<<(), ensightSurfaceReader::readGeometry(), exprResult::writeDict(), exprResult::writeField(), and exprResult::writeValue().
|
static |
The current version number (2.0)
Definition at line 233 of file IOstreamOption.H.