File: Late.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 (91 lines) | stat: -rw-r--r-- 2,924 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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
ecflow.Late
///////////


.. py:class:: Late
   :module: ecflow

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

Sets the :term:`late` flag.

When a Node is classified as being late, the only action :term:`ecflow_server` can take
is to set a flag. The GUI will display this alongside the :term:`node` name as a icon.
Only one Late attribute can be specified on a Node.

Constructor::

   Late()
   Late(kwargs)

Usage:

.. code-block:: python

   # This is interpreted as: The node can stay :term:`submitted` for a maximum of 15 minutes
   # and it must become :term:`active` by 20:00 and the run time must not exceed 2 hours
   late = Late()
   late.submitted( 0,15 )
   late.active(   20,0 )
   late.complete(  2,0, true )

   late = Late(submitted='00:15',active='20:00',complete='+02:00')
   t = Task('t1',
            Late(submitted='00:15',active='20:00'))


.. py:method:: Late.active( (Late)arg1, (int)arg2, (int)arg3) -> None :
   :module: ecflow

active(hour,minute): The time the node must become :term:`active`. If the node is still :term:`queued` or :term:`submitted`
    by the time specified, the late flag is set

active( (Late)arg1, (TimeSlot)arg2) -> None :
    active(TimeSlot):The time the node must become :term:`active`. If the node is still :term:`queued` or :term:`submitted`
    by the time specified, the late flag is set

active( (Late)arg1) -> TimeSlot :
    Return the active time as a TimeSlot


.. py:method:: Late.complete( (Late)arg1, (int)arg2, (int)arg3, (bool)arg4) -> None :
   :module: ecflow

complete(hour,minute):The time the node must become :term:`complete`. If relative, time is taken from the time
    the node became :term:`active`, otherwise node must be :term:`complete` by the time given

complete( (Late)arg1, (TimeSlot)arg2, (bool)arg3) -> None :
    complete(TimeSlot): The time the node must become :term:`complete`. If relative, time is taken from the time
    the node became :term:`active`, otherwise node must be :term:`complete` by the time given

complete( (Late)arg1) -> TimeSlot :
    Return the complete time as a TimeSlot


.. py:method:: Late.complete_is_relative( (Late)arg1) -> bool :
   :module: ecflow

Returns a boolean where true means that complete is relative


.. py:method:: Late.is_late( (Late)arg1) -> bool :
   :module: ecflow

Return True if late


.. py:method:: Late.submitted( (Late)arg1, (TimeSlot)arg2) -> None :
   :module: ecflow

submitted(TimeSlot):The time node can stay :term:`submitted`. Submitted is always relative. If the node stays
    submitted longer than the time specified, the :term:`late` flag is set
    

submitted( (Late)arg1, (int)arg2, (int)arg3) -> None :
    submitted(hour,minute) The time node can stay submitted. Submitted is always relative. If the node stays
    submitted longer than the time specified, the late flag is set
    

submitted( (Late)arg1) -> TimeSlot :
    Return the submitted time as a TimeSlot