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...

Inheritance diagram for IOobjectOption:

[legend]

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...

enum	Layout : unsigned char { regular, global }
	The layout of the case structure. 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...

Detailed Description

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.

See also: Foam::IOobject

Definition at line 45 of file IOobjectOption.H.

Member Enumeration Documentation

◆ readOption

enum readOption : unsigned char

Enumeration defining read preferences.

Lowest bit encodes 'must read'. Possible (future) named variants (none | normal | modified | lazy)

Enumerator
NO_READ	Nothing to be read.
MUST_READ	Reading required.
READ_MODIFIED	Reading required, file watched for runTime modification [identical to MUST_READ_IF_MODIFIED]
MUST_READ_IF_MODIFIED	Reading required, file watched for runTime modification [identical to READ_MODIFIED]
LAZY_READ	Reading is optional [identical to READ_IF_PRESENT].
READ_IF_PRESENT	Reading is optional [identical to LAZY_READ].

Definition at line 57 of file IOobjectOption.H.

◆ writeOption

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.

◆ registerOption

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.

◆ Layout

enum Layout : unsigned char

strong

The layout of the case structure.

Enumerator
regular	Regular case layout, eg processor-local locations.
global	Global case layout (serial locations)

Definition at line 111 of file IOobjectOption.H.

Constructor & Destructor Documentation

◆ IOobjectOption() [1/6]

constexpr IOobjectOption	(	readOption	rOpt = `readOption::NO_READ`,
		writeOption	wOpt = `writeOption::NO_WRITE`,
		registerOption	registerObject = `registerOption::REGISTER`,
		bool	globalObject = `false`
	)

inlinenoexcept

Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options.

Definition at line 153 of file IOobjectOption.H.

◆ IOobjectOption() [2/6]

constexpr IOobjectOption	(	readOption	rOpt,
		registerOption	registerObject = `registerOption::REGISTER`,
		bool	globalObject = `false`
	)

inlinenoexcept

Construct NO_WRITE with specified read/register options.

Definition at line 170 of file IOobjectOption.H.

◆ IOobjectOption() [3/6]

constexpr IOobjectOption	(	writeOption	wOpt,
		registerOption	registerObject = `registerOption::REGISTER`,
		bool	globalObject = `false`
	)

inlinenoexcept

Construct NO_READ with specified write/register options.

Definition at line 186 of file IOobjectOption.H.

◆ IOobjectOption() [4/6]

constexpr IOobjectOption	(	registerOption	registerObject,
		bool	globalObject = `false`
	)

inlinenoexcept

Construct (NO_READ, NO_WRITE) with specified register option.

Definition at line 202 of file IOobjectOption.H.

◆ IOobjectOption() [5/6]

constexpr IOobjectOption	(	readOption	rOpt,
		writeOption	wOpt,
		bool	registerObject,
		bool	globalObject = `false`
	)

inlinenoexcept

Construct from components with specified register option as bool.

Definition at line 218 of file IOobjectOption.H.

◆ IOobjectOption() [6/6]

constexpr IOobjectOption	(	bool	registerObject,
		bool	globalObject = `false`
	)

inlineexplicitnoexcept

Construct (NO_READ, NO_WRITE) with specified register option as bool.

Definition at line 236 of file IOobjectOption.H.

Member Function Documentation

◆ readOpt() [1/3]

readOption readOpt ( ) const

inlinenoexcept

Get the read option.

Definition at line 253 of file IOobjectOption.H.

Here is the caller graph for this function:

◆ readOpt() [2/3]

readOption readOpt ( readOption opt )

inlinenoexcept

Set the read option.

Returns: the previous value

Definition at line 258 of file IOobjectOption.H.

◆ writeOpt() [1/3]

writeOption writeOpt ( ) const

inlinenoexcept

Get the write option.

Definition at line 268 of file IOobjectOption.H.

Referenced by cellTable::addCellZones(), PDRblock::innerMesh(), IOobject::IOobject(), fvMeshTools::newMesh(), surfMesh::setWriteOption(), writeObjects::write(), and objectRegistry::writeObject().

Here is the caller graph for this function:

◆ writeOpt() [2/3]

writeOption writeOpt ( writeOption opt )

inlinenoexcept

Set the write option.

Returns: the previous value

Definition at line 273 of file IOobjectOption.H.

◆ registerObject() [1/3]

bool registerObject ( ) const

inlinenoexcept

Should objects created with this IOobject be registered?

Definition at line 283 of file IOobjectOption.H.

Referenced by IOobject::IOobject(), fvMeshTools::newMesh(), regIOobject::operator=(), regIOobject::regIOobject(), regIOobject::rename(), and blockMesh::topology().

Here is the caller graph for this function:

◆ registerObject() [2/3]

bool registerObject ( bool on )

inlinenoexcept

Change registration preference.

Returns: previous value

Definition at line 288 of file IOobjectOption.H.

◆ globalObject() [1/3]

bool globalObject ( ) const

inlinenoexcept

True if object is treated the same for all processors.

