simple_cluster.JobData Class Reference

List of all members.

Classes
class	CommandInfo
Public Member Functions
def	__init__
def	addCommand
def	getCommandLine
def	getCommandNames
def	getCommandArguments
def	getReturnVariableList
def	setReturnValues
def	getReturnValues
Public Attributes
	status
Private Attributes
	_commandList
	_returnValues

---

Detailed Description

This class incapsulates a single job.  The commandName is the name
of the task to be executed.  The jobInfo is a dictionary of all
parameters that need to be handled.

Definition at line 2697 of file simple_cluster.py.

---

Constructor & Destructor Documentation

def simple_cluster.JobData.__init__	(		self,
			commandName,
			commandInfo = {}
	)

Definition at line 2729 of file simple_cluster.py.

---

Member Function Documentation

def simple_cluster.JobData.addCommand	(		self,
			commandName,
			commandInfo
	)

Add an additional command to this Job to be exectued after
previous Jobs.

Definition at line 2736 of file simple_cluster.py.

References simple_cluster.JobData._commandList.

def simple_cluster.JobData.getCommandArguments	(		self,
			commandName = None
	)

This method will return the command arguments associated with a
particular job.
   * If commandName is not none the arguments for the command with
     that name are returned.
   * Otherwise a dictionary (with keys being the commandName and
     the value being the dictionary of arguments) is returned.
   * If there is only a single command the arguments for that
     command are returned as a dictionary.

Definition at line 2766 of file simple_cluster.py.

References simple_cluster.JobData._commandList.

def simple_cluster.JobData.getCommandLine

(

self

)

This method will return the command line(s) to be executed on the
remote engine.  It is usually only needed for debugging or for
the JobQueueManager.

Definition at line 2745 of file simple_cluster.py.

References simple_cluster.JobData._commandList.

def simple_cluster.JobData.getCommandNames

(

self

)

This method will return a list of command names that are associated
with this job.

Definition at line 2758 of file simple_cluster.py.

References simple_cluster.JobData._commandList.

def simple_cluster.JobData.getReturnValues

(

self

)

Definition at line 2792 of file simple_cluster.py.

References simple_cluster.JobData._returnValues.

def simple_cluster.JobData.getReturnVariableList

(

self

)

Definition at line 2786 of file simple_cluster.py.

References simple_cluster.JobData._commandList.

def simple_cluster.JobData.setReturnValues	(		self,
			valueList
	)

Definition at line 2789 of file simple_cluster.py.

References simple_cluster.JobData._returnValues.

---

Member Data Documentation

simple_cluster.JobData._commandList [private]

Definition at line 2730 of file simple_cluster.py.

Referenced by simple_cluster.JobData.addCommand(), simple_cluster.JobData.getCommandArguments(), simple_cluster.JobData.getCommandLine(), simple_cluster.JobData.getCommandNames(), and simple_cluster.JobData.getReturnVariableList().

simple_cluster.JobData._returnValues [private]

Definition at line 2733 of file simple_cluster.py.

Referenced by simple_cluster.JobData.getReturnValues(), and simple_cluster.JobData.setReturnValues().

simple_cluster.JobData.status

Definition at line 2731 of file simple_cluster.py.

---

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

• simple_cluster.py