python::GBSTask::GBSProtoJob Class Reference

List of all members.

Public Member Functions

def __init__
def GetType
def __repr__
def AsString
def GetLocalEnvironment
def GetScriptLocalArgs
def GetLocalInputSandbox
def GetLocalOutputSandbox
def SetLocalEnvironment
def SetScriptLocalArgs
def SetLocalInputSandbox
def SetLocalOutputSandbox

Private Attributes

 __name
 __scriptLocalArgs
 __localEnvironment
 __localInputSandbox
 __localOutputSandbox


Detailed Description

A potential job made actual through the Task.PromoteProtoJob() method.

Protojobs allow users to create large numbers of jobs
automatically using scripts or data files and review and correct
them before "promoting" them into jobs.  As such they are easy
to create and destroy, are not persisted and are consequently lost at
program termination, unless promoted.

GBSProtoJob emulate the following small subset of a real job:-

GetType()
  Return object type.

GetScriptLocalArgs()
  Return (as a string) the list of application script args that are local to this job

SetScriptLocalArgs(args_str)
  Set (as a string) the list of application script args that are local to this job

  e.g.  job.SetScriptLocalArgs('123 "a string with spaces" 456')

Definition at line 885 of file GBSTask.py.


Member Function Documentation

def python::GBSTask::GBSProtoJob::__init__ (   self,
  name 
)

Definition at line 910 of file GBSTask.py.

00910                            :
00911         self.__name               = name
00912         self.__scriptLocalArgs    = ""
00913         self.__localEnvironment   = ""
00914         self.__localInputSandbox  = ""
00915         self.__localOutputSandbox = ""
00916         
00917 
    def GetType(self): return "GBSProtoJob"

def python::GBSTask::GBSProtoJob::GetType (   self  ) 

Definition at line 918 of file GBSTask.py.

00918                      : return "GBSProtoJob"
00919 

def python::GBSTask::GBSProtoJob::__repr__ (   self  ) 

Definition at line 920 of file GBSTask.py.

00920                       : return self.AsString()
00921     
00922     

def python::GBSTask::GBSProtoJob::AsString (   self,
  level = "Brief" 
)

Return string description.

 Return string description at the following levels:-
"Brief"    one line summary suitable for rows in tables
"Heading"  one line summary suitable as heading for "Brief" 

Definition at line 923 of file GBSTask.py.

00923                                       :
00924 
00925         """Return string description.
00926 
00927          Return string description at the following levels:-
00928         "Brief"    one line summary suitable for rows in tables
00929         "Heading"  one line summary suitable as heading for "Brief" """
00930 
00931         if ( level == "Heading"):
00932             s  = "Name".ljust(20)
00933             s += "Status".ljust(23)
00934             s += "Input".ljust(40)
00935             s += "Status Details"
00936             return s
00937         s  = self.__name.ljust(20)
00938         s += "(protojob)".ljust(23)
00939         s += (self.__scriptLocalArgs + ";" + self.__localEnvironment).ljust(40)
00940         return s
00941 
    def GetLocalEnvironment(self):

def python::GBSTask::GBSProtoJob::GetLocalEnvironment (   self  ) 

Return, as a comma separated list string, the environment that is local to this job

Definition at line 942 of file GBSTask.py.

00942                                  :
00943         """Return, as a comma separated list string, the environment that is local to this job"""
00944         return self.__localEnvironment 
00945 
    def GetScriptLocalArgs(self):

def python::GBSTask::GBSProtoJob::GetScriptLocalArgs (   self  ) 

Return (as a string) the list of application script args that are local to this job

Definition at line 946 of file GBSTask.py.

00946                                 :
00947         """Return (as a string) the list of application script args that are local to this job"""
00948         return self.__scriptLocalArgs
00949     
    def GetLocalInputSandbox(self):

def python::GBSTask::GBSProtoJob::GetLocalInputSandbox (   self  ) 

Return, as a comma separated list string, the input sandbox file list that is local to this job.

Definition at line 950 of file GBSTask.py.

00950                                   :
00951         """Return, as a comma separated list string, the input sandbox file list that is local to this job."""
00952         return self.__localInputSandbox
00953     
    def GetLocalOutputSandbox(self):

def python::GBSTask::GBSProtoJob::GetLocalOutputSandbox (   self  ) 

Return, as a comma separated list string, the ouput sandbox file list that is local to this job.

Definition at line 954 of file GBSTask.py.

00954                                    :
00955         """Return, as a comma separated list string, the ouput sandbox file list that is local to this job."""
00956         return self.__localOutputSandbox
00957 
    def SetLocalEnvironment(self,env_str):

def python::GBSTask::GBSProtoJob::SetLocalEnvironment (   self,
  env_str 
)

Set, as a comma separated list string, the environment that local to this job..

Definition at line 958 of file GBSTask.py.

00958                                          :
00959         """Set, as a comma separated list string, the environment that local to this job.."""
00960         self.__localEnvironment = env_str
00961 
    def SetScriptLocalArgs(self,arg_str):

def python::GBSTask::GBSProtoJob::SetScriptLocalArgs (   self,
  arg_str 
)

Set (as a string) the comma separated list of application script args that are local to this job.

Definition at line 962 of file GBSTask.py.

00962                                         :
00963         """Set (as a string) the comma separated list of application script args that are local to this job."""
00964         self.__scriptLocalArgs  = arg_str
00965 
    def SetLocalInputSandbox(self,in_sbox_str):

def python::GBSTask::GBSProtoJob::SetLocalInputSandbox (   self,
  in_sbox_str 
)

Set, as a comma separated list string, the input sandbox file list that is local to this job

Definition at line 966 of file GBSTask.py.

00966                                               :
00967         """Set, as a comma separated list string, the input sandbox file list that is local to this job"""
00968         (ok,str) = GBSUtilities.ProcessSandboxSetup(self,in_sbox_str,"input")
00969         if ok:
00970             # Store the raw input sandbox file list; files won't get stored until promotion.
00971             self.__localInputSandbox = in_sbox_str
00972 
    def SetLocalOutputSandbox(self,out_sbox_str):

def python::GBSTask::GBSProtoJob::SetLocalOutputSandbox (   self,
  out_sbox_str 
)

Set, as a comma separated list string, the output sandbox file list that is local to this job.

Definition at line 973 of file GBSTask.py.

00973                                                 :
00974         """Set, as a comma separated list string, the output sandbox file list that is local to this job."""
00975 
00976         (ok,str) = GBSUtilities.ProcessSandboxSetup(self,out_sbox_str,"output")
00977         if ok:
00978             self.__localOutputSandbox = str
            self.__localOutputSandbox = str


Member Data Documentation

python::GBSTask::GBSProtoJob::__name [private]

Definition at line 911 of file GBSTask.py.

python::GBSTask::GBSProtoJob::__scriptLocalArgs [private]

Definition at line 912 of file GBSTask.py.

python::GBSTask::GBSProtoJob::__localEnvironment [private]

Definition at line 913 of file GBSTask.py.

python::GBSTask::GBSProtoJob::__localInputSandbox [private]

Definition at line 914 of file GBSTask.py.

python::GBSTask::GBSProtoJob::__localOutputSandbox [private]

Definition at line 915 of file GBSTask.py.


The documentation for this class was generated from the following file:
Generated on Mon Feb 18 14:42:03 2008 for gbs by  doxygen 1.5.4