File: ChildCmdType.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 (72 lines) | stat: -rw-r--r-- 2,324 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
71
72
ecflow.ChildCmdType
///////////////////


.. py:class:: ChildCmdType
   :module: ecflow

   Bases: :py:class:`~Boost.Python.enum`

ChildCmdType represents the different :term:`child command`\ s.
This type is used as a parameter to the class :py:class:`ecflow.ZombieAttr`

Child commands are called within a :term:`job file`::

  ChildCmdType::init     corresponds to : ecflow_client --init=<process_id>
  ChildCmdType::event    corresponds to : ecflow_client --event=<event_name | number>
  ChildCmdType::meter    corresponds to : ecflow_client --meter=<meter_name>, <meter_value>
  ChildCmdType::label    corresponds to : ecflow_client --label=<label_name>. <label_value>
  ChildCmdType::wait     corresponds to : ecflow_client --wait=<expression>
  ChildCmdType::abort    corresponds to : ecflow_client --abort=<reason>
  ChildCmdType::complete corresponds to : ecflow_client --complete


.. py:attribute:: ChildCmdType.abort
   :module: ecflow
   :value: ecflow.ChildCmdType.abort


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


.. py:attribute:: ChildCmdType.event
   :module: ecflow
   :value: ecflow.ChildCmdType.event


.. py:attribute:: ChildCmdType.init
   :module: ecflow
   :value: ecflow.ChildCmdType.init


.. py:attribute:: ChildCmdType.label
   :module: ecflow
   :value: ecflow.ChildCmdType.label


.. py:attribute:: ChildCmdType.meter
   :module: ecflow
   :value: ecflow.ChildCmdType.meter


.. py:attribute:: ChildCmdType.names
   :module: ecflow
   :value: {'abort': ecflow.ChildCmdType.abort, 'complete': ecflow.ChildCmdType.complete, 'event': ecflow.ChildCmdType.event, 'init': ecflow.ChildCmdType.init, 'label': ecflow.ChildCmdType.label, 'meter': ecflow.ChildCmdType.meter, 'queue': ecflow.ChildCmdType.queue, 'wait': ecflow.ChildCmdType.wait}


.. py:attribute:: ChildCmdType.queue
   :module: ecflow
   :value: ecflow.ChildCmdType.queue


.. py:attribute:: ChildCmdType.values
   :module: ecflow
   :value: {0: ecflow.ChildCmdType.init, 1: ecflow.ChildCmdType.event, 2: ecflow.ChildCmdType.meter, 3: ecflow.ChildCmdType.label, 4: ecflow.ChildCmdType.wait, 5: ecflow.ChildCmdType.queue, 6: ecflow.ChildCmdType.abort, 7: ecflow.ChildCmdType.complete}


.. py:attribute:: ChildCmdType.wait
   :module: ecflow
   :value: ecflow.ChildCmdType.wait