Public Member Functions | List of all members
IOPtrList< T > Class Template Reference

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

Inheritance diagram for IOPtrList< T >:
Inheritance graph
[legend]
Collaboration diagram for IOPtrList< T >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("PtrList")
 
 IOPtrList (const IOPtrList &)=default
 
 IOPtrList (const IOobject &io)
 
template<class INew >
 IOPtrList (const IOobject &io, const INew &inewt)
 
 IOPtrList (const IOobject &io, const label len)
 
 IOPtrList (const IOobject &io, const PtrList< T > &content)
 
 IOPtrList (const IOobject &io, PtrList< T > &&content)
 
virtual ~IOPtrList ()=default
 
bool writeData (Ostream &os) const
 
void operator= (const IOPtrList< T > &rhs)
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 
 regIOobject (const IOobject &io, const bool isTimeObject=false)
 
 regIOobject (const regIOobject &rio)
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 
virtual ~regIOobject ()
 
bool checkIn ()
 
bool checkOut ()
 
virtual void addWatch ()
 
bool ownedByRegistry () const
 
bool store ()
 
void release (const bool unregister=false)
 
label eventNo () const
 
label & eventNo ()
 
bool upToDate (const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 
void setUpToDate ()
 
virtual void rename (const word &newName)
 
const dictionary * findMetaData () const noexcept
 
dictionary & getMetaData () noexcept
 
void removeMetaData ()
 
virtual void updateMetaData ()
 
virtual fileName filePath () const
 
bool headerOk ()
 
Istream & readStream (const word &, const bool valid=true)
 
void close ()
 
virtual bool readData (Istream &)
 
virtual bool read ()
 
virtual label addWatch (const fileName &)
 
const labelList & watchIndices () const
 
labelList & watchIndices ()
 
virtual bool modified () const
 
virtual bool readIfModified ()
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 
virtual bool write (const bool valid=true) const
 
virtual bool global () const
 
void operator= (const IOobject &io)
 
virtual bool writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 
 IOobject (const IOobject &)=default
 
virtual ~IOobject ()=default
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 
 IOobject (const IOobject &io, const word &name)
 
 IOobject (const IOobject &io, readOption, writeOption)
 
autoPtr< IOobject > clone () const
 
autoPtr< IOobject > clone (const objectRegistry &registry) const
 
const objectRegistry & db () const noexcept
 
const Time & time () const
 
const word & name () const noexcept
 
const word & headerClassName () const noexcept
 
word & headerClassName () noexcept
 
const string & note () const noexcept
 
string & note () noexcept
 
bool registerObject () const noexcept
 
bool registerObject (bool on) noexcept
 
bool globalObject () const noexcept
 
bool globalObject (bool on) noexcept
 
unsigned labelByteSize () const noexcept
 
unsigned scalarByteSize () const noexcept
 
bool isHeaderClassName (const word &clsName) const
 
template<class Type >
bool isHeaderClassName () const
 
readOption readOpt () const noexcept
 
readOption readOpt (readOption opt) noexcept
 
writeOption writeOpt () const noexcept
 
writeOption writeOpt (writeOption opt) noexcept
 
word group () const
 
word member () const
 
const fileName & rootPath () const
 
const fileName & caseName () const
 
const fileName & instance () const noexcept
 
fileName & instance () noexcept
 
const fileName & local () const noexcept
 
fileName path () const
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 
fileName objectPath () const
 
fileName objectRelPath () const
 
fileName localFilePath (const word &typeName, const bool search=true) const
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 
IOstreamOption parseHeader (const dictionary &headerDict)
 
bool readHeader (Istream &is)
 
bool readHeader (dictionary &headerDict, Istream &is)
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 
template<class Type >
void warnNoRereading () const
 
bool writeHeader (Ostream &os) const
 
bool writeHeader (Ostream &os, const word &objectType) const
 
void writeHeader (dictionary &dict, IOstreamOption streamOpt) const
 
void writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
 
bool good () const noexcept
 
bool bad () const noexcept
 
InfoProxy< IOobject > info () const
 
void operator= (const IOobject &io)
 
readOption & readOpt () noexcept
 
writeOption & writeOpt () noexcept
 
bool & registerObject () noexcept
 
bool & globalObject () noexcept
 
template<>
bool isHeaderClassName () const
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 
- Public Member Functions inherited from PtrList< T >
constexpr PtrList () noexcept
 
 PtrList (const label len)
 
 PtrList (const PtrList< T > &list)
 
 PtrList (PtrList< T > &&list)
 
 PtrList (UList< T * > &list)
 
 PtrList (const PtrList< T > &list, const CloneArg &cloneArgs)
 
 PtrList (PtrList< T > &list, bool reuse)
 
 PtrList (const SLPtrList< T > &list)
 
 PtrList (Istream &is, const INew &inew)
 
 PtrList (Istream &is)
 
 PtrList (PtrList< T > &list, bool reuse)
 
 PtrList (const SLPtrList< T > &list)
 
constexpr PtrList () noexcept
 
 PtrList (const label len)
 
 PtrList (const PtrList< T > &list)
 
 PtrList (PtrList< T > &&list)
 
 PtrList (UList< T * > &list)
 
 PtrList (Istream &is)
 
 ~PtrList ()
 
PtrList< T > clone (Args &&... args) const
 
Foam::PtrList< T > clone (Args &&... args) const
 
const T * set (const label i) const
 
autoPtr< T > set (const label i, T *ptr)
 
autoPtr< T > set (const label i, autoPtr< T > &ptr)
 
autoPtr< T > set (const label i, autoPtr< T > &&ptr)
 
autoPtr< T > set (const label i, std::unique_ptr< T > &&ptr)
 
autoPtr< T > set (const label i, const refPtr< T > &ptr)
 
autoPtr< T > set (const label i, const tmp< T > &ptr)
 
void clear ()
 
void resize (const label newLen)
 
void setSize (const label newLen)
 
void emplace_append (Args &&... args)
 
void append (T *ptr)
 
void append (autoPtr< T > &ptr)
 
void append (autoPtr< T > &&ptr)
 
void append (std::unique_ptr< T > &&ptr)
 
void append (const refPtr< T > &ptr)
 
void append (const tmp< T > &ptr)
 
autoPtr< T > emplace (const label i, Args &&... args)
 
Foam::autoPtr< T > emplace (const label i, Args &&... args)
 
autoPtr< T > release (const label i)
 
void transfer (PtrList< T > &list)
 
void operator= (const PtrList< T > &list)
 
void operator= (PtrList< T > &&list)
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState : char { GOOD, BAD }
 
enum  readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 
enum  writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
 
enum  fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 
template<class Type >
static Type & store (autoPtr< Type > &ptr)
 
template<class Type >
static Type & store (autoPtr< Type > &&ptr)
 
template<class Type >
static Type & store (refPtr< Type > &ptr)
 
template<class Type >
static Type & store (refPtr< Type > &&ptr)
 
template<class Type >
static Type & store (tmp< Type > &ptr)
 
template<class Type >
static Type & store (tmp< Type > &&ptr)
 
- Static Public Member Functions inherited from IOobject
static bool bannerEnabled () noexcept
 
static bool bannerEnabled (bool on) noexcept
 
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 
template<class StringType >
static word groupName (StringType base, const word &group)
 
static word group (const word &name)
 
static word member (const word &name)
 
static word scopedName (const std::string &scope, const word &name)
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 
static Ostream & writeBanner (Ostream &os, const bool noSyntaxHint=false)
 
static Ostream & writeDivider (Ostream &os)
 
static Ostream & writeEndDivider (Ostream &os)
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes > fileCheckTypesNames
 
static char scopeSeparator
 
static fileCheckTypes fileModificationChecking
 
static float fileModificationSkew
 
static int maxFileModificationPolls
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 
- Protected Member Functions inherited from PtrList< T >
void readIstream (Istream &is, const INew &inew)
 
void free ()
 
- Static Protected Member Functions inherited from IOobject
static void writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
 
static void writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 

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 49 of file IOPtrList.H.

Constructor & Destructor Documentation

◆ IOPtrList() [1/6]

IOPtrList ( const IOPtrList< T > &  )
default

◆ IOPtrList() [2/6]

IOPtrList ( const IOobject &  io)
explicit

Definition at line 51 of file IOPtrList.C.

◆ IOPtrList() [3/6]

IOPtrList ( const IOobject &  io,
const INew &  inewt 
)

Definition at line 28 of file IOPtrList.C.

◆ IOPtrList() [4/6]

IOPtrList ( const IOobject &  io,
const label  len 
)

Definition at line 74 of file IOPtrList.C.

◆ IOPtrList() [5/6]

IOPtrList ( const IOobject &  io,
const PtrList< T > &  content 
)

Definition at line 89 of file IOPtrList.C.

◆ IOPtrList() [6/6]

IOPtrList ( const IOobject &  io,
PtrList< T > &&  content 
)

Definition at line 116 of file IOPtrList.C.

◆ ~IOPtrList()

virtual ~IOPtrList ( )
virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "PtrList"  )

◆ writeData()

bool writeData ( Ostream &  os) const
virtual

Implements regIOobject.

Definition at line 143 of file IOPtrList.C.

◆ operator=()

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

Definition at line 152 of file IOPtrList.C.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17