File: Flag.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 (49 lines) | stat: -rw-r--r-- 945 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
ecflow.Flag
///////////


.. py:class:: Flag
   :module: ecflow

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

Represents additional state associated with a Node.


.. py:method:: Flag.clear( (Flag)arg1, (FlagType)arg2) -> None :
   :module: ecflow

Clear the given flag. Used in test only


.. py:method:: Flag.is_set( (Flag)arg1, (FlagType)arg2) -> bool :
   :module: ecflow

Queries if a given flag is set


.. py:method:: Flag.list() -> FlagTypeVec :
   :module: ecflow
   :staticmethod:

Returns the list of all flag types. returns FlagTypeVec. Used in test only


.. py:method:: Flag.reset( (Flag)arg1) -> None :
   :module: ecflow

Clears all flags. Used in test only


.. py:method:: Flag.set( (Flag)arg1, (FlagType)arg2) -> None :
   :module: ecflow

Sets the given flag. Used in test only


.. py:method:: Flag.type_to_string( (FlagType)arg1) -> str :
   :module: ecflow
   :staticmethod:

Convert type to a string. Used in test only