File: Day.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 (37 lines) | stat: -rw-r--r-- 769 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
ecflow.Day
//////////


.. py:class:: Day
   :module: ecflow

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

Defines a :term:`day` dependency.

There can be multiple day dependencies. If a hybrid :term:`clock` is defined
on a suite, any node held by a day dependency will be set to :term:`complete` at the
beginning of the :term:`suite`, without the task ever being dispatched otherwise
the suite would never complete.

Constructor::

   Day(string)
      string: 'sunday','monday',etc
   Day(Days)
      Days day: Is an enumerator with represent the days of the week

Usage:

.. code-block:: python

   day1 = Day(Days.sunday)
   t = Task('t1',
           Day('tuesday'))


.. py:method:: Day.day( (Day)arg1) -> Days :
   :module: ecflow

Return the day as enumerator