Package saga :: Module _engine :: Class task
[hide private]
[frames] | no frames]

Class task

 object --+        
          |        
??.instance --+    
              |    
         object --+
                  |
                 task
Known Subclasses:

saga::task type

Nested Classes [hide private]
  routine_type
  task_state

Inherited from object: object_type

Instance Methods [hide private]
 
__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 object: __reduce__, clone, get_id, get_object_type_name, get_session, get_type

Inherited from unreachable.instance: __new__

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

Class Variables [hide private]
  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 object: Advert, AdvertDirectory, Buffer, Context, Directory, Endpoint, Exception, File, IOVec, Job, JobDescription, JobSelf, JobService, LogicalDirectory, LogicalFile, Metric, Msg, NSDirectory, NSEntry, Parameter, RPC, Session, Stream, StreamService, TaskContainer, URL, __instance_size__

Properties [hide private]
  object
returns the SAGA object associated with this task instance
  state
returns the state of this task instance

Inherited from object: id, session, type

Inherited from object: __class__

Method Details [hide private]

__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 [hide private]

object

returns the SAGA object associated with this task instance

Get Method:
unreachable(...)

state

returns the state of this task instance

Get Method:
unreachable(...)