Detailed Description

Helper class for recording information about run/finished jobs.

Writes the following files:

FOAM_JOB_DIR/runningJobs
FOAM_JOB_DIR/finishedJobs where FOAM_JOB_DIR is the first of the following options that applies:
$FREEFOAM_JOB_DIR if the environment variable is defined
$FOAM_JOB_DIR if the environment variable is defined (for backward compatibility)
The value of the entry "foamJobDir" in the global controlDict if the entry is present
$HOME/.FreeFOAM/jobControl

Source files

Definition at line 60 of file JobInfo.H.

Inheritance diagram for JobInfo:

Collaboration diagram for JobInfo:

List of all members.

Public Member Functions
	JobInfo ()
	Construct null.
	~JobInfo ()
void	write () const
void	end ()
void	exit ()
void	abort ()
void	signalEnd () const
Public Member Functions inherited from dictionary
	ClassName ("dictionary")
	dictionary ()
	Construct top-level dictionary null.
	dictionary (const fileName &name)
	Construct top-level empty dictionary with given name.
	dictionary (const fileName &name, const dictionary &parentDict, Istream &)
	Construct given the entry name, parent dictionary and Istream,.
	dictionary (Istream &)
	Construct top-level dictionary from Istream, reading entries.
	dictionary (const dictionary &parentDict, const dictionary &)
	Construct as copy given the parent dictionary.
	dictionary (const dictionary &)
	Construct top-level dictionary as copy.
	dictionary (const dictionary *)
	Construct top-level dictionary as copy from pointer to dictionary.
	dictionary (const dictionary &parentDict, const Xfer< dictionary > &)
	Construct by transferring parameter contents given parent dictionary.
	dictionary (const Xfer< dictionary > &)
	Construct top-level dictionary by transferring parameter contents.
autoPtr< dictionary >	clone () const
	Construct and return clone.
	~dictionary ()
const dictionary &	parent () const
	Return the parent dictionary.
label	startLineNumber () const
	Return line number of first token in dictionary.
label	endLineNumber () const
	Return line number of last token in dictionary.
SHA1Digest	digest () const
	Return the SHA1 digest of the dictionary contents.
bool	found (const word &, bool recursive=false) const
	Search dictionary for given keyword.
const entry *	lookupEntryPtr (const word &, bool recursive, bool patternMatch) const
	Find and return an entry data stream pointer if present.
entry *	lookupEntryPtr (const word &, bool recursive, bool patternMatch)
	Find and return an entry data stream pointer for manipulation.
const entry &	lookupEntry (const word &, bool recursive, bool patternMatch) const
	Find and return an entry data stream if present otherwise error.
ITstream &	lookup (const word &, bool recursive=false, bool patternMatch=true) const
	Find and return an entry data stream.
template<class T >
T	lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const
	Find and return a T,.
template<class T >
T	lookupOrAddDefault (const word &, const T &, bool recursive=false, bool patternMatch=true)
	Find and return a T, if not found return the given.
template<class T >
bool	readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const
	Find an entry if present, and assign to T.
bool	isDict (const word &) const
	Check if entry is a sub-dictionary.
const dictionary *	subDictPtr (const word &) const
	Find and return a sub-dictionary pointer if present.
const dictionary &	subDict (const word &) const
	Find and return a sub-dictionary.
dictionary &	subDict (const word &)
	Find and return a sub-dictionary for manipulation.
dictionary	subOrEmptyDict (const word &) const
	Find and return a sub-dictionary as a copy, or.
wordList	toc () const
	Return the table of contents.
List< keyType >	keys (bool patterns=false) const
	Return the list of available keys or patterns.
bool	substituteKeyword (const word &keyword)
	Substitute the given keyword prepended by '$' with the.
bool	add (entry *, bool mergeEntry=false)
	Add a new entry.
void	add (const entry &, bool mergeEntry=false)
	Add an entry.
void	add (const keyType &, const word &, bool overwrite=false)
	Add a word entry.
void	add (const keyType &, const string &, bool overwrite=false)
	Add a string entry.
void	add (const keyType &, const label, bool overwrite=false)
	Add a label entry.
void	add (const keyType &, const scalar, bool overwrite=false)
	Add a scalar entry.
void	add (const keyType &, const dictionary &, bool mergeEntry=false)
	Add a dictionary entry.
template<class T >
void	add (const keyType &, const T &, bool overwrite=false)
	Add a T entry.
void	set (entry *)
	Assign a new entry, overwrite any existing entry.
void	set (const entry &)
	Assign a new entry, overwrite any existing entry.
void	set (const keyType &, const dictionary &)
	Assign a dictionary entry, overwrite any existing entry.
