Public Member Functions
IOLongList< T, Offset > Class Template Reference
Inheritance diagram for IOLongList< T, Offset >:
Inheritance graph
[legend]
Collaboration diagram for IOLongList< T, Offset >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("LongList")
 Runtime type information. More...
 
 IOLongList (const IOobject &)
 Construct from IOobject. More...
 
 IOLongList (const IOobject &, const label)
 Construct from IOobject and size of IOLongList. More...
 
 IOLongList (const IOobject &, const LongList< T, Offset > &)
 Construct from IOobject and a List. More...
 
bool writeData (Ostream &) const
 Pure virtual writaData function. More...
 
void operator= (const IOLongList< T, Offset > &)
 
void operator= (const LongList< T, Offset > &)
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Construct as copy. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Construct as copy with new name, transfering registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Construct as copy with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
labeleventNo ()
 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 up to date (obviously) More...
 
virtual void rename (const word &newName)
 Rename. More...
 
IstreamreadStream (const word &)
 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...
 
label watchIndex () const
 Return file-monitoring handle. More...
 
labelwatchIndex ()
 Return file-monitoring handle. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
 Write using given format, version and compression. More...
 
virtual bool write () const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 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. More...
 
 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. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct as copy resetting name. More...
 
Foam::autoPtr< IOobjectclone () const
 Clone. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
bool & registerObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () const
 
fileName path () const
 Return complete path. More...
 
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read and check header info. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
- Public Member Functions inherited from LongList< T, 19 >
 LongList ()
 Construct null. More...
 
 LongList (const label size)
 Construct given size. More...
 
 LongList (const label size, const T &t)
 Construct to given size and initialize. More...
 
 LongList (const LongList< T, Offset > &)
 Copy contructor. More...
 
 ~LongList ()
 
label size () const
 Size of the active part of the list. More...
 
label byteSize () const
 Return the binary size in number of characters of the UList. More...
 
void setSize (const label)
 Reset size of List. More...
 
void clear ()
 Clear the list, i.e. set next free to zero. More...
 
LongList< T, Offset > & shrink ()
 Shrink the list to the number of elements used. More...
 
void transfer (LongList< T, Offset > &)
 transfer the list from another one without allocating it More...
 
void append (const T &e)
 Append an element at the end of the list. More...
 
void appendIfNotIn (const T &e)
 
bool contains (const T &e) const
 check if the element is in the list (takes linear time) More...
 
label containsAtPosition (const T &e) const
 
T remove (const label i)
 Return and remove the element. More...
 
T removeLastElement ()
 
const Toperator[] (const label i) const
 get and set operators More...
 
Toperator[] (const label i)
 
Toperator() (const label)
 Return non-const access to an element,. More...
 
TnewElmt (const label)
 return a non-const access to an element, More...
 
void operator= (const T &)
 Assignment of all entries to the given value. More...
 
void operator= (const LongList< T, Offset > &)
 Assignment operator. More...
 
void appendFromStream (Istream &)
 Read from stream and append to the current content. More...
 
void writeEntry (Ostream &os) const
 Write as a dictionary entry. More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write as a dictionary entry with keyword. More...
 

Additional Inherited Members

- Public Types inherited from regIOobject
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Types of communications. More...
 
- Public Types inherited from IOobject
enum  objectState { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry. More...
 
- 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. More...
 
template<class Name >
static word groupName (Name name, const word &group)
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 
static void replaceFileName (const word &from, const word &to)
 
- Static Public Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static int fileModificationSkew
 
static fileCheckTypes fileModificationChecking
 
- Protected Member Functions inherited from IOobject
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
IstreamobjectStream (const fileName &)
 Construct and return an IFstream for the object given the. More...
 
void setBad (const string &)
 Set the object state to bad. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

template<class T, label Offset = 19>
class Foam::IOLongList< T, Offset >

Definition at line 51 of file IOLongList.H.

Constructor & Destructor Documentation

◆ IOLongList() [1/3]

IOLongList ( const IOobject io)

Construct from IOobject.

Definition at line 40 of file IOLongList.C.

References regIOobject::close(), IOobject::headerOk(), IOobject::MUST_READ, IOobject::READ_IF_PRESENT, IOobject::readOpt(), and regIOobject::readStream().

Here is the call graph for this function:

◆ IOLongList() [2/3]

IOLongList ( const IOobject io,
const label  size 
)

Construct from IOobject and size of IOLongList.

Definition at line 59 of file IOLongList.C.

◆ IOLongList() [3/3]

IOLongList ( const IOobject io,
const LongList< T, Offset > &  list 
)

Construct from IOobject and a List.

Definition at line 71 of file IOLongList.C.

References LongList< T, Offset >::operator=(), IOobject::READ_IF_PRESENT, and IOobject::readOpt().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "LongList"  )

Runtime type information.

◆ writeData()

bool writeData ( Ostream ) const
virtual

Pure virtual writaData function.

Must be defined in derived types

Implements regIOobject.

Definition at line 110 of file IOLongList.C.

◆ operator=() [1/2]

void operator= ( const IOLongList< T, Offset > &  rhs)

Definition at line 91 of file IOLongList.C.

References LongList< T, Offset >::operator=().

Here is the call graph for this function:

◆ operator=() [2/2]

void operator= ( const LongList< T, Offset > &  rhs)

Definition at line 101 of file IOLongList.C.

References LongList< T, Offset >::operator=().

Here is the call graph for this function:

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