File: Style.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 (61 lines) | stat: -rw-r--r-- 1,749 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
ecflow.Style
////////////


.. py:class:: Style
   :module: ecflow

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

Style is used to control printing output for the definition

- DEFS:  This style outputs the definition file in a format that is parse-able.
         and can be re-loaded back into the server.
         Externs are automatically added.
         This excludes the edit history.
- STATE: The output includes additional state information for debug
         This excludes the edit history
- MIGRATE: Output includes structure and state, allow migration to future ecflow versions
         This includes edit history. If file is reloaded no checking is done

The following shows a summary of the features associated with each choice

   ===================== ==== ===== =======
   Functionality         DEFS STATE MIGRATE
   ===================== ==== ===== =======
   Auto generate externs  Yes  Yes   No
   Checking on reload     Yes  Yes   No
   Edit History           No   No    Yes
   Show trigger AST       No   Yes   No
   ===================== ==== ===== =======


.. py:attribute:: Style.DEFS
   :module: ecflow
   :value: ecflow.Style.DEFS


.. py:attribute:: Style.MIGRATE
   :module: ecflow
   :value: ecflow.Style.MIGRATE


.. py:attribute:: Style.NOTHING
   :module: ecflow
   :value: ecflow.Style.NOTHING


.. py:attribute:: Style.STATE
   :module: ecflow
   :value: ecflow.Style.STATE


.. py:attribute:: Style.names
   :module: ecflow
   :value: {'DEFS': ecflow.Style.DEFS, 'MIGRATE': ecflow.Style.MIGRATE, 'NOTHING': ecflow.Style.NOTHING, 'STATE': ecflow.Style.STATE}


.. py:attribute:: Style.values
   :module: ecflow
   :value: {0: ecflow.Style.NOTHING, 1: ecflow.Style.DEFS, 2: ecflow.Style.STATE, 3: ecflow.Style.MIGRATE}