template<class T >
void	set (const keyType &, const T &)
	Assign a T entry, overwrite any existing entry.
bool	remove (const word &)
	Remove an entry specified by keyword.
bool	changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false)
	Change the keyword for an entry,.
bool	merge (const dictionary &)
	Merge entries from the given dictionary.
void	clear ()
	Clear the dictionary.
void	transfer (dictionary &)
	Transfer the contents of the argument and annul the argument.
Xfer< dictionary >	xfer ()
	Transfer contents to the Xfer container.
bool	read (Istream &)
	Read dictionary from Istream.
void	write (Ostream &, bool subDict=true) const
ITstream &	operator[] (const word &) const
	Find and return entry.
void	operator= (const dictionary &)
void	operator+= (const dictionary &)
	Include entries from the given dictionary.
void	operator\|= (const dictionary &)
	Conditionally include entries from the given dictionary.
void	operator<<= (const dictionary &)
	Unconditionally include entries from the given dictionary.
Public Member Functions inherited from dictionaryName
	dictionaryName ()
	Construct dictionaryName null.
	dictionaryName (const fileName &name)
	Construct dictionaryName as copy of the given fileName.
const fileName &	name () const
	Return the dictionary name.
fileName &	name ()
	Return the dictionary name.
Public Member Functions inherited from IDLList< entry >
	IDLList ()
	Null construct.
	IDLList (const entry &a)
	Construct given initial T.
	IDLList (Istream &is, const INew &inewt)
	Construct from Istream using given Istream constructor class.
	IDLList (Istream &is)
	Construct from Istream.
	IDLList (const IDLList< entry > &idll, const CloneArg &cloneArg)
	Copy constructor with additional argument for clone.
Public Member Functions inherited from ILList< DLListBase, entry >
	ILList ()
	Null construct.
	ILList (entry *a)
	Construct given initial T.
	ILList (Istream &)
	Construct from Istream.
	ILList (const ILList< DLListBase, entry > &)
	Construct as copy.
	ILList (const ILList< DLListBase, entry > &lst, const CloneArg &cloneArg)
	Copy constructor with additional argument for clone.
	ILList (Istream &, const INew &)
	Construct from Istream using given Istream constructor class.
	~ILList ()
bool	eraseHead ()
	Remove the head element specified from the list and delete it.
bool	erase (entry *p)
	Remove the specified element from the list and delete it.
void	transfer (ILList< DLListBase, entry > &)
	Transfer the contents of the argument into this List.
void	operator= (const ILList< DLListBase, entry > &)
Public Member Functions inherited from UILList< DLListBase, entry >
	UILList ()
	Null construct.
	UILList (entry *a)
	Construct given initial T.
	UILList (const UILList< DLListBase, entry > &)
	Construct as copy.
entry *	first ()
	Return the first entry.
const entry *	first () const
	Return the first entry.
entry *	last ()
	Return the last entry.
const entry *	last () const
	Return the last entry.
entry *	removeHead ()
	Remove and return head.
entry *	remove (entry *p)
	Remove and return element.
entry *	remove (iterator &it)
	Remove and return specified by iterator.
void	operator= (const UILList< DLListBase, entry > &)
bool	operator== (const UILList< DLListBase, entry > &) const
	Equality operation on ULists of the same type.
bool	operator!= (const UILList< DLListBase, entry > &) const
	The opposite of the equality operation. Takes linear time.
Public Member Functions inherited from DLListBase
	DLListBase ()
	Null construct.
	DLListBase (link *)
	Construct given initial entry.
	~DLListBase ()
label	size () const
	Return number of elements in list.
bool	empty () const
	Return true if the list is empty.
void	insert (link *)
	Add at head of list.
void	append (link *)
	Add at tail of list.
bool	swapUp (link *)
	Swap this element with the one above unless it is at the top.
bool	swapDown (link *)
	Swap this element with the one below unless it is at the bottom.
link *	remove (link *)
	Remove and return element.
link *	replace (link oldLink, link newLink)
	Replace oldLink with newLink and return element.
link *	replace (iterator &oldIter, link *newLink)
	Replace oldIter with newLink and return element.
void	transfer (DLListBase &)
	Transfer the contents of the argument into this List.
iterator	begin ()
const_iterator	cbegin () const
const const_iterator &	cend () const
const_iterator	begin () const
const const_iterator &	end () const

Static Public Attributes
static bool	constructed
static bool	writeJobInfo
Static Public Attributes inherited from dictionary
static const dictionary	null
	Null dictionary.

Additional Inherited Members
Static Public Member Functions inherited from dictionary
static autoPtr< dictionary >	New (Istream &)
	Construct top-level dictionary on freestore from Istream.