IOList< T > Class Template Reference

A List of objects of type <T> with automated input and output. More...

Inheritance diagram for IOList< T >:

Collaboration diagram for IOList< T >:

Public Member Functions
	TypeName ("List")
	Runtime type information. More...
	IOList (const IOobject &)
	Construct from IOobject. More...
	IOList (const IOobject &, const label)
	Construct from IOobject and size of IOList. More...
	IOList (const IOobject &, const List< T > &)
	Construct from IOobject and a List. More...
	IOList (const IOobject &, const Xfer< List< T > > &)
	Construct by transferring the List contents. More...
virtual	~IOList ()
	Destructor. More...
bool	writeData (Ostream &) const
	Pure virtual writaData function. More...
void	operator= (const IOList< T > &)
void	operator= (const List< T > &)
const word	typeName ("scalarVectorTable")
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 &)
	Construct as copy. More...
	regIOobject (const regIOobject &, bool registerCopy)
	Construct as copy, transferring registry registration to copy. More...
	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Construct as copy with new name, transfering registry registration. More...
	regIOobject (const IOobject &, const regIOobject &)
	Construct as copy with new IO parameters. More...
virtual	~regIOobject ()
	Destructor. More...
bool	checkIn ()
	Add object to registry. More...
bool	checkOut ()
	Remove object from 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...
Istream &	readStream (const word &)
	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...
label	watchIndex () const
	Return file-monitoring handle. More...
label &	watchIndex ()
	Return file-monitoring handle. More...
virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...
virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...
virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
	Write using given format, version and compression. More...
virtual bool	write () const
	Write using setting from DB. More...
void	operator= (const IOobject &)
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 word &name)
	Construct as copy resetting name. More...
Foam::autoPtr< IOobject >	clone () const
	Clone. 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...
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
const fileName &	instance () const
fileName &	instance ()
const fileName &	local () const
fileName	path () const
	Return complete path. More...
fileName	path (const word &instance, const fileName &local="") const
	Return complete path with alternative instance and local. More...
fileName	objectPath () const
	Return complete path + object name. More...
fileName	filePath () const
	Return complete path + object name if the file exists. More...
bool	readHeader (Istream &)
	Read header. More...
bool	headerOk ()
	Read and check header info. 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)
Public Member Functions inherited from List< T >
label	size () const
	Return the number of elements in the UList. More...
	List ()
	Null constructor. More...
	List (const label)
	Construct with given size. More...
	List (const label, const T &)
	Construct with given size and value for all elements. More...
	List (const List< T > &)
	Copy constructor. More...
	List (const Xfer< List< T > > &)
	Construct by transferring the parameter contents. More...
	List (List< T > &, bool reUse)
	Construct as copy or re-use as specified. More...
	List (const UList< T > &, const labelUList &mapAddressing)
	Construct as subset. More...
	List (InputIterator first, InputIterator last)
	Construct given start and end iterators. More...
	List (const FixedList< T, Size > &)
	Construct as copy of FixedList<T, Size> More...
	List (const PtrList< T > &)
	Construct as copy of PtrList<T> More...
	List (const SLList< T > &)
	Construct as copy of SLList<T> More...
	List (const UIndirectList< T > &)
	Construct as copy of UIndirectList<T> More...
	List (const BiIndirectList< T > &)
	Construct as copy of BiIndirectList<T> More...
	List (Istream &)
	Construct from Istream. More...
	List (const label s)
	List (const label s, const T &a)
	List (const List< T > &a)
	List (const Xfer< List< T > > &lst)
	List (List< T > &a, bool reUse)
	List (const UList< T > &a, const labelUList &map)
	List (const PtrList< T > &lst)
	List (const SLList< T > &lst)
	List (const UIndirectList< T > &lst)
	List (const BiIndirectList< T > &lst)
	List ()
	List (Istream &is)
autoPtr< List< T > >	clone () const
	Clone. More...
	~List ()
	Destructor. More...
void	resize (const label)
	Alias for setSize(const label) More...
void	resize (const label, const T &)
	Alias for setSize(const label, const T&) More...
