IOList with global data (so optionally read from master) More...

Inheritance diagram for GlobalIOList< Type >:

[legend]

Collaboration diagram for GlobalIOList< Type >:

Public Member Functions
	TypeName ("List")

	GlobalIOList (const GlobalIOList &)=default

	GlobalIOList (const IOobject &io)

	GlobalIOList (const IOobject &io, const label size)

	GlobalIOList (const IOobject &io, const UList< Type > &content)

	GlobalIOList (const IOobject &io, List< Type > &&content)

virtual	~GlobalIOList ()=default

virtual bool	global () const

virtual fileName	filePath () const

virtual bool	readData (Istream &is)

bool	writeData (Ostream &os) const

void	operator= (const GlobalIOList< Type > &rhs)

const word	typeName ("scalarVectorTable")

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")

	regIOobject (const IOobject &io, const bool isTimeObject=false)

	regIOobject (const regIOobject &rio)

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	regIOobject (const IOobject &io, const regIOobject &rio)

virtual	~regIOobject ()

bool	checkIn ()

bool	checkOut ()

virtual void	addWatch ()

bool	ownedByRegistry () const

bool	store ()

void	release (const bool unregister=false)

label	eventNo () const

label &	eventNo ()

bool	upToDate (const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const

void	setUpToDate ()

virtual void	rename (const word &newName)

const dictionary *	findMetaData () const noexcept

dictionary &	getMetaData () noexcept

void	removeMetaData ()

virtual void	updateMetaData ()

bool	headerOk ()

Istream &	readStream (const word &, const bool valid=true)

void	close ()

virtual bool	read ()

virtual label	addWatch (const fileName &)

const labelList &	watchIndices () const

labelList &	watchIndices ()

virtual bool	modified () const

virtual bool	readIfModified ()

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const

virtual bool	write (const bool valid=true) const

void	operator= (const IOobject &io)

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const

Public Member Functions inherited from IOobject
	TypeName ("IOobject")

	IOobject (const IOobject &)=default

virtual	~IOobject ()=default

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)

	IOobject (const IOobject &io, const objectRegistry &registry)

	IOobject (const IOobject &io, const word &name)

	IOobject (const IOobject &io, readOption, writeOption)

autoPtr< IOobject >	clone () const

autoPtr< IOobject >	clone (const objectRegistry &registry) const

const objectRegistry &	db () const noexcept

const Time &	time () const

const word &	name () const noexcept

const word &	headerClassName () const noexcept

word &	headerClassName () noexcept

const string &	note () const noexcept

string &	note () noexcept

bool	registerObject () const noexcept

bool	registerObject (bool on) noexcept

bool	globalObject () const noexcept

bool	globalObject (bool on) noexcept

unsigned	labelByteSize () const noexcept

unsigned	scalarByteSize () const noexcept

bool	isHeaderClassName (const word &clsName) const

template<class Type >
bool	isHeaderClassName () const

readOption	readOpt () const noexcept

readOption	readOpt (readOption opt) noexcept

writeOption	writeOpt () const noexcept

writeOption	writeOpt (writeOption opt) noexcept

word	group () const

word	member () const

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

fileName	path () const

fileName	path (const word &instance, const fileName &local=fileName::null) const

fileName	objectPath () const

fileName	objectRelPath () const

fileName	localFilePath (const word &typeName, const bool search=true) const

fileName	globalFilePath (const word &typeName, const bool search=true) const

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)

template<class Type >
void	warnNoRereading () const

bool	writeHeader (Ostream &os) const

bool	writeHeader (Ostream &os, const word &objectType) const

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept

bool	bad () const noexcept

InfoProxy< IOobject >	info () const

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept

writeOption &	writeOpt () noexcept

bool &	registerObject () noexcept

bool &	globalObject () noexcept

template<>
bool	isHeaderClassName () const

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

Public Member Functions inherited from List< Type >
constexpr	List () noexcept

	List (const label len)

	List (const label len, const T &val)

	List (const label len, const Foam::zero)

	List (const Foam::one, const T &val)

	List (const Foam::one, T &&val)

	List (const Foam::one, const Foam::zero)

	List (const List< T > &a)

	List (const UList< T > &a)

	List (List< T > &a, bool reuse)

	List (const UList< T > &list, const labelUList &indices)

	List (const UList< T > &list, const FixedList< label, N > &indices)

	List (const FixedList< T, N > &list)

	List (const PtrList< T > &list)

	List (const SLList< T > &list)

	List (const IndirectListBase< T, Addr > &list)

	List (std::initializer_list< T > list)

	List (List< T > &&list)

	List (DynamicList< T, SizeMin > &&list)

	List (SortableList< T > &&list)

	List (SLList< T > &&list)

	List (Istream &is)

	List (const label len)

	List (const label len, const T &val)

	List (const label len, const Foam::zero)

	List (const Foam::one, const T &val)

	List (const Foam::one, T &&val)

	List (const Foam::one, const Foam::zero)

	List (const UList< T > &a)

	List (const List< T > &a)

	List (List< T > &a, bool reuse)

	List (const UList< T > &list, const labelUList &indices)

	List (const PtrList< T > &list)

	List (const SLList< T > &list)

	List (std::initializer_list< T > list)

	List (List< T > &&list)

	List (SortableList< T > &&list)

	List (SLList< T > &&list)

constexpr	List () noexcept

	List (Istream &is)