Definition at line 298 of file IOobjectOption.H.

Referenced by GlobalIOField< vector >::readContents(), GlobalIOList< kinematicParcelInjectionData >::readContents(), IOdictionary::readContents(), and IOMap< T >::readContents().

Here is the caller graph for this function:

◆ globalObject() [2/3]

bool globalObject ( bool on )

inlinenoexcept

Change global-object status.

Returns: previous value

Definition at line 303 of file IOobjectOption.H.

◆ isAnyRead() [1/2]

static bool isAnyRead ( readOption opt )

inlinestaticnoexcept

True if any reading may be required (ie, != NO_READ)

Definition at line 316 of file IOobjectOption.H.

◆ isAnyRead() [2/2]

bool isAnyRead ( ) const

inlinenoexcept

True if any reading may be required (ie, != NO_READ)

Definition at line 324 of file IOobjectOption.H.

Referenced by cellZoneSet::cellZoneSet(), faceZoneSet::faceZoneSet(), and pointZoneSet::pointZoneSet().

Here is the caller graph for this function:

◆ isReadRequired() [1/2]

static bool isReadRequired ( readOption opt )

inlinestaticnoexcept

True if (MUST_READ | READ_MODIFIED) bits are set.

Definition at line 332 of file IOobjectOption.H.

Referenced by masterUncollatedFileOperation::findInstance(), and fileOperation::findInstance().

Here is the caller graph for this function:

◆ isReadRequired() [2/2]

bool isReadRequired ( ) const

inlinenoexcept

True if (MUST_READ | READ_MODIFIED) bits are set.

Definition at line 340 of file IOobjectOption.H.

Referenced by cellZoneSet::cellZoneSet(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), faBoundaryMeshEntries::faBoundaryMeshEntries(), faceZoneSet::faceZoneSet(), featureEdgeMesh::featureEdgeMesh(), pointZoneSet::pointZoneSet(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), dictionary::readCheck(), dictionary::readCompat(), dimensionSet::readEntry(), and dictionary::readEntry().

Here is the caller graph for this function:

◆ isReadOptional() [1/2]

static bool isReadOptional ( readOption opt )

inlinestaticnoexcept

True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].

Definition at line 348 of file IOobjectOption.H.

◆ isReadOptional() [2/2]

bool isReadOptional ( ) const

inlinenoexcept

True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].

Definition at line 356 of file IOobjectOption.H.

Referenced by extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), faBoundaryMeshEntries::faBoundaryMeshEntries(), featureEdgeMesh::featureEdgeMesh(), and polyBoundaryMeshEntries::polyBoundaryMeshEntries().

Here is the caller graph for this function:

◆ lazierRead()

static readOption lazierRead ( readOption opt )

inlinestaticnoexcept

Downgrade readOption optional (LAZY_READ), leaves NO_READ intact.

Definition at line 364 of file IOobjectOption.H.

Referenced by coordinateSystem::coordinateSystem().

Here is the caller graph for this function:

◆ readOpt() [3/3]

readOption& readOpt ( )

inlinenoexcept

Access to the read option.

Deprecated:: (2021-03) - use readOpt(readOption)

Definition at line 377 of file IOobjectOption.H.

◆ writeOpt() [3/3]

writeOption& writeOpt ( )

inlinenoexcept

Access to the write option.

Deprecated:: (2021-03) - use writeOpt(writeOption)

Definition at line 384 of file IOobjectOption.H.

◆ registerObject() [3/3]

bool& registerObject ( )

inlinenoexcept

Access to the register object option.

Deprecated:: (2021-03) - use registerObject(bool)

Definition at line 391 of file IOobjectOption.H.

◆ globalObject() [3/3]

bool& globalObject ( )

inlinenoexcept

Access to the global object option.

Deprecated:: (2021-03) - use globalObject(bool)

Definition at line 398 of file IOobjectOption.H.

The documentation for this class was generated from the following file:

src/OpenFOAM/db/options/IOobjectOption.H

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ readOption

◆ writeOption

◆ registerOption

◆ Layout

Constructor & Destructor Documentation

◆ IOobjectOption() [1/6]

◆ IOobjectOption() [2/6]

◆ IOobjectOption() [3/6]

◆ IOobjectOption() [4/6]

◆ IOobjectOption() [5/6]

◆ IOobjectOption() [6/6]

Member Function Documentation

◆ readOpt() [1/3]

◆ readOpt() [2/3]

◆ writeOpt() [1/3]

◆ writeOpt() [2/3]

◆ registerObject() [1/3]

◆ registerObject() [2/3]

◆ globalObject() [1/3]

◆ globalObject() [2/3]

◆ isAnyRead() [1/2]

◆ isAnyRead() [2/2]

◆ isReadRequired() [1/2]

◆ isReadRequired() [2/2]

◆ isReadOptional() [1/2]

◆ isReadOptional() [2/2]

◆ lazierRead()

◆ readOpt() [3/3]

◆ writeOpt() [3/3]

◆ registerObject() [3/3]

◆ globalObject() [3/3]