A simple container of IOobject preferences. Can also be used for general handling of read/no-read/read-if-present logic outside of an IOobject. More...
Public Types | |
enum | readOption : unsigned char { NO_READ = 0, MUST_READ = 0x1, READ_MODIFIED = 0x3, MUST_READ_IF_MODIFIED = 0x3, LAZY_READ = 0x4, READ_IF_PRESENT = 0x4 } |
Enumeration defining read preferences. More... | |
enum | writeOption : unsigned char { NO_WRITE = 0, AUTO_WRITE = 0x10 } |
Enumeration defining write preferences. More... | |
enum | registerOption : unsigned char { NO_REGISTER = 0, REGISTER = 1, LEGACY_REGISTER = 2 } |
Enumeration for use with registerObject(). Values map to bool (false/true) More... | |
Public Member Functions | |
constexpr | IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options. More... | |
constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_WRITE with specified read/register options. More... | |
constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_READ with specified write/register options. More... | |
constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option. More... | |
constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
Construct from components with specified register option as bool. More... | |
constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option as bool. More... | |
readOption | readOpt () const noexcept |
Get the read option. More... | |
readOption | readOpt (readOption opt) noexcept |
Set the read option. More... | |
writeOption | writeOpt () const noexcept |
Get the write option. More... | |
writeOption | writeOpt (writeOption opt) noexcept |
Set the write option. More... | |
bool | registerObject () const noexcept |
Should objects created with this IOobject be registered? More... | |
bool | registerObject (bool on) noexcept |
Change registration preference. More... | |
bool | globalObject () const noexcept |
True if object is treated the same for all processors. More... | |
bool | globalObject (bool on) noexcept |
Change global-object status. More... | |
bool | isAnyRead () const noexcept |
True if any reading may be required (ie, != NO_READ) More... | |
bool | isReadRequired () const noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
bool | isReadOptional () const noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
readOption & | readOpt () noexcept |
Access to the read option. More... | |
writeOption & | writeOpt () noexcept |
Access to the write option. More... | |
bool & | registerObject () noexcept |
Access to the register object option. More... | |
bool & | globalObject () noexcept |
Access to the global object option. More... | |
Static Public Member Functions | |
static bool | isAnyRead (readOption opt) noexcept |
True if any reading may be required (ie, != NO_READ) More... | |
static bool | isReadRequired (readOption opt) noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
static bool | isReadOptional (readOption opt) noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
static readOption | lazierRead (readOption opt) noexcept |
Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. More... | |
A simple container of IOobject preferences. Can also be used for general handling of read/no-read/read-if-present logic outside of an IOobject.
Definition at line 45 of file IOobjectOption.H.
enum readOption : unsigned char |
Enumeration defining read preferences.
Lowest bit encodes 'must read'. Possible (future) named variants (none | normal | modified | lazy)
Definition at line 57 of file IOobjectOption.H.
enum writeOption : unsigned char |
Enumeration defining write preferences.
Enumerator | |
---|---|
NO_WRITE | Ignore writing from objectRegistry::writeObject() |
AUTO_WRITE | Automatically write from objectRegistry::writeObject() |
Definition at line 83 of file IOobjectOption.H.
enum registerOption : unsigned char |
Enumeration for use with registerObject(). Values map to bool (false/true)
Enumerator | |
---|---|
NO_REGISTER | Do not request registration (bool: false) |
REGISTER | Request registration (bool: true) |
LEGACY_REGISTER | Legacy/default registration request (bool: true) |
Definition at line 96 of file IOobjectOption.H.
|
inlinenoexcept |
Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options.
Definition at line 143 of file IOobjectOption.H.
|
inlinenoexcept |
Construct NO_WRITE with specified read/register options.
Definition at line 160 of file IOobjectOption.H.
|
inlinenoexcept |
Construct NO_READ with specified write/register options.
Definition at line 176 of file IOobjectOption.H.
|
inlinenoexcept |
Construct (NO_READ, NO_WRITE) with specified register option.
Definition at line 192 of file IOobjectOption.H.
|
inlinenoexcept |
Construct from components with specified register option as bool.
Definition at line 208 of file IOobjectOption.H.
|
inlineexplicitnoexcept |
Construct (NO_READ, NO_WRITE) with specified register option as bool.
Definition at line 226 of file IOobjectOption.H.
|
inlinenoexcept |
Get the read option.
Definition at line 243 of file IOobjectOption.H.
Referenced by unwatchedIOdictionary::addWatch(), columnFvMesh::columnFvMesh(), topoSet::findIOobject(), hexRef8::hexRef8(), voxelMeshSearch::makeMesh(), faMeshTools::newMesh(), fvMeshTools::newMesh(), IOobject::operator=(), radiativeIntensityRay::radiativeIntensityRay(), localIOdictionary::readContents(), IOdictionary::readContents(), IOPtrList< Foam::entry >::readContents(), IOMap< T >::readContents(), IOList< labelList >::readContents(), rawIOField< Type >::readContents(), IOField< Type >::readContents(), codedPoints0MotionSolver::redirectMotionSolver(), hexRef8Data::sync(), and Time::Time().
|
inlinenoexcept |
|
inlinenoexcept |
Get the write option.
Definition at line 258 of file IOobjectOption.H.
Referenced by cellTable::addCellZones(), PDRblock::innerMesh(), faMeshTools::newMesh(), fvMeshTools::newMesh(), IOobject::operator=(), faMesh::S00(), surfMesh::setWriteOption(), fvMesh::V00(), writeObjects::write(), and objectRegistry::writeObject().
|
inlinenoexcept |
|
inlinenoexcept |
Should objects created with this IOobject be registered?
Definition at line 273 of file IOobjectOption.H.
Referenced by Foam::loadPointField(), faMeshTools::newMesh(), fvMeshTools::newMesh(), regIOobject::operator=(), regIOobject::regIOobject(), regIOobject::rename(), and blockMesh::topology().
|
inlinenoexcept |
Change registration preference.
Definition at line 278 of file IOobjectOption.H.
|
inlinenoexcept |
True if object is treated the same for all processors.
Definition at line 288 of file IOobjectOption.H.
Referenced by IOobject::operator=().
|
inlinenoexcept |
|
inlinestaticnoexcept |
True if any reading may be required (ie, != NO_READ)
Definition at line 306 of file IOobjectOption.H.
Referenced by refinementHistory::refinementHistory(), and triSurfaceMesh::triSurfaceMesh().
|
inlinenoexcept |
True if any reading may be required (ie, != NO_READ)
Definition at line 314 of file IOobjectOption.H.
|
inlinestaticnoexcept |
True if (MUST_READ | READ_MODIFIED) bits are set.
Definition at line 322 of file IOobjectOption.H.
Referenced by masterUncollatedFileOperation::findInstance(), and fileOperation::findInstance().
|
inlinenoexcept |
True if (MUST_READ | READ_MODIFIED) bits are set.
Definition at line 330 of file IOobjectOption.H.
Referenced by cellZoneSet::cellZoneSet(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), faBoundaryMeshEntries::faBoundaryMeshEntries(), faceZoneSet::faceZoneSet(), featureEdgeMesh::featureEdgeMesh(), IOField< Type >::IOField(), pointZoneSet::pointZoneSet(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), dictionary::readCheck(), dictionary::readCompat(), dimensionSet::readEntry(), dictionary::readEntry(), regionProperties::regionProperties(), and topoSet::topoSet().
|
inlinestaticnoexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
Definition at line 338 of file IOobjectOption.H.
|
inlinenoexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
Definition at line 346 of file IOobjectOption.H.
Referenced by cellZoneSet::cellZoneSet(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), faBoundaryMeshEntries::faBoundaryMeshEntries(), faceZoneSet::faceZoneSet(), featureEdgeMesh::featureEdgeMesh(), IOField< Type >::IOField(), pointZoneSet::pointZoneSet(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), and topoSet::topoSet().
|
inlinestaticnoexcept |
Downgrade readOption optional (LAZY_READ), leaves NO_READ intact.
Definition at line 354 of file IOobjectOption.H.
Referenced by coordinateSystem::coordinateSystem().
|
inlinenoexcept |
Access to the read option.
Definition at line 367 of file IOobjectOption.H.
|
inlinenoexcept |
Access to the write option.
Definition at line 374 of file IOobjectOption.H.
|
inlinenoexcept |
Access to the register object option.
Definition at line 381 of file IOobjectOption.H.
|
inlinenoexcept |
Access to the global object option.
Definition at line 388 of file IOobjectOption.H.