autoPtr< List< T > >	clone () const

	~List ()

void	clear ()

void	resize (const label len)

void	resize (const label len, const T &val)

void	resize (const label newLen)

void	resize_nocopy (const label len)

void	setSize (const label n)

void	setSize (const label n, const T &val)

void	append (const T &val)

void	append (T &&val)

void	append (const UList< T > &list)

void	append (const IndirectListBase< T, Addr > &list)

void	append (const T &val)

void	append (T &&val)

void	append (const UList< T > &list)

label	appendUniq (const T &val)

void	transfer (List< T > &list)

void	transfer (DynamicList< T, SizeMin > &list)

void	transfer (SortableList< T > &list)

void	transfer (List< T > &list)

void	transfer (SortableList< T > &list)

T &	newElmt (const label i)

void	operator= (const UList< T > &a)

void	operator= (const List< T > &list)

void	operator= (const SLList< T > &list)

void	operator= (const IndirectListBase< T, Addr > &list)

void	operator= (const FixedList< T, N > &list)

void	operator= (std::initializer_list< T > list)

void	operator= (const T &val)

void	operator= (const Foam::zero)

void	operator= (List< T > &&list)

void	operator= (DynamicList< T, SizeMin > &&list)

void	operator= (SortableList< T > &&list)

void	operator= (SLList< T > &&list)

void	operator= (const UList< T > &a)

void	operator= (const List< T > &list)

void	operator= (const SLList< T > &list)

void	operator= (std::initializer_list< T > list)

void	operator= (List< T > &&list)

void	operator= (SortableList< T > &&list)

void	operator= (SLList< T > &&list)

void	operator= (const T &val)

void	operator= (const Foam::zero)

Istream &	readList (Istream &is)

Istream &	readList (Istream &is)

Istream &	readList (Istream &is)

void	shallowCopy (const UList< T > &)=delete

std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD, BAD }

enum	readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }

enum	writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }

enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }

Public Types inherited from List< Type >
typedef SubList< T >	subList

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)

template<class Type >
static Type &	store (autoPtr< Type > &ptr)

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)

template<class Type >
static Type &	store (refPtr< Type > &ptr)

template<class Type >
static Type &	store (refPtr< Type > &&ptr)

template<class Type >
static Type &	store (tmp< Type > &ptr)

template<class Type >
static Type &	store (tmp< Type > &&ptr)

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept

static bool	bannerEnabled (bool on) noexcept

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)

template<class StringType >
static word	groupName (StringType base, const word &group)

static word	group (const word &name)

static word	member (const word &name)

static word	scopedName (const std::string &scope, const word &name)

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)

static Ostream &	writeDivider (Ostream &os)

static Ostream &	writeEndDivider (Ostream &os)

Static Public Member Functions inherited from List< Type >
static const List< T > &	null ()

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames

static char	scopeSeparator

static fileCheckTypes	fileModificationChecking

static float	fileModificationSkew

static int	maxFileModificationPolls

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)

Protected Member Functions inherited from IOobject
void	setBad (const string &s)

Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false

Detailed Description

template<class Type>
class Foam::GlobalIOList< Type >

IOList with global data (so optionally read from master)

Source files

Definition at line 49 of file GlobalIOList.H.

Constructor & Destructor Documentation

◆ GlobalIOList() [1/5]

GlobalIOList ( const GlobalIOList< Type > & )

default

◆ GlobalIOList() [2/5]

GlobalIOList ( const IOobject & io )

explicit

Definition at line 27 of file GlobalIOList.C.

◆ GlobalIOList() [3/5]

GlobalIOList	(	const IOobject &	io,
		const label	size
	)

Definition at line 39 of file GlobalIOList.C.

◆ GlobalIOList() [4/5]

GlobalIOList	(	const IOobject &	io,
		const UList< Type > &	content
	)

Definition at line 55 of file GlobalIOList.C.

◆ GlobalIOList() [5/5]

GlobalIOList	(	const IOobject &	io,
		List< Type > &&	content
	)

Definition at line 74 of file GlobalIOList.C.

◆ ~GlobalIOList()

virtual ~GlobalIOList ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "List" )

◆ global()

virtual bool global ( ) const

inlinevirtual

Reimplemented from regIOobject.

Definition at line 84 of file GlobalIOList.H.

◆ filePath()

virtual fileName filePath ( ) const

inlinevirtual

Reimplemented from regIOobject.

Definition at line 91 of file GlobalIOList.H.

◆ readData()

bool readData ( Istream & is )

virtual

Reimplemented from regIOobject.

Definition at line 93 of file GlobalIOList.C.

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

Implements regIOobject.

Definition at line 101 of file GlobalIOList.C.

◆ operator=()

void operator= ( const GlobalIOList< Type > & rhs )

Definition at line 110 of file GlobalIOList.C.

◆ typeName()

const word typeName ( "scalarVectorTable" )

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::GlobalIOList< Type >

Constructor & Destructor Documentation

◆ GlobalIOList() [1/5]

◆ GlobalIOList() [2/5]

◆ GlobalIOList() [3/5]

◆ GlobalIOList() [4/5]

◆ GlobalIOList() [5/5]

◆ ~GlobalIOList()

Member Function Documentation

◆ TypeName()

◆ global()

◆ filePath()

◆ readData()

◆ writeData()

◆ operator=()

◆ typeName()

template<class Type>
class Foam::GlobalIOList< Type >