File: RepeatEnumerated.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,110 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.RepeatEnumerated
///////////////////////


.. py:class:: RepeatEnumerated
   :module: ecflow

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

Allows a node to be repeated using a enumerated list.

A :term:`node` can only have one :term:`repeat`.
The repeat can be referenced in :term:`trigger` expressions.

Constructor::

   RepeatEnumerated(variable,list)
      string variable:     The name of the repeat. The current enumeration index can be
                           referenced in trigger expressions using the variable name
      vector list:         The list of enumerations

Usage:

.. code-block:: python

   t = Task('t1',
            RepeatEnumerated('COLOR', [ 'red', 'green', 'blue' ] ))


.. py:method:: RepeatEnumerated.end( (RepeatEnumerated)arg1) -> int
   :module: ecflow


.. py:method:: RepeatEnumerated.name( (RepeatEnumerated)arg1) -> str :
   :module: ecflow

Return the name of the :term:`repeat`.


.. py:method:: RepeatEnumerated.start( (RepeatEnumerated)arg1) -> int
   :module: ecflow


.. py:method:: RepeatEnumerated.step( (RepeatEnumerated)arg1) -> int
   :module: ecflow