<style type="text/css">
.highlight .hll { background-color: #ffffcc }
.highlight  { background: #eeffcc; }
.highlight .c { color: #408090; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #007020 } /* Comment.Preproc */
.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .go { color: #303030 } /* Generic.Output */
.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #0040D0 } /* Generic.Traceback */
.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #007020 } /* Keyword.Pseudo */
.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #902000 } /* Keyword.Type */
.highlight .m { color: #208050 } /* Literal.Number */
.highlight .s { color: #4070a0 } /* Literal.String */
.highlight .na { color: #4070a0 } /* Name.Attribute */
.highlight .nb { color: #007020 } /* Name.Builtin */
.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
.highlight .no { color: #60add5 } /* Name.Constant */
.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #007020 } /* Name.Exception */
.highlight .nf { color: #06287e } /* Name.Function */
.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #bb60d5 } /* Name.Variable */
.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mf { color: #208050 } /* Literal.Number.Float */
.highlight .mh { color: #208050 } /* Literal.Number.Hex */
.highlight .mi { color: #208050 } /* Literal.Number.Integer */
.highlight .mo { color: #208050 } /* Literal.Number.Oct */
.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
.highlight .sc { color: #4070a0 } /* Literal.String.Char */
.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
.highlight .sx { color: #c65d09 } /* Literal.String.Other */
.highlight .sr { color: #235388 } /* Literal.String.Regex */
.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
.highlight .ss { color: #517918 } /* Literal.String.Symbol */
.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */
</style>


<div class="section" id="using-python-scripting">
<span id="index-0"></span><span id="id1"></span>
<p>As you have already seen, ecFlow has a <a class="reference internal" href="/wiki/display/ECFLOW/ecFlow+Python+Api#python-api"><em>ecFlow Python Api</em></a>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c">#!/usr/bin/env python2.5</span>
<span class="kn">import</span> <span class="nn">ecflow</span> 
</pre></div>
</div>
<div class="line-block">
<div class="line">This allows the <a class="reference internal" href="../../../glossary/#term-suite-definition"><em class="xref std std-term">suite definition</em></a> to be built with python.</div>
<div class="line">It also allows communication with the <a class="reference internal" href="../../../glossary/#term-ecf-server"><em class="xref std std-term">ecf_server</em></a>.</div>
</div>
<div class="line-block">
<div class="line">This is a very powerful feature, that helps to define very complex suites in a relatively compact way.</div>
<div class="line">Consider the following <a class="reference internal" href="../../../glossary/#term-suite"><em class="xref std std-term">suite</em></a></div>
</div>
<div class="highlight-python"><pre>suite test
 family f1
     task a
     task b
     task c
     task d
     task e
 endfamily
 family f2
     task a
     task b
     task c
     task d
     task e
 endfamily
 family f3
     task a
     task b
     task c
     task d
     task e
 endfamily
 family f4
     task a
     task b
     task c
     task d
     task e
 endfamily
 family f5
     task a
     task b
     task c
     task d
     task e
 endfamily
 family f6
     task a
     task b
     task c
     task d
     task e
 endfamily
endsuite</pre>
</div>
<p>This can be written in python as:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">create_suite</span><span class="p">(</span><span class="n">name</span><span class="p">)</span> <span class="p">:</span> 
    <span class="n">suite</span> <span class="o">=</span> <span class="n">ecflow</span><span class="o">.</span><span class="n">Suite</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
    <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">7</span><span class="p">)</span> <span class="p">:</span>
        <span class="n">fam</span> <span class="o">=</span> <span class="n">suite</span><span class="o">.</span><span class="n">add_family</span><span class="p">(</span><span class="s">&quot;f&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">i</span><span class="p">))</span>
        <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="p">(</span> <span class="s">&quot;a&quot;</span><span class="p">,</span> <span class="s">&quot;b&quot;</span><span class="p">,</span> <span class="s">&quot;c&quot;</span><span class="p">,</span> <span class="s">&quot;d&quot;</span><span class="p">,</span> <span class="s">&quot;e&quot;</span> <span class="p">)</span> <span class="p">:</span>
            <span class="n">fam</span><span class="o">.</span><span class="n">add_task</span><span class="p">(</span><span class="n">t</span><span class="p">);</span>
    <span class="k">return</span> <span class="n">suite</span>     
 
</pre></div>
</div>
<div class="line-block">
<div class="line">Python variables can be used to generate <a class="reference internal" href="../../../glossary/#term-trigger"><em class="xref std std-term">trigger</em></a> <a class="reference internal" href="../../../glossary/#term-dependencies"><em class="xref std std-term">dependencies</em></a>.</div>
<div class="line">Imagine that we want to chain the families f1 to f6, so that f2 runs after f1, f3 after f2 and so on.</div>
<div class="line">The following will do the trick:</div>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">create_seqeuntial_suite</span><span class="p">(</span><span class="n">name</span><span class="p">)</span> <span class="p">:</span>
    <span class="n">suite</span> <span class="o">=</span> <span class="n">ecflow</span><span class="o">.</span><span class="n">Suite</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
    <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">7</span><span class="p">)</span> <span class="p">:</span>
        <span class="n">fam</span> <span class="o">=</span> <span class="n">suite</span><span class="o">.</span><span class="n">add_family</span><span class="p">(</span><span class="s">&quot;f&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">i</span><span class="p">))</span>
        <span class="k">if</span> <span class="n">i</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span> 
            <span class="n">fam</span><span class="o">.</span><span class="n">add_trigger</span><span class="p">(</span><span class="s">&quot;f&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">i</span><span class="o">-</span><span class="mi">1</span><span class="p">)</span> <span class="o">+</span> <span class="s">&quot; == complete&quot;</span><span class="p">)</span>  <span class="c">#  or fam.add_family( &quot;f%d == complete&quot; % (i-1) )</span>
        <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="p">(</span> <span class="s">&quot;a&quot;</span><span class="p">,</span> <span class="s">&quot;b&quot;</span><span class="p">,</span> <span class="s">&quot;c&quot;</span><span class="p">,</span> <span class="s">&quot;d&quot;</span><span class="p">,</span> <span class="s">&quot;e&quot;</span> <span class="p">)</span> <span class="p">:</span>
            <span class="n">fam</span><span class="o">.</span><span class="n">add_task</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> 
    <span class="k">return</span> <span class="n">suite</span>
 
</pre></div>
</div>
<div class="line-block">
<div class="line">The following python code shows <strong>examples</strong> of adding the various attributes to a <a class="reference internal" href="../../../glossary/#term-node"><em class="xref std std-term">node</em></a> tree.</div>
<div class="line">For a detailed  explanation please consult the user manual.</div>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># provides *examples* of add adding node attributes using the python API</span>
<span class="c"># hence does *not* represent a real suite definition</span>
<span class="kn">from</span> <span class="nn">ecflow</span> <span class="kn">import</span> <span class="o">*</span>
    
<span class="k">def</span> <span class="nf">list_to_int_vec</span><span class="p">(</span> <span class="n">thePythonList</span> <span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Converts a python list to a C++ IntVec in ecflow extension &quot;&quot;&quot;</span>
    <span class="n">intvec</span> <span class="o">=</span> <span class="n">IntVec</span><span class="p">()</span>
    <span class="k">for</span> <span class="n">theInt</span> <span class="ow">in</span> <span class="n">thePythonList</span><span class="p">:</span>
        <span class="n">IntVec</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">intvec</span><span class="p">,</span><span class="n">theInt</span><span class="p">)</span>
    <span class="k">return</span> <span class="n">intvec</span>
    
<span class="k">def</span> <span class="nf">list_to_str_vec</span><span class="p">(</span> <span class="n">theList</span> <span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Converts a python list to a C++ StrVec in ecflow extension&quot;&quot;&quot;</span>
    <span class="n">strvec</span> <span class="o">=</span> <span class="n">StrVec</span><span class="p">()</span>
    <span class="k">for</span> <span class="n">theStr</span> <span class="ow">in</span> <span class="n">theList</span><span class="p">:</span>
        <span class="n">StrVec</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">strvec</span><span class="p">,</span><span class="n">theStr</span><span class="p">)</span>
    <span class="k">return</span> <span class="n">strvec</span><span class="p">;</span> 

<span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">&quot;__main__&quot;</span><span class="p">:</span>

    <span class="c"># adding variables </span>
    <span class="n">suite</span> <span class="o">=</span> <span class="n">Suite</span><span class="p">(</span><span class="s">&quot;s1&quot;</span><span class="p">);</span>
    <span class="n">suite</span><span class="o">.</span><span class="n">add_variable</span><span class="p">(</span><span class="n">Variable</span><span class="p">(</span><span class="s">&quot;ECF_HOME&quot;</span><span class="p">,</span><span class="s">&quot;/tmp/&quot;</span><span class="p">))</span>
    <span class="n">suite</span><span class="o">.</span><span class="n">add_variable</span><span class="p">(</span><span class="s">&quot;ECF_URL_CMD&quot;</span><span class="p">,</span> <span class="s">&quot;${BROWSER:=firefox} -remote &#39;openURL(</span><span class="si">%E</span><span class="s">CF_URL_BASE%/</span><span class="si">%E</span><span class="s">CF_URL%)&#39;&quot;</span><span class="p">)</span>
     
    <span class="c"># adding limits</span>
    <span class="n">suite</span><span class="o">.</span><span class="n">add_limit</span><span class="p">(</span>  <span class="n">Limit</span><span class="p">(</span><span class="s">&quot;limitName1&quot;</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span> <span class="p">)</span>
    <span class="n">suite</span><span class="o">.</span><span class="n">add_limit</span><span class="p">(</span>  <span class="s">&quot;limitName3&quot;</span><span class="p">,</span> <span class="mi">10</span> <span class="p">)</span>
  
    <span class="c"># adding inlimits</span>
    <span class="n">suite</span><span class="o">.</span><span class="n">add_inlimit</span><span class="p">(</span> <span class="n">InLimit</span><span class="p">(</span><span class="s">&quot;limitName1&quot;</span><span class="p">,</span><span class="s">&quot;/s1/f1&quot;</span><span class="p">,</span><span class="mi">2</span><span class="p">)</span> <span class="p">)</span>
    <span class="n">suite</span><span class="o">.</span><span class="n">add_inlimit</span><span class="p">(</span> <span class="s">&quot;limitName3&quot;</span><span class="p">,</span><span class="s">&quot;/s1/f1&quot;</span><span class="p">,</span><span class="mi">2</span><span class="p">)</span>
 
    <span class="c"># add short triggers and complete</span>
    <span class="n">task</span> <span class="o">=</span> <span class="n">Task</span><span class="p">(</span><span class="s">&quot;task&quot;</span><span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_trigger</span><span class="p">(</span> <span class="s">&quot;t2 == active&quot;</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_complete</span><span class="p">(</span> <span class="s">&quot;t2 == complete&quot;</span> <span class="p">)</span>
      
    <span class="c"># add long triggers and complete, in example below &#39;True&#39; mean AND and &#39;False&#39; means OR</span>
    <span class="n">task</span> <span class="o">=</span> <span class="n">Task</span><span class="p">(</span><span class="s">&quot;trigger&quot;</span><span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_part_trigger</span><span class="p">(</span>  <span class="s">&quot;t1 == complete&quot;</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_part_trigger</span><span class="p">(</span>  <span class="s">&quot;t2 == active&quot;</span><span class="p">,</span><span class="bp">True</span> <span class="p">)</span>  <span class="c">#  for long and/or expressions, subsequent expr must be and/or</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_part_complete</span><span class="p">(</span> <span class="s">&quot;t3 == complete&quot;</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_part_complete</span><span class="p">(</span> <span class="s">&quot;t4 == active&quot;</span><span class="p">,</span><span class="bp">False</span><span class="p">)</span>  <span class="c">#  for long and/or expressions, subsequent expr must be and/or</span>
    
    <span class="c"># add events</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_event</span><span class="p">(</span> <span class="n">Event</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_event</span><span class="p">(</span> <span class="mi">2</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_event</span><span class="p">(</span> <span class="n">Event</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span><span class="s">&quot;Eventname&quot;</span><span class="p">)</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_event</span><span class="p">(</span> <span class="mi">10</span><span class="p">,</span><span class="s">&quot;Eventname2&quot;</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_event</span><span class="p">(</span> <span class="s">&quot;fred&quot;</span> <span class="p">)</span>

    <span class="c"># add meter</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_meter</span><span class="p">(</span> <span class="n">Meter</span><span class="p">(</span><span class="s">&quot;metername1&quot;</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mi">100</span><span class="p">,</span><span class="mi">50</span><span class="p">)</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_meter</span><span class="p">(</span> <span class="s">&quot;metername3&quot;</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mi">100</span> <span class="p">)</span>
  
    <span class="c"># add label</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_label</span><span class="p">(</span> <span class="n">Label</span><span class="p">(</span><span class="s">&quot;label_name1&quot;</span><span class="p">,</span> <span class="s">&quot;value&quot;</span><span class="p">)</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_label</span><span class="p">(</span> <span class="s">&quot;label_name3&quot;</span><span class="p">,</span> <span class="s">&quot;value&quot;</span> <span class="p">)</span>
 
    <span class="c"># add Repeat. A node can only have one repeat, hence we delete the repeat before, adding another</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_repeat</span><span class="p">(</span> <span class="n">RepeatInteger</span><span class="p">(</span><span class="s">&quot;integer&quot;</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mi">100</span><span class="p">,</span><span class="mi">2</span><span class="p">)</span> <span class="p">);</span>  
    <span class="n">task</span><span class="o">.</span><span class="n">delete_repeat</span><span class="p">();</span>      
    <span class="n">task</span><span class="o">.</span><span class="n">add_repeat</span><span class="p">(</span> <span class="n">RepeatEnumerated</span><span class="p">(</span><span class="s">&quot;enum&quot;</span><span class="p">,</span><span class="n">list_to_str_vec</span><span class="p">(</span> <span class="p">[</span><span class="s">&quot;red&quot;</span><span class="p">,</span> <span class="s">&quot;green&quot;</span><span class="p">,</span> <span class="s">&quot;blue&quot;</span> <span class="p">]</span> <span class="p">))</span> <span class="p">);</span> 
    <span class="n">task</span><span class="o">.</span><span class="n">delete_repeat</span><span class="p">();</span>      
    <span class="n">task</span><span class="o">.</span><span class="n">add_repeat</span><span class="p">(</span> <span class="n">RepeatDate</span><span class="p">(</span><span class="s">&quot;date&quot;</span><span class="p">,</span><span class="mi">20100111</span><span class="p">,</span><span class="mi">20100115</span><span class="p">,</span><span class="mi">2</span><span class="p">)</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">delete_repeat</span><span class="p">();</span>          
    <span class="n">task</span><span class="o">.</span><span class="n">add_repeat</span><span class="p">(</span> <span class="n">RepeatString</span><span class="p">(</span><span class="s">&quot;string&quot;</span><span class="p">,</span> <span class="n">list_to_str_vec</span><span class="p">(</span> <span class="p">[</span><span class="s">&quot;a&quot;</span><span class="p">,</span> <span class="s">&quot;b&quot;</span><span class="p">,</span> <span class="s">&quot;c&quot;</span> <span class="p">]</span> <span class="p">))</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">delete_repeat</span><span class="p">();</span>          
    
    <span class="c"># create a time series, used for adding time and today and cron</span>
    <span class="n">start</span> <span class="o">=</span> <span class="n">TimeSlot</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">)</span>
    <span class="n">finish</span> <span class="o">=</span> <span class="n">TimeSlot</span><span class="p">(</span><span class="mi">23</span><span class="p">,</span><span class="mi">0</span><span class="p">)</span>
    <span class="n">incr</span> <span class="o">=</span> <span class="n">TimeSlot</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="mi">30</span><span class="p">)</span>
    <span class="n">time_series</span> <span class="o">=</span> <span class="n">TimeSeries</span><span class="p">(</span> <span class="n">start</span><span class="p">,</span> <span class="n">finish</span><span class="p">,</span> <span class="n">incr</span><span class="p">,</span> <span class="bp">True</span><span class="p">);</span> <span class="c"># True means relative to suite start</span>
  
    <span class="c"># add a today</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_today</span><span class="p">(</span> <span class="s">&quot;00:30&quot;</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_today</span><span class="p">(</span> <span class="s">&quot;+00:30&quot;</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_today</span><span class="p">(</span> <span class="s">&quot;+00:30 20:00 01:00&quot;</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_today</span><span class="p">(</span> <span class="n">Today</span><span class="p">(</span> <span class="n">time_series</span><span class="p">)</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_today</span><span class="p">(</span> <span class="n">Today</span><span class="p">(</span> <span class="mi">0</span><span class="p">,</span><span class="mi">10</span> <span class="p">))</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_today</span><span class="p">(</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">59</span><span class="p">,</span> <span class="bp">True</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_today</span><span class="p">(</span> <span class="n">Today</span><span class="p">(</span><span class="n">TimeSlot</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span><span class="mi">10</span><span class="p">))</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_today</span><span class="p">(</span> <span class="n">Today</span><span class="p">(</span><span class="n">TimeSlot</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span><span class="mi">20</span><span class="p">),</span><span class="bp">False</span><span class="p">))</span> 
                    
    <span class="c"># add time</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_time</span><span class="p">(</span> <span class="s">&quot;00:30&quot;</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_time</span><span class="p">(</span> <span class="s">&quot;+00:30&quot;</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_time</span><span class="p">(</span> <span class="s">&quot;+00:30 20:00 01:00&quot;</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_time</span><span class="p">(</span> <span class="n">Time</span><span class="p">(</span><span class="n">time_series</span> <span class="p">))</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_time</span><span class="p">(</span> <span class="n">Time</span><span class="p">(</span> <span class="mi">0</span><span class="p">,</span><span class="mi">10</span> <span class="p">))</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_time</span><span class="p">(</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">59</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_time</span><span class="p">(</span> <span class="n">Time</span><span class="p">(</span><span class="n">TimeSlot</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span><span class="mi">10</span><span class="p">))</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_time</span><span class="p">(</span> <span class="n">Time</span><span class="p">(</span><span class="n">TimeSlot</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span><span class="mi">20</span><span class="p">),</span><span class="bp">False</span><span class="p">))</span> 
 
    <span class="c"># add date</span>
    <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="p">[</span> <span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">4</span><span class="p">,</span><span class="mi">8</span><span class="p">,</span><span class="mi">16</span> <span class="p">]</span> <span class="p">:</span>
      <span class="n">task</span><span class="o">.</span><span class="n">add_date</span><span class="p">(</span> <span class="n">i</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">)</span>    <span class="c"># day,month,year, where corresponding 0 means any possible day,month, year</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_date</span><span class="p">(</span> <span class="n">Date</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">2010</span><span class="p">))</span>

    <span class="c"># add day</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_day</span><span class="p">(</span> <span class="n">Day</span><span class="p">(</span><span class="n">Days</span><span class="o">.</span><span class="n">sunday</span><span class="p">))</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_day</span><span class="p">(</span> <span class="n">Days</span><span class="o">.</span><span class="n">monday</span><span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_day</span><span class="p">(</span> <span class="s">&quot;tuesday&quot;</span><span class="p">)</span>
    
    <span class="c"># create cron, showing different ways adding the time, to a cron attribute</span>
    <span class="n">cron</span> <span class="o">=</span> <span class="n">Cron</span><span class="p">()</span>
    <span class="n">cron</span><span class="o">.</span><span class="n">set_week_days</span><span class="p">(</span> <span class="n">list_to_int_vec</span><span class="p">(</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">,</span><span class="mi">4</span><span class="p">,</span><span class="mi">5</span><span class="p">,</span><span class="mi">6</span><span class="p">]</span> <span class="p">)</span> <span class="p">)</span>
    <span class="n">cron</span><span class="o">.</span><span class="n">set_days_of_month</span><span class="p">(</span> <span class="n">list_to_int_vec</span><span class="p">(</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">,</span><span class="mi">4</span><span class="p">,</span><span class="mi">5</span><span class="p">,</span><span class="mi">6</span><span class="p">]</span> <span class="p">)</span> <span class="p">)</span>
    <span class="n">cron</span><span class="o">.</span><span class="n">set_months</span><span class="p">(</span> <span class="n">list_to_int_vec</span><span class="p">(</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">,</span><span class="mi">4</span><span class="p">,</span><span class="mi">5</span><span class="p">,</span><span class="mi">6</span><span class="p">]</span> <span class="p">)</span> <span class="p">)</span>
    <span class="n">start</span> <span class="o">=</span> <span class="n">TimeSlot</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="mi">0</span><span class="p">)</span>
    <span class="n">finish</span> <span class="o">=</span> <span class="n">TimeSlot</span><span class="p">(</span><span class="mi">23</span><span class="p">,</span><span class="mi">0</span><span class="p">)</span>
    <span class="n">incr</span> <span class="o">=</span> <span class="n">TimeSlot</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span><span class="mi">30</span><span class="p">)</span>
    <span class="n">ts</span> <span class="o">=</span> <span class="n">TimeSeries</span><span class="p">(</span> <span class="n">start</span><span class="p">,</span> <span class="n">finish</span><span class="p">,</span> <span class="n">incr</span><span class="p">,</span> <span class="bp">True</span><span class="p">);</span>  <span class="c"># True means relative to suite start</span>
    <span class="n">cron</span><span class="o">.</span><span class="n">set_time_series</span><span class="p">(</span> <span class="n">ts</span> <span class="p">)</span>

    <span class="n">cron1</span> <span class="o">=</span> <span class="n">Cron</span><span class="p">()</span>
    <span class="n">cron1</span><span class="o">.</span><span class="n">set_week_days</span><span class="p">(</span> <span class="n">list_to_int_vec</span><span class="p">(</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">,</span><span class="mi">4</span><span class="p">,</span><span class="mi">5</span><span class="p">,</span><span class="mi">6</span><span class="p">]</span> <span class="p">)</span> <span class="p">)</span>
    <span class="n">cron1</span><span class="o">.</span><span class="n">set_time_series</span><span class="p">(</span> <span class="mi">1</span><span class="p">,</span><span class="mi">30</span><span class="p">,</span>  <span class="bp">True</span> <span class="p">)</span>
    
    <span class="n">cron2</span> <span class="o">=</span> <span class="n">Cron</span><span class="p">()</span>
    <span class="n">cron2</span><span class="o">.</span><span class="n">set_week_days</span><span class="p">(</span> <span class="n">list_to_int_vec</span><span class="p">(</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">,</span><span class="mi">4</span><span class="p">,</span><span class="mi">5</span><span class="p">,</span><span class="mi">6</span><span class="p">]</span> <span class="p">)</span> <span class="p">)</span>
    <span class="n">cron2</span><span class="o">.</span><span class="n">set_time_series</span><span class="p">(</span> <span class="s">&quot;00:30 01:30 00:01&quot;</span> <span class="p">)</span>
    
    <span class="n">cron3</span> <span class="o">=</span> <span class="n">Cron</span><span class="p">()</span>
    <span class="n">cron3</span><span class="o">.</span><span class="n">set_week_days</span><span class="p">(</span> <span class="n">list_to_int_vec</span><span class="p">(</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">,</span><span class="mi">4</span><span class="p">,</span><span class="mi">5</span><span class="p">,</span><span class="mi">6</span><span class="p">]</span> <span class="p">)</span> <span class="p">)</span>
    <span class="n">cron3</span><span class="o">.</span><span class="n">set_time_series</span><span class="p">(</span> <span class="s">&quot;+00:30&quot;</span> <span class="p">)</span>
    
    <span class="c"># add auto cancel</span>
    <span class="n">t1</span> <span class="o">=</span> <span class="n">Task</span><span class="p">(</span><span class="s">&quot;t1&quot;</span><span class="p">);</span>
    <span class="n">t3</span> <span class="o">=</span> <span class="n">Task</span><span class="p">(</span><span class="s">&quot;t3&quot;</span><span class="p">)</span>
    <span class="n">t4</span> <span class="o">=</span> <span class="n">Task</span><span class="p">(</span><span class="s">&quot;t4&quot;</span><span class="p">)</span>
    <span class="n">t5</span> <span class="o">=</span> <span class="n">Task</span><span class="p">(</span><span class="s">&quot;t5&quot;</span><span class="p">)</span>
    <span class="n">t1</span><span class="o">.</span><span class="n">add_autocancel</span><span class="p">(</span> <span class="mi">3</span> <span class="p">)</span>                       <span class="c"># 3 days</span>
    <span class="n">t3</span><span class="o">.</span><span class="n">add_autocancel</span><span class="p">(</span> <span class="mi">20</span><span class="p">,</span><span class="mi">10</span><span class="p">,</span><span class="bp">True</span> <span class="p">)</span>              <span class="c"># hour,minutes,relative</span>
    <span class="n">t4</span><span class="o">.</span><span class="n">add_autocancel</span><span class="p">(</span> <span class="n">TimeSlot</span><span class="p">(</span><span class="mi">10</span><span class="p">,</span><span class="mi">10</span><span class="p">),</span><span class="bp">True</span> <span class="p">)</span>    <span class="c"># hour,minutes,relative</span>
    <span class="n">t5</span><span class="o">.</span><span class="n">add_autocancel</span><span class="p">(</span> <span class="n">Autocancel</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">10</span><span class="p">,</span><span class="bp">True</span><span class="p">)</span> <span class="p">)</span>   <span class="c"># hour,minutes,relative</span>
    
    <span class="c"># add late</span>
    <span class="n">late</span> <span class="o">=</span> <span class="n">Late</span><span class="p">()</span>
    <span class="n">late</span><span class="o">.</span><span class="n">submitted</span><span class="p">(</span> <span class="n">TimeSlot</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span><span class="mi">10</span><span class="p">)</span> <span class="p">)</span>
    <span class="n">late</span><span class="o">.</span><span class="n">active</span><span class="p">(</span>    <span class="n">TimeSlot</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span><span class="mi">10</span><span class="p">))</span>
    <span class="n">late</span><span class="o">.</span><span class="n">complete</span><span class="p">(</span>  <span class="n">TimeSlot</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span><span class="mi">10</span><span class="p">),</span><span class="bp">True</span><span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_late</span><span class="p">(</span>  <span class="n">late</span> <span class="p">)</span>
    
    <span class="n">late</span> <span class="o">=</span> <span class="n">Late</span><span class="p">()</span>
    <span class="n">late</span><span class="o">.</span><span class="n">submitted</span><span class="p">(</span> <span class="mi">20</span><span class="p">,</span><span class="mi">10</span> <span class="p">)</span>
    <span class="n">late</span><span class="o">.</span><span class="n">active</span><span class="p">(</span>    <span class="mi">20</span><span class="p">,</span><span class="mi">10</span> <span class="p">)</span>
    <span class="n">late</span><span class="o">.</span><span class="n">complete</span><span class="p">(</span>  <span class="mi">20</span><span class="p">,</span><span class="mi">10</span><span class="p">,</span><span class="bp">True</span><span class="p">)</span>
    <span class="n">t1</span><span class="o">.</span><span class="n">add_late</span><span class="p">(</span> <span class="n">late</span> <span class="p">)</span>
    
    <span class="c"># add defstatus, last one set takes effect</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_defstatus</span><span class="p">(</span> <span class="n">DState</span><span class="o">.</span><span class="n">complete</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_defstatus</span><span class="p">(</span> <span class="n">DState</span><span class="o">.</span><span class="n">queued</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_defstatus</span><span class="p">(</span> <span class="n">DState</span><span class="o">.</span><span class="n">aborted</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_defstatus</span><span class="p">(</span> <span class="n">DState</span><span class="o">.</span><span class="n">submitted</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_defstatus</span><span class="p">(</span> <span class="n">DState</span><span class="o">.</span><span class="n">suspended</span> <span class="p">)</span>
    <span class="n">task</span><span class="o">.</span><span class="n">add_defstatus</span><span class="p">(</span> <span class="n">DState</span><span class="o">.</span><span class="n">active</span> <span class="p">)</span>
    
    <span class="c"># add clock,</span>
    <span class="n">clock</span> <span class="o">=</span> <span class="n">Clock</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">2010</span><span class="p">,</span><span class="bp">False</span><span class="p">);</span>      <span class="c"># day,month, year, hybrid(true), real(False)</span>
    <span class="n">clock</span><span class="o">.</span><span class="n">set_gain</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">10</span><span class="p">,</span><span class="bp">True</span><span class="p">);</span>          <span class="c"># True means positive gain</span>
    <span class="n">suite</span> <span class="o">=</span>  <span class="n">Suite</span><span class="p">(</span><span class="s">&quot;suite&quot;</span><span class="p">)</span>
    <span class="n">suite</span><span class="o">.</span><span class="n">add_clock</span><span class="p">(</span><span class="n">clock</span><span class="p">);</span>
    
    <span class="n">clock</span> <span class="o">=</span> <span class="n">Clock</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">2011</span><span class="p">,</span><span class="bp">True</span><span class="p">);</span>       <span class="c"># day,month,year,hybrid</span>
    <span class="n">clock</span><span class="o">.</span><span class="n">set_gain_in_seconds</span><span class="p">(</span><span class="mi">12</span><span class="p">,</span><span class="bp">True</span><span class="p">);</span>
    <span class="n">s1</span> <span class="o">=</span>  <span class="n">Suite</span><span class="p">(</span><span class="s">&quot;s1&quot;</span><span class="p">)</span>
    <span class="n">s1</span><span class="o">.</span><span class="n">add_clock</span><span class="p">(</span><span class="n">clock</span><span class="p">)</span>    
</pre></div>
</div>
</div>