Inheritance diagram for CompactIOListBase< Container, IOContainer, CompactIOContainer, Type >:

[legend]

Collaboration diagram for CompactIOListBase< Container, IOContainer, CompactIOContainer, Type >:

Public Member Functions
	CompactIOListBase (const IOobject &)
	Construct from IOobject. More...

	CompactIOListBase (const IOobject &, const bool read)
	Construct from IOobject; does local processor require reading? More...

	CompactIOListBase (const IOobject &, const label)
	Construct from IOobject and size of CompactIOListBase. More...

	CompactIOListBase (const IOobject &, const Container< Type > &)
	Construct from IOobject and a Container. More...

	CompactIOListBase (const IOobject &, Container< Type > &&)
	Move construct by transferring the Container contents. More...

	CompactIOListBase (CompactIOListBase< Container, IOContainer, CompactIOContainer, Type > &&)
	Move constructor. More...

virtual	~CompactIOListBase ()
	Destructor. More...

virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
	WriteObject function. Changes the write type depending on whether. More...

virtual bool	writeData (Ostream &) const
	WriteData function required for regIOobject write operation. More...

void	operator= (const CompactIOListBase< Container, IOContainer, CompactIOContainer, Type > &)
	Assign to another CompactIOList. More...

void	operator= (CompactIOListBase< Container, IOContainer, CompactIOContainer, Type > &&)
	Move-assign to another CompactIOList. More...

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

	regIOobject (const regIOobject &)
	Copy constructor. More...

	regIOobject (regIOobject &&)
	Move constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy constructor with new name, transferring registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Copy constructor with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

virtual bool	global () const
	Return true if object is global, i.e. same for all processors. More...

virtual bool	globalFile () const
	Return true if object is global, i.e. same for all processors. More...

const fileName &	caseName () const

fileName	path () const
	Return complete path. More...

fileName	objectPath () const
	Return complete path + object name. More...

fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	registered () const
	Is this object registered with the registry? More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

void	store ()
	Transfer ownership of this object to its registry. More...

void	release ()
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set up to date (obviously) More...

virtual void	rename (const word &newName)
	Rename. More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool read=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

virtual bool	read ()
	Read object. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

virtual bool	dependenciesModified () const
	Return true if the object's dependencies have been modified. More...

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	write (const bool write=true) const
	Write using setting from DB. More...

void	operator= (const IOobject &)=delete
	Assign to IOobject. More...

void	operator= (const regIOobject &)=delete
	Disallow default assignment. More...

const fileName &	caseName (const bool global) const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	filePath (const bool global) const
	Return complete path + object name if the file exists. More...

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Runtime type information. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Construct from copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct from copy resetting name. More...

	IOobject (const IOobject &io)=default
	Copy constructor. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

word &	headerClassName ()
	Return name of the class name read from header. More...

string &	note ()
	Return non-constant access to the optional note. More...

const string &	note () const
	Return the optional note. More...

bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...

bool	registerObject () const
	Register object created from this IOobject with registry if true. More...

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const

const fileName &	caseName (const bool global) const

fileName &	instance () const
	Return the instance directory, constant, system, <time> etc. More...

void	updateInstance () const
	If the instance is a time directory update to the current time. More...

void	updateTimeInstance () const
	Update instance to the current time. More...

const fileName &	local () const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	relativePath () const
	Return the path relative to the case directory. More...

fileName	relativeObjectPath () const
	Return complete relativePath + object name. More...

fileName	filePath (const bool global) const
	Return complete path + object name if the file exists. More...

bool	readHeader (Istream &)
	Read header. More...

bool	headerOk ()
	Read header of local object without type-checking. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &) const
	Write header. More...

