ecflow.DState

class ecflow.DState

Bases: enum

A DState is like a ecflow.State, except for the addition of SUSPENDED

Suspended stops job generation, and hence is an attribute of a Node. DState can be used for setting the default state of node when it is begun or re queued. DState is used for defining defstatus. See ecflow.Node.add_defstatus and ecflow.Defstatus The default state of a node is queued.

Usage:

task = ecflow.Task('t1')
task.add_defstatus(ecflow.DState.complete)   task = ecflow.Task('t2')
task += Defstatus('complete')
task = Task('t3',
            Defstatus('complete')) # create in place
DState.aborted = ecflow.DState.aborted
DState.active = ecflow.DState.active
DState.complete = ecflow.DState.complete
DState.names = {'aborted': ecflow.DState.aborted, 'active': ecflow.DState.active, 'complete': ecflow.DState.complete, 'queued': ecflow.DState.queued, 'submitted': ecflow.DState.submitted, 'suspended': ecflow.DState.suspended, 'unknown': ecflow.DState.unknown}
DState.queued = ecflow.DState.queued
DState.submitted = ecflow.DState.submitted
DState.suspended = ecflow.DState.suspended
DState.unknown = ecflow.DState.unknown
DState.values = {0: ecflow.DState.unknown, 1: ecflow.DState.complete, 2: ecflow.DState.queued, 3: ecflow.DState.aborted, 4: ecflow.DState.submitted, 5: ecflow.DState.active, 6: ecflow.DState.suspended}