IOMap< T > Class Template Reference

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

#include <OpenFOAM/IOMap.H>

---

Detailed Description

template<class T>
class Foam::IOMap< T >

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

Source files

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

Definition at line 51 of file IOMap.H.

Inheritance diagram for IOMap< T >:

Collaboration diagram for IOMap< T >:

List of all members.

Public Member Functions
	TypeName ("Map")
	Runtime type information.
	IOMap (const IOobject &)
	Construct from IOobject.
	IOMap (const IOobject &, const label)
	Construct from IOobject and size of Map.
	IOMap (const IOobject &, const Map< T > &)
	Construct from IOobject and a Map.
	IOMap (const IOobject &, const Xfer< Map< T > > &)
	Construct by transferring the Map contents.
virtual	~IOMap ()
bool	writeData (Ostream &) const
	Pure virtual writaData function.
void	operator= (const IOMap< T > &)
	Assignment of other IOMap's entries to this IOMap.
void	operator= (const Map< T > &)
	Assignment of other Map's entries to this IOMap.

---

Constructor & Destructor Documentation

IOMap

(

const IOobject &

io  )

Construct from IOobject.

Definition at line 31 of file IOMap.C.

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

IOMap	(	const IOobject &	io,
		const label	size
	)

Construct from IOobject and size of Map.

Definition at line 47 of file IOMap.C.

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

IOMap	(	const IOobject &	io,
		const Map< T > &	map
	)

Construct from IOobject and a Map.

Definition at line 68 of file IOMap.C.

References regIOobject::close(), IOobject::headerOk(), IOobject::MUST_READ, IOMap< T >::operator=(), IOobject::READ_IF_PRESENT, IOobject::readOpt(), and regIOobject::readStream().

IOMap	(	const IOobject &	io,
		const Xfer< Map< T > > &	map
	)

Construct by transferring the Map contents.

Definition at line 89 of file IOMap.C.

References regIOobject::close(), IOobject::headerOk(), IOobject::MUST_READ, IOobject::READ_IF_PRESENT, IOobject::readOpt(), regIOobject::readStream(), and HashTable< T, label, Hash< label > >::transfer().

~IOMap

(

)

[virtual]

Definition at line 110 of file IOMap.C.

---

Member Function Documentation

TypeName

(

"Map"

)

Runtime type information.

bool writeData

(

Ostream &

)

const [virtual]

Pure virtual writaData function.

Must be defined in derived types

Implements regIOobject.

Definition at line 117 of file IOMap.C.

References IOobject::good().

void operator=

(

const IOMap< T > &

rhs  )

Assignment of other IOMap's entries to this IOMap.

Definition at line 126 of file IOMap.C.

References HashTable< T, label, Hash< label > >::operator=().

Referenced by IOMap< T >::IOMap().

void operator=

(

const Map< T > &

rhs  )

Assignment of other Map's entries to this IOMap.

Definition at line 133 of file IOMap.C.

References HashTable< T, label, Hash< label > >::operator=().

---

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

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