bool	writeHeader (Ostream &, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

Friends
void	writeEntry (Ostream &, const CompactIOListBase< Container, IOContainer, CompactIOContainer, Type > &)
	Write list to Ostream. More...

Istream &	operator>> (Istream &, CompactIOListBase< Container, IOContainer, CompactIOContainer, Type > &)
	Read list from Istream. More...

Ostream &	operator (Ostream &, const CompactIOListBase< Container, IOContainer, CompactIOContainer, Type > &)

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption { MUST_READ , MUST_READ_IF_MODIFIED , READ_IF_PRESENT , NO_READ }
	Enumeration defining the read options. More...

enum	writeOption { AUTO_WRITE = 0 , NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes { timeStamp , timeStampMaster , inotify , inotifyMaster }
	Enumeration defining the file checking options. More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class Name >
static word	groupName (Name name, const word &group)

static word	group (const word &name)
	Return group (extension part of name) More...

static word	member (const word &name)
	Return member (name without the extension) More...

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
	Read header, check readOpt flags and read data if necessary. More...

Protected Member Functions inherited from IOobject
template<class Type >
bool	typeHeaderOk (const bool checkType)
	Read header using typeGlobalFile to find file. More...

Detailed Description

template<template< class > class Container, template< class > class IOContainer, template< class > class CompactIOContainer, class Type>
class Foam::CompactIOListBase< Container, IOContainer, CompactIOContainer, Type >

Definition at line 110 of file CompactIOList.H.

Constructor & Destructor Documentation

◆ CompactIOListBase() [1/6]

CompactIOListBase ( const IOobject & io )

Construct from IOobject.

Definition at line 192 of file CompactIOList.C.

◆ CompactIOListBase() [2/6]

CompactIOListBase	(	const IOobject &	io,
		const bool	read
	)

Construct from IOobject; does local processor require reading?

Definition at line 215 of file CompactIOList.C.

References regIOobject::headerOk(), IOobject::MUST_READ, regIOobject::read(), IOobject::READ_IF_PRESENT, and IOobject::readOpt().

Here is the call graph for this function:

◆ CompactIOListBase() [3/6]

CompactIOListBase	(	const IOobject &	io,
		const label	size
	)

Construct from IOobject and size of CompactIOListBase.

Definition at line 243 of file CompactIOList.C.

References regIOobject::headerOk(), IOobject::MUST_READ, IOobject::READ_IF_PRESENT, IOobject::readOpt(), and setSize().

Here is the call graph for this function:

◆ CompactIOListBase() [4/6]

CompactIOListBase	(	const IOobject &	io,
		const Container< Type > &	l
	)

Construct from IOobject and a Container.

Definition at line 274 of file CompactIOList.C.

References regIOobject::headerOk(), IOobject::MUST_READ, IOobject::READ_IF_PRESENT, and IOobject::readOpt().

Here is the call graph for this function:

◆ CompactIOListBase() [5/6]

CompactIOListBase	(	const IOobject &	io,
		Container< Type > &&	l
	)

Move construct by transferring the Container contents.

Definition at line 302 of file CompactIOList.C.

References regIOobject::headerOk(), IOobject::MUST_READ, IOobject::READ_IF_PRESENT, and IOobject::readOpt().

Here is the call graph for this function:

◆ CompactIOListBase() [6/6]

CompactIOListBase ( CompactIOListBase< Container, IOContainer, CompactIOContainer, Type > && l )

Move constructor.

Definition at line 330 of file CompactIOList.C.

◆ ~CompactIOListBase()

~CompactIOListBase

virtual

Destructor.

Definition at line 350 of file CompactIOList.C.

Member Function Documentation

◆ writeObject()

bool writeObject	(	IOstream::streamFormat	fmt,
		IOstream::versionNumber	ver,
		IOstream::compressionType	cmp,
		const bool	write
	)		const

virtual

WriteObject function. Changes the write type depending on whether.

the output is compact or not.

Reimplemented from regIOobject.

Definition at line 365 of file CompactIOList.C.

References IOstream::ASCII, Foam::endl(), WarningInFunction, Foam::vtkWriteOps::write(), and regIOobject::writeObject().

Here is the call graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

WriteData function required for regIOobject write operation.

Implements regIOobject.

Definition at line 424 of file CompactIOList.C.

◆ operator=() [1/2]

void operator= ( const CompactIOListBase< Container, IOContainer, CompactIOContainer, Type > & rhs )

Assign to another CompactIOList.

Definition at line 441 of file CompactIOList.C.

◆ operator=() [2/2]

void operator= ( CompactIOListBase< Container, IOContainer, CompactIOContainer, Type > && rhs )

Move-assign to another CompactIOList.

Definition at line 460 of file CompactIOList.C.

Friends And Related Function Documentation

◆ writeEntry

void writeEntry	(	Ostream &	,
		const CompactIOListBase< Container, IOContainer, CompactIOContainer, Type > &
	)

friend

Write list to Ostream.

◆ operator>>

Istream& operator>>	(	Istream &	,
		CompactIOListBase< Container, IOContainer, CompactIOContainer, Type > &
	)

friend

Read list from Istream.

◆ operator

Ostream& operator	(	Ostream &	,
		const CompactIOListBase< Container, IOContainer, CompactIOContainer, Type > &
	)

friend

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

src/OpenFOAM/db/IOobjects/CompactIOList/CompactIOList.H
src/OpenFOAM/db/IOobjects/CompactIOList/CompactIOList.C

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

template<template< class > class Container, template< class > class IOContainer, template< class > class CompactIOContainer, class Type> class Foam::CompactIOListBase< Container, IOContainer, CompactIOContainer, Type >

Constructor & Destructor Documentation

◆ CompactIOListBase() [1/6]

◆ CompactIOListBase() [2/6]

◆ CompactIOListBase() [3/6]

◆ CompactIOListBase() [4/6]

◆ CompactIOListBase() [5/6]

◆ CompactIOListBase() [6/6]

◆ ~CompactIOListBase()

Member Function Documentation

◆ writeObject()

◆ writeData()

◆ operator=() [1/2]

◆ operator=() [2/2]

Friends And Related Function Documentation

◆ writeEntry

◆ operator>>

◆ operator

template<template< class > class Container, template< class > class IOContainer, template< class > class CompactIOContainer, class Type>
class Foam::CompactIOListBase< Container, IOContainer, CompactIOContainer, Type >