A PtrList of objects of type <T> with automated input and output. More...
#include <OpenFOAM/IOPtrList.H>
A PtrList of objects of type <T> with automated input and output.
Definition at line 51 of file IOPtrList.H.
Public Member Functions | |
TypeName ("PtrList") | |
Runtime type information. | |
template<class INew > | |
IOPtrList (const IOobject &, const INew &) | |
Construct from IOobject using given Istream constructor class. | |
IOPtrList (const IOobject &) | |
Construct from IOobject. | |
IOPtrList (const IOobject &, const label) | |
Construct from IOobject with given size. | |
IOPtrList (const IOobject &, const PtrList< T > &) | |
Construct from IOobject and a PtrList. | |
IOPtrList (const IOobject &, const Xfer< PtrList< T > > &) | |
Construct by transferring the PtrList contents. | |
virtual | ~IOPtrList () |
bool | writeData (Ostream &) const |
Pure virtual writaData function. | |
void | operator= (const IOPtrList< T > &) |
![]() | |
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. | |
![]() | |
PtrList () | |
Null Constructor. | |
PtrList (const label) | |
Construct with length specified. | |
PtrList (const PtrList< T > &) | |
Copy constructor. | |
template<class CloneArg > | |
PtrList (const PtrList< T > &, const CloneArg &) | |
Copy constructor with additional argument for clone. | |
PtrList (const Xfer< PtrList< T > > &) | |
Construct by transferring the parameter contents. | |
PtrList (PtrList< T > &, bool reUse) | |
Construct as copy or re-use as specified. | |
PtrList (const SLPtrList< T > &) | |
Construct as copy of SLPtrList<T> | |
template<class INew > | |
PtrList (Istream &, const INew &) | |
Construct from Istream using given Istream constructor class. | |
PtrList (Istream &) | |
Construct from Istream using default Istream constructor class. | |
~PtrList () | |
label | size () const |
Return the number of elements in the PtrList. | |
bool | empty () const |
Return true if the PtrList is empty (ie, size() is zero). | |
void | setSize (const label) |
Reset size of PtrList. This can only be used to set the size. | |
void | resize (const label) |
Reset size of PtrList. This can only be used to set the size. | |
void | clear () |
Clear the PtrList, i.e. set size to zero deleting all the. | |
void | transfer (PtrList< T > &) |
Transfer the contents of the argument PtrList into this PtrList. | |
Xfer< PtrList< T > > | xfer () |
Transfer contents to the Xfer container. | |
bool | set (const label) const |
Is element set. | |
autoPtr< T > | set (const label, T *) |
Set element. Return old element (can be NULL). | |
autoPtr< T > | set (const label, const autoPtr< T > &) |
autoPtr< T > | set (const label, const tmp< T > &) |
void | reorder (const UList< label > &) |
Reorders elements. Ordering does not have to be done in. | |
const T & | operator[] (const label) const |
Return element const reference. | |
T & | operator[] (const label) |
Return element reference. | |
const T * | operator() (const label) const |
Return element const pointer. | |
PtrList< T > & | operator= (const PtrList< T > &) |
Assignment. | |
iterator | begin () |
Return an iterator to begin traversing the PtrList. | |
iterator | end () |
Return an iterator to end traversing the PtrList. |
Additional Inherited Members | |
![]() | |
typedef T | value_type |
Type of values the PtrList contains. | |
typedef T & | reference |
Type that can be used for storing into PtrList::value_type objects. | |
typedef const T & | const_reference |
Type that can be used for storing into constant PtrList::value_type. | |
![]() | |
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 |
![]() | |
template<class INew > | |
void | read (Istream &, const INew &inewt) |
Read from Istream using given Istream constructor class. |
Construct from IOobject using given Istream constructor class.
Definition at line 32 of file IOPtrList.C.
References regIOobject::close(), IOobject::headerOk(), IOobject::MUST_READ, regIOobject::read(), IOobject::READ_IF_PRESENT, IOobject::readOpt(), and regIOobject::readStream().
Construct from IOobject.
Definition at line 49 of file IOPtrList.C.
References regIOobject::close(), IOobject::headerOk(), IOobject::MUST_READ, regIOobject::read(), IOobject::READ_IF_PRESENT, IOobject::readOpt(), and regIOobject::readStream().
Construct from IOobject with given size.
Definition at line 66 of file IOPtrList.C.
References Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::nl, IOobject::NO_READ, and IOobject::readOpt().
Construct from IOobject and a PtrList.
Definition at line 81 of file IOPtrList.C.
References regIOobject::close(), IOobject::headerOk(), IOobject::MUST_READ, IOPtrList< T >::operator=(), regIOobject::read(), IOobject::READ_IF_PRESENT, IOobject::readOpt(), and regIOobject::readStream().
Construct by transferring the PtrList contents.
Definition at line 102 of file IOPtrList.C.
References regIOobject::close(), IOobject::headerOk(), IOobject::MUST_READ, regIOobject::read(), IOobject::READ_IF_PRESENT, IOobject::readOpt(), regIOobject::readStream(), and PtrList< T >::transfer().
|
virtual |
Definition at line 123 of file IOPtrList.C.
TypeName | ( | "PtrList" | ) |
Runtime type information.
|
virtual |
Pure virtual writaData function.
Must be defined in derived types
Implements regIOobject.
Reimplemented in TimeActivatedExplicitSourceList< Type >.
Definition at line 130 of file IOPtrList.C.
References IOobject::good().
Definition at line 139 of file IOPtrList.C.
References PtrList< T >::operator=().
Referenced by IOPtrList< T >::IOPtrList().