File: DState.rst

package info (click to toggle)
ecflow 5.15.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 51,868 kB
  • sloc: cpp: 269,341; python: 22,756; sh: 3,609; perl: 770; xml: 333; f90: 204; ansic: 141; makefile: 70
file content (70 lines) | stat: -rw-r--r-- 1,913 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
ecflow.DState
/////////////


.. py:class:: DState
   :module: ecflow

   Bases: :py:class:`~Boost.Python.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 :term:`defstatus`.
See :py:class:`ecflow.Node.add_defstatus` and :py:class:`ecflow.Defstatus`
The default state of a :term:`node` is :term:`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


.. py:attribute:: DState.aborted
   :module: ecflow
   :value: ecflow.DState.aborted


.. py:attribute:: DState.active
   :module: ecflow
   :value: ecflow.DState.active


.. py:attribute:: DState.complete
   :module: ecflow
   :value: ecflow.DState.complete


.. py:attribute:: DState.names
   :module: ecflow
   :value: {'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}


.. py:attribute:: DState.queued
   :module: ecflow
   :value: ecflow.DState.queued


.. py:attribute:: DState.submitted
   :module: ecflow
   :value: ecflow.DState.submitted


.. py:attribute:: DState.suspended
   :module: ecflow
   :value: ecflow.DState.suspended


.. py:attribute:: DState.unknown
   :module: ecflow
   :value: ecflow.DState.unknown


.. py:attribute:: DState.values
   :module: ecflow
   :value: {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}