void	setSize (const label)
	Reset size of List. More...
void	setSize (const label, const T &)
	Reset size of List and value for new elements. More...
void	clear ()
	Clear the list, i.e. set size to zero. More...
void	append (const T &)
	Append an element at the end of the list. More...
void	append (const UList< T > &)
	Append a List at the end of this list. More...
void	append (const UIndirectList< T > &)
	Append a UIndirectList at the end of this list. More...
void	transfer (List< T > &)
	Transfer the contents of the argument List into this list. More...
void	transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &)
	Transfer the contents of the argument List into this list. More...
void	transfer (SortableList< T > &)
	Transfer the contents of the argument List into this list. More...
void	transfer (List< T > &a)
void	transfer (SortableList< T > &a)
Xfer< List< T > >	xfer ()
	Transfer contents to the Xfer container. More...
T &	newElmt (const label)
	Return subscript-checked element of UList. More...
void	operator= (const UList< T > &)
	Assignment from UList operator. Takes linear time. More...
void	operator= (const List< T > &)
	Assignment operator. Takes linear time. More...
void	operator= (const SLList< T > &)
	Assignment from SLList operator. Takes linear time. More...
void	operator= (const UIndirectList< T > &)
	Assignment from UIndirectList operator. Takes linear time. More...
void	operator= (const BiIndirectList< T > &)
	Assignment from BiIndirectList operator. Takes linear time. More...
void	operator= (const T &)
	Assignment of all entries to the given value. More...

Additional Inherited Members
Public Types inherited from regIOobject
enum	fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Types of communications. More...
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...
Public Types inherited from List< T >
typedef SubList< T >	subList
	Declare type of subList. 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)
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 void	replaceFileName (const word &from, const word &to)
Static Public Member Functions inherited from List< T >
static const List< T > &	null ()
	Return a null List. More...
Static Public Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames
static int	fileModificationSkew
static fileCheckTypes	fileModificationChecking
Protected Member Functions inherited from IOobject
Istream *	objectStream ()
	Construct and return an IFstream for the object. More...
Istream *	objectStream (const fileName &)
	Construct and return an IFstream for the object given the. More...
void	setBad (const string &)
	Set the object state to bad. More...
Protected Member Functions inherited from List< T >
void	size (const label)
	Override size to be inconsistent with allocated storage. More...
Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

Detailed Description

template<class T>
class Foam::IOList< T >

A List of objects of type <T> with automated input and output.

Source files

• IOList.H
• IOList.C

Definition at line 50 of file IOList.H.

Constructor & Destructor Documentation

IOList() [1/4]

IOList

(

const IOobject &

io

)

Construct from IOobject.

Definition at line 31 of file IOList.C.

IOList() [2/4]

IOList	(	const IOobject &	io,
		const label	size
	)

Construct from IOobject and size of IOList.

Definition at line 60 of file IOList.C.

IOList() [3/4]

IOList	(	const IOobject &	io,
		const List< T > &	list
	)

Construct from IOobject and a List.

Definition at line 93 of file IOList.C.

IOList() [4/4]

IOList	(	const IOobject &	io,
		const Xfer< List< T > > &	list
	)

Construct by transferring the List contents.

Definition at line 127 of file IOList.C.

~IOList()

~IOList

virtual

Destructor.

Definition at line 161 of file IOList.C.

Member Function Documentation

TypeName()

TypeName

(

"List"

)

Runtime type information.

writeData()

bool writeData ( Ostream &  ) const

virtual

Pure virtual writaData function.

Must be defined in derived types

Implements regIOobject.

Definition at line 169 of file IOList.C.

operator=() [1/2]

void operator=

(

const IOList< T > &

rhs

)

Definition at line 178 of file IOList.C.

operator=() [2/2]

void operator=

(

const List< T > &

rhs

)

Definition at line 185 of file IOList.C.

typeName()

const word typeName

(

"scalarVectorTable"

)

---

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

• src/OpenFOAM/db/IOobjects/IOList/IOList.H
• src/OpenFOAM/db/IOobjects/IOList/IOList.C