File: RepeatInteger.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 (48 lines) | stat: -rw-r--r-- 1,148 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
ecflow.RepeatInteger
////////////////////


.. py:class:: RepeatInteger
   :module: ecflow

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

Allows a :term:`node` to be repeated using a integer range.

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

Constructor::

   RepeatInteger(variable,start,end,step)
      string variable:     The name of the repeat. The current integer value can be
                           referenced in trigger expressions using the variable name
      int start:           Start integer value
      int end:             End end integer value
      int step<optional>:  Default = 1, The step amount

Usage:

.. code-block:: python

   t = Task('t1',
            RepeatInteger('HOUR', 6, 24, 6 ))


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


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

Return the name of the repeat.


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


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