Package saga :: Package job :: Class self
[frames] | no frames]

Class self

source code

 object --+                    
          |                    
??.instance --+                
              |                
 _engine.object --+            
                  |            
       _engine.task --+        
                      |        
               _job.job --+    
                          |    
                  _job.self --+
                              |
                             self

Nested Classes
    Inherited from _engine.task
  routine_type
  task_state
    Inherited from _engine.object
  object_type
Instance Methods

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

    Inherited from _job.self
 
add_metric(...)
add_metric( (self)arg1, (metric)arg2) -> bool : add a metric to this job instance
 
fire_metric(...)
fire_metric( (self)arg1, (str)arg2) -> None : fire the given metric
 
remove_metric(...)
remove_metric( (self)arg1, (str)arg2) -> None : remove a metric from this job instance
    Inherited from _job.job
 
__init__(...)
Raises an exception This class cannot be instantiated from Python
 
attribute_exists(...)
attribute_exists( (job)arg1, (str)arg2) -> bool : tests if the given attribute exists for this instance (plain)
 
attribute_is_readonly(...)
attribute_is_readonly( (job)arg1, (str)arg2) -> bool : tests if the given attribute is read only (plain)
 
attribute_is_removable(...)
attribute_is_removable( (job)arg1, (str)arg2) -> bool : tests if the given attribute is removable (plain)
 
attribute_is_vector(...)
attribute_is_vector( (job)arg1, (str)arg2) -> bool : tests if the given attribute is a vector attribute (plain)
 
attribute_is_writable(...)
attribute_is_writable( (job)arg1, (str)arg2) -> bool : tests if the given attribute is writable (plain)
 
cancel(...)
cancel( (job)arg1 [, (float)arg2]) -> None : cancel this job (plain)
 
checkpoint(...)
checkpoint( (job)arg1) -> None : checkpoint this job (plain)
 
find_attributes(...)
find_attributes( (job)arg1, (str)arg2) -> object : find attributes matching the given pattern (plain)
 
get_attribute(...)
get_attribute( (job)arg1, (str)arg2) -> str : returns a (scalar) attribute associated with this object (plain)
 
get_description(...)
get_description( (job)arg1) -> description : get a copy of the job description this job was created from (plain)
 
get_job_id(...)
get_job_id( (job)arg1) -> str : get the job id of this job (plain)
 
get_state(...)
get_state( (job)arg1) -> job_state : get the state of this job (plain)
 
get_stderr(...)
get_stderr( (job)arg1) -> object : get a file object representing the stderr of the spawned job (plain)
 
get_stdin(...)
get_stdin( (job)arg1) -> object : get a file object representing the stdin of the spawned job (plain)
 
get_stdout(...)
get_stdout( (job)arg1) -> object : get a file object representing the stdout of the spawned job (plain)
 
get_vector_attribute(...)
get_vector_attribute( (job)arg1, (str)arg2) -> object : returns a (vector) attribute associated with this object (plain)
 
list_attributes(...)
list_attributes( (job)arg1) -> object : lists the keys of all attributes associated with this object (plain)
 
migrate(...)
migrate( (job)arg1, (description)arg2) -> None : migrate this job (plain)
 
remove_attribute(...)
remove_attribute( (job)arg1, (str)arg2) -> None : removes an attribute associated with this object (plain)
 
resume(...)
resume( (job)arg1) -> None : resume this job (plain)
 
run(...)
run( (job)arg1) -> None : run this job (plain)
 
set_attribute(...)
set_attribute( (job)arg1, (str)arg2, (str)arg3) -> None : sets a (scalar) attribute associated with this object (plain)
 
set_vector_attribute(...)
set_vector_attribute( (job)arg1, (str)arg2, (object)arg3) -> None : sets a (vector) attribute associated with this object (plain)
 
signal(...)
signal( (job)arg1, (int)arg2) -> None : send a signal to this job (plain)
 
suspend(...)
suspend( (job)arg1) -> None : suspend this job (plain)
 
wait(...)
wait( (job)arg1 [, (float)arg2]) -> bool : wait for this job (plain)
    Inherited from _engine.task
 
add_callback(...)
add_callback( (task)arg1, (str)arg2, (object)arg3) -> int : add a new callback to this task instance
 
get_metric(...)
get_metric( (task)arg1, (str)arg2) -> metric : returns a specific metric associated with this task instance
 
get_object(...)
get_object( (task)arg1) -> object : returns the SAGA object associated with this task instance
 
get_result(...)
get_result( (task)arg1) -> str : returns the result of the operation executed by this task instance
 
list_metrics(...)
list_metrics( (task)arg1) -> object : returns the list of metrics associated with this task instance
 
remove_callback(...)
remove_callback( (task)arg1, (str)arg2, (int)arg3) -> None : remove the given callback from this task instance
 
rethrow(...)
rethrow( (task)arg1) -> None : rethrow any error occurred during execution of task
    Inherited from _engine.object
 
__reduce__(...)
helper for pickle
 
clone(...)
clone( (object)arg1) -> object : create a deep copy of the object
 
get_id(...)
get_id( (object)arg1) -> uuid : returns the id of this instance
 
get_object_type_name(...)
get_object_type_name( (object_type)arg1) -> str : return the name of a given object type
 
get_session(...)
get_session( (object)arg1) -> session : return the session associated with this object instance
 
get_type(...)
get_type( (object)arg1) -> object_type : returns the type of this instance
Class Variables
    Inherited from _engine.task
  Async = saga._engine.routine_type.Async
  Canceled = saga._engine.task_state.Canceled
  Done = saga._engine.task_state.Done
  Failed = saga._engine.task_state.Failed
  New = saga._engine.task_state.New
  Running = saga._engine.task_state.Running
  Sync = saga._engine.routine_type.Sync
  Task = saga._engine.routine_type.Task
  Unknown = saga._engine.task_state.Unknown
    Inherited from _engine.object
  Advert = saga._engine.object_type.Advert
  AdvertDirectory = saga._engine.object_type.AdvertDirectory
  Buffer = saga._engine.object_type.Buffer
  CPRCheckpoint = saga._engine.object_type.CPRCheckpoint
  CPRDirectory = saga._engine.object_type.CPRDirectory
  CPRJob = saga._engine.object_type.CPRJob
  CPRJobDescription = saga._engine.object_type.CPRJobDescription
  CPRJobSelf = saga._engine.object_type.CPRJobSelf
  CPRJobService = saga._engine.object_type.CPRJobService
  Context = saga._engine.object_type.Context
  Directory = saga._engine.object_type.Directory
  Endpoint = saga._engine.object_type.Endpoint
  EntityData = saga._engine.object_type.EntityData
  EntityDataSet = saga._engine.object_type.EntityDataSet
  EntityNavigator = saga._engine.object_type.EntityNavigator
  Exception = saga._engine.object_type.Exception
  File = saga._engine.object_type.File
  IOVec = saga._engine.object_type.IOVec
  Job = saga._engine.object_type.Job
  JobDescription = saga._engine.object_type.JobDescription
  JobSelf = saga._engine.object_type.JobSelf
  JobService = saga._engine.object_type.JobService
  LogicalDirectory = saga._engine.object_type.LogicalDirectory
  LogicalFile = saga._engine.object_type.LogicalFile
  Metric = saga._engine.object_type.Metric
  Msg = saga._engine.object_type.Msg
  NSDirectory = saga._engine.object_type.NSDirectory
  NSEntry = saga._engine.object_type.NSEntry
  Parameter = saga._engine.object_type.Parameter
  RPC = saga._engine.object_type.RPC
  ServiceData = saga._engine.object_type.ServiceData
  ServiceDescription = saga._engine.object_type.ServiceDescription
  ServiceDiscoverer = saga._engine.object_type.ServiceDiscoverer
  Session = saga._engine.object_type.Session
  Stream = saga._engine.object_type.Stream
  StreamServer = saga._engine.object_type.StreamServer
  TaskContainer = saga._engine.object_type.TaskContainer
  URL = saga._engine.object_type.URL
  __instance_size__ = 32
Properties

Inherited from object: __class__

    Inherited from _engine.task
  object
returns the SAGA object associated with this task instance
  state
returns the state of this task instance
    Inherited from _engine.object
  id
returns the id of this instance
  session
return the session associated with this object instance
  type
returns the type of this instance