FreeFOAM The Cross-Platform CFD Toolkit
IOPtrList< T > Class Template Reference

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

#include <OpenFOAM/IOPtrList.H>


Detailed Description

template<class T>
class Foam::IOPtrList< T >

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

Source files

Definition at line 51 of file IOPtrList.H.

+ Inheritance diagram for IOPtrList< T >:
+ Collaboration diagram for IOPtrList< T >:

List of all members.

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 > &)
- 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 PtrList< T >
 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< Tset (const label, T *)
 Set element. Return old element (can be NULL).
autoPtr< Tset (const label, const autoPtr< T > &)
autoPtr< Tset (const label, const tmp< T > &)
void reorder (const UList< label > &)
 Reorders elements. Ordering does not have to be done in.
const Toperator[] (const label) const
 Return element const reference.
Toperator[] (const label)
 Return element reference.
const Toperator() (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

- Public Types inherited from PtrList< T >
typedef T value_type
 Type of values the PtrList contains.
typedef Treference
 Type that can be used for storing into PtrList::value_type objects.
typedef const Tconst_reference
 Type that can be used for storing into constant PtrList::value_type.
- 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
- Protected Member Functions inherited from PtrList< T >
template<class INew >
void read (Istream &, const INew &inewt)
 Read from Istream using given Istream constructor class.

Constructor & Destructor Documentation

IOPtrList ( const IOobject io,
const INew inewt 
)
IOPtrList ( const IOobject io,
const label  s 
)

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().

IOPtrList ( const IOobject io,
const Xfer< PtrList< T > > &  list 
)
~IOPtrList ( )
virtual

Definition at line 123 of file IOPtrList.C.


Member Function Documentation

TypeName ( "PtrList"  )

Runtime type information.

bool writeData ( Ostream ) const
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().

void operator= ( const IOPtrList< T > &  rhs)

Definition at line 139 of file IOPtrList.C.

References PtrList< T >::operator=().

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


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