Package saga :: Module _engine :: Class task

Class task

 object --+        
          |        
??.instance --+    
              |    
         object --+
                  |
                 task

Known Subclasses:

job._job.job

saga::task type

Inherited from object
Nested Classes
	routine_type
	task_state
	object_type

Instance Methods

__init__(...)
__init__( (object)arg1) -> None :

add_callback(...)
add_callback( (task)arg1, (str)arg2, (object)arg3) -> int : add a new callback to this task instance

cancel(...)
cancel( (task)arg1) -> None : cancel 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

get_state(...)
get_state( (task)arg1) -> task_state : returns the state of 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

run(...)
run( (task)arg1) -> None : run this task instance

wait(...)
wait( (task)arg1 [, (float)arg2]) -> bool : wait for this task instance to finish

Inherited from unreachable.instance: __new__

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

Inherited from 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

Inherited from object
Class Variables
	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`
	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`

Inherited from object
Properties
	object returns the SAGA object associated with this task instance
	state returns the state of this task instance
Inherited from `object`: `__class__`
	id returns the id of this instance
	session return the session associated with this object instance
	type returns the type of this instance

Method Details

init(...)
(Constructor)


__init__( (object)arg1) -> None :

    C++ signature :
        void __init__(_object*)

__init__( (object)arg1, (task_state)arg2) -> None :

    C++ signature :
        void __init__(_object*,saga::task_base::state)

Overrides: object.__init__

add_callback(...)


add_callback( (task)arg1, (str)arg2, (object)arg3) -> int :
    add a new callback to this task instance

    C++ signature :
        unsigned int add_callback(saga::task,std::string,boost::python::api::object)

add_callback( (task)arg1, (str)arg2, (object)arg3, (object)arg4) -> int :
    add a new callback to this task instance

    C++ signature :
        unsigned int add_callback(saga::task,std::string,boost::python::api::object,boost::python::api::object)

cancel(...)


cancel( (task)arg1) -> None :
    cancel this task instance

    C++ signature :
        void cancel(saga::task {lvalue})

get_metric(...)


get_metric( (task)arg1, (str)arg2) -> metric :
    returns a specific metric associated with this task instance

    C++ signature :
        saga::metric get_metric(saga::task {lvalue},std::string)

get_object(...)


get_object( (task)arg1) -> object :
    returns the SAGA object associated with this task instance

    C++ signature :
        saga::object get_object(saga::task {lvalue})

get_result(...)


get_result( (task)arg1) -> str :
    returns the result of the operation executed by this task instance

    C++ signature :
        std::string get_result(saga::task {lvalue})

get_result( (task)arg1) -> bool :
    returns the result of the operation executed by this task instance

    C++ signature :
        bool get_result(saga::task {lvalue})

get_result( (task)arg1) -> url :
    returns the result of the operation executed by this task instance

    C++ signature :
        saga::url get_result(saga::task {lvalue})

get_result( (task)arg1) -> object :
    returns the result of the operation executed by this task instance

    C++ signature :
        std::vector<saga::url, std::allocator<saga::url> > get_result(saga::task {lvalue})

get_state(...)


get_state( (task)arg1) -> task_state :
    returns the state of this task instance

    C++ signature :
        saga::task_base::state get_state(saga::task {lvalue})

list_metrics(...)


list_metrics( (task)arg1) -> object :
    returns the list of metrics associated with this task instance

    C++ signature :
        std::vector<saga::metric, std::allocator<saga::metric> > list_metrics(saga::task {lvalue})

remove_callback(...)


remove_callback( (task)arg1, (str)arg2, (int)arg3) -> None :
    remove the given callback from this task instance

    C++ signature :
        void remove_callback(saga::task {lvalue},std::string,unsigned int)

rethrow(...)


rethrow( (task)arg1) -> None :
    rethrow any error occurred during execution of task

    C++ signature :
        void rethrow(saga::task {lvalue})

run(...)


run( (task)arg1) -> None :
    run this task instance

    C++ signature :
        void run(saga::task {lvalue})

wait(...)


wait( (task)arg1 [, (float)arg2]) -> bool :
    wait for this task instance to finish

    C++ signature :
        bool wait(saga::task {lvalue} [,double])

Property Details

object

returns the SAGA object associated with this task instance

Get Method:: unreachable(...)

state

returns the state of this task instance

Get Method:: unreachable(...)