FreeFOAM The Cross-Platform CFD Toolkit
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

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.
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information.
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the.
 regIOobject (const regIOobject &)
 Construct as copy.
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, and transferring registry registration to copy.
virtual ~regIOobject ()
bool checkIn ()
 Add object to registry.
bool checkOut ()
 Remove object from registry.
bool ownedByRegistry () const
 Is this object owned by the registry?
void store ()
 Transfer ownership of this object to its registry.
void release ()
 Release ownership of this object from its registry.
label eventNo () const
 Event number at last update.
label & eventNo ()
 Event number at last update.
bool upToDate (const word &) const
 Am I uptodate with respect to other regIOobjects.
bool upToDate (const word &, const word &) const
bool upToDate (const word &, const word &, const word &) const
bool upToDate (const word &, const word &, const word &, const word &) const
void setUpToDate ()
 Flag me as up to date.
virtual void rename (const word &newName)
 Rename.
IstreamreadStream (const word &)
 Return Istream and check object type against that given.
void close ()
 Close Istream.
virtual bool readData (Istream &)
 Virtual readData function.
virtual bool read ()
 Read object.
virtual bool modified () const
 Return true if the object's file has been modified.
virtual bool readIfModified ()
 Read object if modified.
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
 Write using given format, version and compression.
virtual bool write () const
 Write using setting from DB.
void operator= (const IOobject &)
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information.
 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.
 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.
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options.
Foam::autoPtr< IOobjectclone () const
 Clone.
virtual ~IOobject ()
const Timetime () const
 Return time.
const objectRegistrydb () const
 Return the local objectRegistry.
const wordname () const
 Return name.
const wordheaderClassName () const
 Return name of the class name read from header.
stringnote ()
 Return non-constant access to the optional note.
const stringnote () const
 Return the optional note.
bool registerObject () const
 Register object created from this IOobject with registry if true.
readOption readOpt () const
readOptionreadOpt ()
writeOption writeOpt () const
writeOptionwriteOpt ()
const fileNamerootPath () const
const fileNamecaseName () const
const fileNameinstance () const
fileNameinstance ()
const fileNamelocal () const
fileName path () const
 Return complete path.
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local.
fileName objectPath () const
 Return complete path + object name.
fileName filePath () const
 Return complete path + object name if the file exists.
bool readHeader (Istream &)
 Read header.
bool headerOk ()
 Read and check header info.
bool writeHeader (Ostream &) const
 Write header.
bool good () const
bool bad () const
InfoProxy< IOobjectinfo () const
 Return info proxy.
- Public Member Functions inherited from Map< T >
 Map (const label size=128)
 Construct given initial size.
 Map (Istream &is)
 Construct from Istream.
 Map (const Map< T > &map)
 Construct as copy.
 Map (const Xfer< Map< T > > &map)
 Construct by transferring the parameter contents.
 Map (const Xfer< HashTable< T, label, Hash< label > > > &map)
 Construct by transferring the parameter contents.
- Public Member Functions inherited from HashTable< T, label, Hash< label > >
bool set (const label &, const T &newElmt)
 Assign a new hashedEntry, overwriting existing entries.
 HashTable (const label size=128)
 Construct given initial table size.
 HashTable (Istream &, const label size=128)
 Construct from Istream.
 HashTable (const HashTable< T, label, Hash< label > > &)
 Construct as copy.
 HashTable (const Xfer< HashTable< T, label, Hash< label > > > &)
 Construct by transferring the parameter contents.
 ~HashTable ()
label size () const
 Return number of elements in table.
bool empty () const
 Return true if the hash table is empty.
bool found (const label &) const
 Return true if hashedEntry is found in table.
iterator find (const label &)
 Find and return an iterator set at the hashedEntry.
const_iterator find (const label &) const
 Find and return an const_iterator set at the hashedEntry.
List< label > toc () const
 Return the table of contents.
List< label > sortedToc () const
 Return the table of contents as a sorted list.
OstreamprintInfo (Ostream &) const
 Print information.
bool insert (const label &, const T &newElmt)
 Insert a new hashedEntry.
bool erase (const iterator &)
 Erase an hashedEntry specified by given iterator.
bool erase (const label &)
 Erase an hashedEntry specified by given key if in table.
label erase (const UList< label > &)
 Remove entries given by the listed keys from this HashTable.
label erase (const HashTable< AnyType, label, AnyHash > &)
 Remove entries given by the given keys from this HashTable.
void resize (const label newSize)
 Resize the hash table for efficiency.
void clear ()
 Clear all entries from table.
void clearStorage ()
 Clear the table entries and the table itself.
void transfer (HashTable< T, label, Hash< label > > &)
 Transfer the contents of the argument table into this table.
Xfer< HashTable< T, label,
Hash< label > > > 
xfer ()
 Transfer contents to the Xfer container.
Toperator[] (const label &)
 Find and return an hashedEntry.
const Toperator[] (const label &) const
 Find and return an hashedEntry.
Toperator() (const label &)
 Find and return an hashedEntry, create it null if not present.
void operator= (const HashTable< T, label, Hash< label > > &)
 Assignment.
bool operator== (const HashTable< T, label, Hash< label > > &) const
 Equality. Two hash tables are equal if all contents of first are.
bool operator!= (const HashTable< T, label, Hash< label > > &) const
 The opposite of the equality operation. Takes linear time.
iterator begin ()
 iterator set to the begining of the HashTable
const_iterator begin () const
 const_iterator set to the beginning of the HashTable
const iterator & end ()
 iterator set to beyond the end of the HashTable
const const_iterator & end () const
 const_iterator set to beyond the end of the HashTable
const_iterator cbegin () const
 const_iterator set to the beginning of the HashTable
const const_iterator & cend () const
 const_iterator set to beyond the end of the HashTable

Additional Inherited Members

- Public Types inherited from Map< T >
typedef HashTable< T, label,
Hash< label > >::iterator 
iterator
typedef HashTable< T, label,
Hash< label >
>::const_iterator 
const_iterator
- Public Types inherited from HashTable< T, label, Hash< label > >
typedef T value_type
 Type of values the HashTable contains.
typedef Treference
 Type that can be used for storing into HashTable::value_type.
typedef const Tconst_reference
 Type that can be used for storing into constant.
typedef label size_type
 The type that can represent the size of a HashTable.
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry.
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry.
- 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.
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner.
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider.
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider.
- Static Public Attributes inherited from regIOobject
static int fileModificationSkew

Constructor & Destructor Documentation

IOMap ( const IOobject io,
const label  size 
)
IOMap ( const IOobject io,
const Xfer< Map< T > > &  map 
)
~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: