A Map of objects of type <T> with automated input and output. More...
#include <OpenFOAM/IOMap.H>
A Map of objects of type <T> with automated input and output.
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. | |
![]() | |
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. | |
Istream & | readStream (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 &) |
![]() | |
TypeName ("IOobject") | |
Runtime type information. | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, 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 ®istry, 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 ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
Construct from path, registry, io options. | |
Foam::autoPtr< IOobject > | clone () const |
Clone. | |
virtual | ~IOobject () |
const Time & | time () const |
Return time. | |
const objectRegistry & | db () const |
Return the local objectRegistry. | |
const word & | name () const |
Return name. | |
const word & | headerClassName () const |
Return name of the class name read from header. | |
string & | note () |
Return non-constant access to the optional note. | |
const string & | note () const |
Return the optional note. | |
bool | registerObject () const |
Register object created from this IOobject with registry if true. | |
readOption | readOpt () const |
readOption & | readOpt () |
writeOption | writeOpt () const |
writeOption & | writeOpt () |
const fileName & | rootPath () const |
const fileName & | caseName () const |
const fileName & | instance () const |
fileName & | instance () |
const fileName & | local () 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< IOobject > | info () const |
Return info proxy. | |
![]() | |
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. | |
![]() | |
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. | |
Ostream & | printInfo (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. | |
T & | operator[] (const label &) |
Find and return an hashedEntry. | |
const T & | operator[] (const label &) const |
Find and return an hashedEntry. | |
T & | operator() (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 | |
![]() | |
typedef HashTable< T, label, Hash< label > >::iterator | iterator |
typedef HashTable< T, label, Hash< label > >::const_iterator | const_iterator |
![]() | |
typedef T | value_type |
Type of values the HashTable contains. | |
typedef T & | reference |
Type that can be used for storing into HashTable::value_type. | |
typedef const T & | const_reference |
Type that can be used for storing into constant. | |
typedef label | size_type |
The type that can represent the size of a HashTable. | |
![]() | |
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 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 int | fileModificationSkew |
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().
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().
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().
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().
TypeName | ( | "Map" | ) |
Runtime type information.
|
virtual |
Pure virtual writaData function.
Must be defined in derived types
Implements regIOobject.
Definition at line 117 of file IOMap.C.
References IOobject::good().
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().
Assignment of other Map's entries to this IOMap.
Definition at line 133 of file IOMap.C.
References HashTable< T, label, Hash< label > >::operator=().