File: CheckPt.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 (46 lines) | stat: -rw-r--r-- 1,259 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
ecflow.CheckPt
//////////////


.. py:class:: CheckPt
   :module: ecflow

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

CheckPt is enum that is used to control check pointing in the :term:`ecflow_server`

- NEVER  : Switches of check pointing
- ON_TIME: :term:`check point` file is saved periodically, specified by checkPtInterval. This is the default.
- ALWAYS : :term:`check point` file is saved after any state change, *not* recommended for large definitions
- UNDEFINED : None of the the above, used to provide default argument


.. py:attribute:: CheckPt.ALWAYS
   :module: ecflow
   :value: ecflow.CheckPt.ALWAYS


.. py:attribute:: CheckPt.NEVER
   :module: ecflow
   :value: ecflow.CheckPt.NEVER


.. py:attribute:: CheckPt.ON_TIME
   :module: ecflow
   :value: ecflow.CheckPt.ON_TIME


.. py:attribute:: CheckPt.UNDEFINED
   :module: ecflow
   :value: ecflow.CheckPt.UNDEFINED


.. py:attribute:: CheckPt.names
   :module: ecflow
   :value: {'ALWAYS': ecflow.CheckPt.ALWAYS, 'NEVER': ecflow.CheckPt.NEVER, 'ON_TIME': ecflow.CheckPt.ON_TIME, 'UNDEFINED': ecflow.CheckPt.UNDEFINED}


.. py:attribute:: CheckPt.values
   :module: ecflow
   :value: {0: ecflow.CheckPt.NEVER, 1: ecflow.CheckPt.ON_TIME, 2: ecflow.CheckPt.ALWAYS, 3: ecflow.CheckPt.UNDEFINED}