|
| TypeName ("List") |
| Runtime type information. More...
|
|
| IOList (const IOList &)=default |
| Default copy construct. More...
|
|
| IOList (const IOobject &io) |
| Construct from IOobject. More...
|
|
| IOList (const IOobject &io, const label len) |
| Construct from IOobject and size of IOList. More...
|
|
| IOList (const IOobject &io, const UList< T > &content) |
| Construct from IOobject and a copy of UList content. More...
|
|
| IOList (const IOobject &io, List< T > &&content) |
| Construct by transferring the List content. More...
|
|
virtual | ~IOList ()=default |
| Destructor. More...
|
|
bool | writeData (Ostream &os) const |
| Pure virtual writeData function. More...
|
|
void | operator= (const IOList< T > &rhs) |
| Copy assignment of entries. More...
|
|
| TypeName ("regIOobject") |
| Runtime type information. More...
|
|
| regIOobject (const IOobject &io, const bool isTimeObject=false) |
|
| regIOobject (const regIOobject &rio) |
| Copy construct. More...
|
|
| regIOobject (const regIOobject &rio, bool registerCopy) |
|
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) |
|
| regIOobject (const IOobject &io, const regIOobject &rio) |
| Copy construct with new IO parameters. More...
|
|
virtual | ~regIOobject () |
| Destructor. More...
|
|
bool | checkIn () |
| Add object to registry, if not already registered. More...
|
|
bool | checkOut () |
| Remove all file watches and remove object from registry. More...
|
|
virtual void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED) More...
|
|
bool | ownedByRegistry () const |
| Is this object owned by the registry? More...
|
|
bool | store () |
|
void | release (const bool unregister=false) |
| Release ownership of this object from its registry. More...
|
|
label | eventNo () const |
| Event number at last update. More...
|
|
label & | eventNo () |
| Event number at last update. More...
|
|
bool | upToDate (const regIOobject &) const |
| Return true if up-to-date with respect to given object. More...
|
|
bool | upToDate (const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More...
|
|
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More...
|
|
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More...
|
|
void | setUpToDate () |
| Set as up-to-date. More...
|
|
virtual void | rename (const word &newName) |
| Rename. More...
|
|
const dictionary * | findMetaData () const noexcept |
| Return pointer to meta-data or nullptr. More...
|
|
dictionary & | getMetaData () noexcept |
| Get or create meta-data. More...
|
|
void | removeMetaData () |
| Remove meta-data. More...
|
|
virtual void | updateMetaData () |
| Update internal meta-data (eg, prior to writing) More...
|
|
virtual fileName | filePath () const |
| Return complete path + object name if the file exists. More...
|
|
bool | headerOk () |
| Read and check header info. More...
|
|
Istream & | readStream (const word &, const bool valid=true) |
| Return Istream and check object type against that given. More...
|
|
void | close () |
| Close Istream. More...
|
|
virtual bool | readData (Istream &) |
| Virtual readData function. More...
|
|
virtual bool | read () |
| Read object. More...
|
|
virtual label | addWatch (const fileName &) |
| Add file watch for fileName on object if not yet watched. More...
|
|
const labelList & | watchIndices () const |
| Return file-monitoring handles. More...
|
|
labelList & | watchIndices () |
| Return file-monitoring handles. More...
|
|
virtual bool | modified () const |
|
virtual bool | readIfModified () |
| Read object if modified (as set by call to modified) More...
|
|
virtual bool | writeObject (IOstreamOption streamOpt, const bool valid) const |
| Write using stream options. More...
|
|
virtual bool | write (const bool valid=true) const |
| Write using setting from DB. More...
|
|
virtual bool | global () const |
| Is object global. More...
|
|
void | operator= (const IOobject &io) |
| Copy assignment. More...
|
|
virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const |
| Write using given format, version and compression. More...
|
|
| TypeName ("IOobject") |
| Declare type-name, virtual type (with debug switch) More...
|
|
| IOobject (const IOobject &)=default |
| Copy construct. More...
|
|
virtual | ~IOobject ()=default |
| Destructor. More...
|
|
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) |
| Construct from name, instance, registry, io options. More...
|
|
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) |
| Construct from name, instance, local, registry, io options. More...
|
|
| IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) |
| Construct from path, registry, io options. More...
|
|
| IOobject (const IOobject &io, const objectRegistry ®istry) |
| Copy construct, resetting registry. More...
|
|
| IOobject (const IOobject &io, const word &name) |
| Copy construct, resetting name. More...
|
|
| IOobject (const IOobject &io, readOption, writeOption) |
| Copy construct, resetting io options. More...
|
|
autoPtr< IOobject > | clone () const |
| Clone. More...
|
|
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. More...
|
|
const objectRegistry & | db () const noexcept |
| Return the local objectRegistry. More...
|
|
const Time & | time () const |
| Return Time associated with the objectRegistry. More...
|
|
const word & | name () const noexcept |
| Return name. More...
|
|
const word & | headerClassName () const noexcept |
| Return name of the class name read from header. More...
|
|
word & | headerClassName () noexcept |
| Return non-constant access to the class name read from header. More...
|
|
const string & | note () const noexcept |
| Return the optional note. More...
|
|
string & | note () noexcept |
| Return non-constant access to the optional note. More...
|
|
bool | registerObject () const noexcept |
| Should object created with this IOobject be registered? More...
|
|
bool | registerObject (bool on) noexcept |
| Change registration preference, return previous value. More...
|
|
bool | globalObject () const noexcept |
| Is object same for all processors? More...
|
|
bool | globalObject (bool on) noexcept |
| Change global-object status, return previous value. More...
|
|
unsigned | labelByteSize () const noexcept |
| The sizeof (label) in bytes, possibly read from the header. More...
|
|
unsigned | scalarByteSize () const noexcept |
| The sizeof (scalar) in bytes, possibly read from the header. More...
|
|
bool | isHeaderClassName (const word &clsName) const |
| Test if headerClassName() equals the given class name. More...
|
|
template<class Type > |
bool | isHeaderClassName () const |
| Test if headerClassName() equals Type::typeName. More...
|
|
readOption | readOpt () const noexcept |
| The read option. More...
|
|
readOption | readOpt (readOption opt) noexcept |
| Change the read option, return previous value. More...
|
|
writeOption | writeOpt () const noexcept |
| The write option. More...
|
|
writeOption | writeOpt (writeOption opt) noexcept |
| Change the write option, return previous value. More...
|
|
word | group () const |
| Return group (extension part of name) More...
|
|
word | member () const |
| Return member (name without the extension) More...
|
|
const fileName & | rootPath () const |
|
const fileName & | caseName () const |
|
const fileName & | instance () const noexcept |
|
fileName & | instance () noexcept |
|
const fileName & | local () const noexcept |
|
fileName | path () const |
| The complete path. More...
|
|
fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. More...
|
|
fileName | objectPath () const |
| The complete path + object name. More...
|
|
fileName | objectRelPath () const |
| The object path relative to the root. More...
|
|
fileName | localFilePath (const word &typeName, const bool search=true) const |
| Helper for filePath that searches locally. More...
|
|
fileName | globalFilePath (const word &typeName, const bool search=true) const |
| Helper for filePath that searches up if in parallel. More...
|
|
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) |
| Read header (uses typeFilePath to find file) and check its info. More...
|
|
template<class Type > |
void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. More...
|
|
bool | writeHeader (Ostream &os) const |
| Write header with current type() More...
|
|
bool | writeHeader (Ostream &os, const word &objectType) const |
| Write header with override of type. More...
|
|
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 |
| Return info proxy. More...
|
|
void | operator= (const IOobject &io) |
|
readOption & | readOpt () noexcept |
| Access to the read option. More...
|
|
writeOption & | writeOpt () noexcept |
| Access to the write option. More...
|
|
bool & | registerObject () noexcept |
| Access to the register object option. More...
|
|
bool & | globalObject () noexcept |
| Access to the global object option. More...
|
|
template<> |
bool | isHeaderClassName () const |
| Specialization for void always returns true (no headerClassName check). More...
|
|
template<class StringType > |
Foam::word | groupName (StringType base, const word &group) |
|
constexpr | List () noexcept |
| Default construct. More...
|
|
| List (const label len) |
| Construct with given size. More...
|
|
| List (const label len, const T &val) |
| Construct with given size and value for all elements. More...
|
|
| List (const label len, const Foam::zero) |
| Construct with given size initializing all elements to zero. More...
|
|
| List (const Foam::one, const T &val) |
| Construct with length=1, copying the value as the only content. More...
|
|
| List (const Foam::one, T &&val) |
| Construct with length=1, moving the value as the only content. More...
|
|
| List (const Foam::one, const Foam::zero) |
| Construct with length=1, initializing content to zero. More...
|
|
| List (const List< T > &a) |
| Copy construct from list. More...
|
|
| List (const UList< T > &a) |
| Copy construct contents from list. More...
|
|
| List (List< T > &a, bool reuse) |
| Construct as copy or re-use as specified. More...
|
|
| List (const UList< T > &list, const labelUList &indices) |
| Copy construct subset of list. More...
|
|
template<unsigned N> |
| List (const UList< T > &list, const FixedList< label, N > &indices) |
| Copy construct subset of list. More...
|
|
template<unsigned N> |
| List (const FixedList< T, N > &list) |
| Construct as copy of FixedList<T, N> More...
|
|
| List (const PtrList< T > &list) |
| Construct as copy of PtrList<T> More...
|
|
| List (const SLList< T > &list) |
| Construct as copy of SLList<T> More...
|
|
template<class Addr > |
| List (const IndirectListBase< T, Addr > &list) |
| Construct as copy of IndirectList contents. More...
|
|
| List (std::initializer_list< T > list) |
| Construct from an initializer list. More...
|
|
| List (List< T > &&list) |
| Move construct from List. More...
|
|
template<int SizeMin> |
| List (DynamicList< T, SizeMin > &&list) |
| Move construct from DynamicList. More...
|
|
| List (SortableList< T > &&list) |
| Move construct from SortableList. More...
|
|
| List (SLList< T > &&list) |
| Move construct from SLList. More...
|
|
| List (Istream &is) |
| Construct from Istream. More...
|
|
autoPtr< List< T > > | clone () const |
| Clone. More...
|
|
| ~List () |
| Destructor. More...
|
|
void | clear () |
| Clear the list, i.e. set size to zero. More...
|
|
void | resize (const label len) |
| Adjust allocated size of list. More...
|
|
void | resize (const label len, const T &val) |
| Adjust allocated size of list and set val for new elements. More...
|
|
void | resize_nocopy (const label len) |
| Adjust allocated size of list without necessarily. More...
|
|
void | setSize (const label n) |
| Alias for resize() More...
|
|
void | setSize (const label n, const T &val) |
| Alias for resize() More...
|
|
void | append (const T &val) |
| Append an element at the end of the list. More...
|
|
void | append (T &&val) |
| Move append an element at the end of the list. More...
|
|
void | append (const UList< T > &list) |
| Append a List to the end of this list. More...
|
|
template<class Addr > |
void | append (const IndirectListBase< T, Addr > &list) |
| Append IndirectList contents at the end of this list. More...
|
|
label | appendUniq (const T &val) |
| Append an element if not already in the list. More...
|
|
void | transfer (List< T > &list) |
|
template<int SizeMin> |
void | transfer (DynamicList< T, SizeMin > &list) |
|
void | transfer (SortableList< T > &list) |
|
T & | newElmt (const label i) |
|
void | operator= (const UList< T > &a) |
| Assignment to UList operator. Takes linear time. More...
|
|
void | operator= (const List< T > &list) |
| Assignment operator. Takes linear time. More...
|
|
void | operator= (const SLList< T > &list) |
| Assignment to SLList operator. Takes linear time. More...
|
|
template<class Addr > |
void | operator= (const IndirectListBase< T, Addr > &list) |
| Assignment from IndirectList. Takes linear time. More...
|
|
template<unsigned N> |
void | operator= (const FixedList< T, N > &list) |
| Copy assignment from FixedList. More...
|
|
void | operator= (std::initializer_list< T > list) |
| Assignment to an initializer list. More...
|
|
void | operator= (const T &val) |
| Assignment of all entries to the given value. More...
|
|
void | operator= (const Foam::zero) |
| Assignment of all entries to zero. More...
|
|
void | operator= (List< T > &&list) |
| Move assignment. Takes constant time. More...
|
|
template<int SizeMin> |
void | operator= (DynamicList< T, SizeMin > &&list) |
| Move assignment. Takes constant time. More...
|
|
void | operator= (SortableList< T > &&list) |
| Move assignment. Takes constant time. More...
|
|
void | operator= (SLList< T > &&list) |
| Move assignment. Takes constant time. More...
|
|
Istream & | readList (Istream &is) |
| Read List from Istream, discarding contents of existing List. More...
|
|
void | shallowCopy (const UList< T > &)=delete |
| No shallowCopy permitted. More...
|
|
template<class TypeT = T> |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | set (const label i, bool val=true) |
| A bitSet::set() method for a list of bool. More...
|
|
template<> |
Istream & | readList (Istream &is) |
|
template<> |
void | resize (const label newLen) |
|
template<> |
Istream & | readList (Istream &is) |
|
|
enum | objectState : char { GOOD,
BAD
} |
| Enumeration defining the valid states of an IOobject. More...
|
|
enum | readOption : char { MUST_READ,
MUST_READ_IF_MODIFIED,
READ_IF_PRESENT,
NO_READ
} |
| Enumeration defining the read options. More...
|
|
enum | writeOption : char { AUTO_WRITE = 0,
NO_WRITE = 1
} |
| Enumeration defining the write options. More...
|
|
enum | fileCheckTypes : char { timeStamp,
timeStampMaster,
inotify,
inotifyMaster
} |
| Enumeration defining the file checking options. More...
|
|
typedef SubList< T > | subList |
| Declare type of subList. More...
|
|
template<class Type > |
static Type & | store (Type *p) |
| Transfer pointer ownership to its registry. More...
|
|
template<class Type > |
static Type & | store (autoPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. More...
|
|
template<class Type > |
static Type & | store (autoPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. More...
|
|
template<class Type > |
static Type & | store (refPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. More...
|
|
template<class Type > |
static Type & | store (refPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. More...
|
|
template<class Type > |
static Type & | store (tmp< Type > &ptr) |
| Transfer pointer ownership to its registry. More...
|
|
template<class Type > |
static Type & | store (tmp< Type > &&ptr) |
| Transfer pointer ownership to its registry. More...
|
|
static bool | bannerEnabled () noexcept |
| Status of output file banner. More...
|
|
static bool | bannerEnabled (bool on) noexcept |
| Enable/disable an output file banner. More...
|
|
static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. More...
|
|
template<class StringType > |
static word | groupName (StringType base, const word &group) |
| Create dot-delimited name.group string. More...
|
|
static word | group (const word &name) |
| Return group (extension part of name) More...
|
|
static word | member (const word &name) |
| Return member (name without the extension) More...
|
|
static word | scopedName (const std::string &scope, const word &name) |
| Create scope:name or scope_name string. More...
|
|
static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
| Return the IOobject, but also consider an alternative file name. More...
|
|
static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
| Write the standard OpenFOAM file/dictionary banner. More...
|
|
static Ostream & | writeDivider (Ostream &os) |
| Write the standard file section divider. More...
|
|
static Ostream & | writeEndDivider (Ostream &os) |
| Write the standard end file divider. More...
|
|
static const List< T > & | null () |
| Return a null List. More...
|
|
static const Enum< fileCheckTypes > | fileCheckTypesNames |
| Names for the fileCheckTypes. More...
|
|
static char | scopeSeparator |
| Character for scoping object names (':' or '_') More...
|
|
static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. More...
|
|
static float | fileModificationSkew |
| Time skew (seconds) for file modification checks. More...
|
|
static int | maxFileModificationPolls |
| Max number of times to poll for file modification changes. More...
|
|
bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
| Helper: check readOpt flags and read if necessary. More...
|
|
void | setBad (const string &s) |
| Set the object state to bad. More...
|
|
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 bool | masterOnlyReading = false |
| To flag master-only reading of objects. More...
|
|