python.trfUtils.JobGroup Class Reference

JobGroup: a set of Job objects and pieces of information relevant to a given set of Job objects. More...

Inheritance diagram for python.trfUtils.JobGroup:

Collaboration diagram for python.trfUtils.JobGroup:

Public Member Functions
	__init__ (self, jobs=None, name=None, timeout=None)
	initialisation method
	name (self)
	__str__ (self)
	return an object self description string @ detail This method returns an object description string consisting of a listing of the items of the object self.
	timeoutStatus (self)
	return Boolean JobGroup timeout status
	printout (self)
	print in a human-readable way the items of the object self

Public Attributes
	jobs = jobs
	className = self.__class__.__name__
bool	completeStatus = False
	timeStampSubmission = None
int	timeout = 0
list	results = []

Protected Attributes
	_name = uniqueIdentifier()

Detailed Description

JobGroup: a set of Job objects and pieces of information relevant to a given set of Job objects.

A JobGroup is a set of Job objects and pieces of information relevant to a given set of Job objects. A JobGroup object comprises a name, a list of Job objects, a timeout and, ultimately, an ordered list of result objects. The timeout can be speecified or derived from the summation of the timeout specifications of the set of Job objects.

Parameters

name	the JobGroup object name
jobs	the list of Job objects
timeout	the JobGroup object timeout specification in seconds

Definition at line 789 of file trfUtils.py.

Constructor & Destructor Documentation

__init__()

python.trfUtils.JobGroup.__init__	(		self,
			jobs = None,
			name = None,
			timeout = None )

initialisation method

Definition at line 792 of file trfUtils.py.

        ):
        self.jobs = jobs
        self.className = self.__class__.__name__
        self.completeStatus = False
        self.timeStampSubmission = None
        if name is None:
            self._name = uniqueIdentifier()
        else:
            self._name = name
        #self.timeStampSubmissionComplete = None #delete
        if timeout is None:
            self.timeout = 0
            for job in self.jobs:
                self.timeout += job.workFunctionTimeout
        self.results = []
 

Member Function Documentation

__str__()

python.trfUtils.JobGroup.__str__

(

self

)

return an object self description string @ detail This method returns an object description string consisting of a listing of the items of the object self.

Returns

object description string

Definition at line 821 of file trfUtils.py.

    def __str__(self):
        descriptionString = ""
        for key, value in sorted(vars(self).items()):
            descriptionString += str("{key}:{value} ".format(
                key = key,
                value = value)
            )
        return descriptionString
 

name()

python.trfUtils.JobGroup.name

(

self

)

Definition at line 814 of file trfUtils.py.

    def name(self):
        return self._name
 

printout()

python.trfUtils.JobGroup.printout

(

self

)

print in a human-readable way the items of the object self

This function prints in a human-readable way the items of the object self.

Definition at line 852 of file trfUtils.py.

    def printout(self):
        printHR(vars(self))
 
 

timeoutStatus()

python.trfUtils.JobGroup.timeoutStatus

(

self

)

return Boolean JobGroup timeout status

This method returns the timeout status of a JobGroup object. If the JobGroup object has not timed out, the Boolean False is returned. If the JobGroup object has timed out, the Boolean True is returned. If the JobGroup object has been completed or is not submitted, the Boolean False is returned.

Returns

Boolean indicating the JobGroup timeout status

Definition at line 837 of file trfUtils.py.

    def timeoutStatus(self):
        # If the JobGroup is complete or not submitted, then it is not timed
        # out.
        if self.completeStatus is True or self.timeStampSubmission is None:
            return False
        # If the JobGroup is not complete or submitted, then it may be timed
        # out.
        elif time.time() > self.timeout + self.timeStampSubmission:
            return True
        else:
            return False
 

Member Data Documentation

_name

python.trfUtils.JobGroup._name = uniqueIdentifier()

protected

Definition at line 803 of file trfUtils.py.

className

python.trfUtils.JobGroup.className = self.__class__.__name__

Definition at line 799 of file trfUtils.py.

completeStatus

bool python.trfUtils.JobGroup.completeStatus = False

Definition at line 800 of file trfUtils.py.

jobs

python.trfUtils.JobGroup.jobs = jobs

Definition at line 798 of file trfUtils.py.

results

list python.trfUtils.JobGroup.results = []

Definition at line 811 of file trfUtils.py.

timeout

int python.trfUtils.JobGroup.timeout = 0

Definition at line 808 of file trfUtils.py.

timeStampSubmission

python.trfUtils.JobGroup.timeStampSubmission = None

Definition at line 801 of file trfUtils.py.

---

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

• trfUtils.py