<div id="add-a-complete">
<span id="add-complete"></span><span id="index-0"></span>
<div >
<div >Sometimes you do not want to run a <a href="/wiki/display/ECFLOW/Glossary#term-task"><em >task</em></a> when a certain condition is met.</div>
<div >In this case you can use the <a href="/wiki/display/ECFLOW/Glossary#term-complete-trigger"><em >complete trigger</em></a> keyword.</div>
<div >This has a similar syntax to the <a href="/wiki/display/ECFLOW/Glossary#term-trigger"><em >trigger</em></a> keyword but sets a <a href="/wiki/display/ECFLOW/Glossary#term-task"><em >task</em></a></div>
<div ><a href="/wiki/display/ECFLOW/Glossary#term-complete"><em >complete</em></a> rather than running it.</div>
</div>
<div >
<div >It can be used in conjunction with a <a href="/wiki/display/ECFLOW/Glossary#term-trigger"><em >trigger</em></a>. For example:</div>
</div>
<div ><pre># Definition of the suite test.
suite test
edit ECF_INCLUDE "$HOME/course"
edit ECF_HOME "$HOME/course"
family f1
edit SLEEP 20
task t1
task t2
trigger t1 eq complete
event a
event b
task t3
trigger t2:a
task t4
trigger t2 eq complete
complete t2:b
endfamily
endsuite</pre>
</div>
<p>In python this would be:</p>
<div ><div ><pre><span >#!/usr/bin/env python2.5</span>
<span >import</span> <span >os</span>
<span >import</span> <span >ecflow</span>
<span >def</span> <span >create_family_f1</span><span >():</span>
<span >f1</span> <span >=</span> <span >ecflow</span><span >.</span><span >Family</span><span >(</span><span >"f1"</span><span >)</span>
<span >f1</span><span >.</span><span >add_variable</span><span >(</span><span >"SLEEP"</span><span >,</span><span >20</span><span >)</span>
<span >f1</span><span >.</span><span >add_task</span><span >(</span><span >"t1"</span><span >)</span>
<span >t2</span> <span >=</span> <span >f1</span><span >.</span><span >add_task</span><span >(</span><span >"t2"</span><span >)</span>
<span >t2</span><span >.</span><span >add_trigger</span><span >(</span><span >"t1 eq complete"</span><span >)</span>
<span >t2</span><span >.</span><span >add_event</span><span >(</span><span >"a"</span><span >)</span>
<span >t2</span><span >.</span><span >add_event</span><span >(</span><span >"b"</span><span >)</span>
<span >t3</span> <span >=</span> <span >f1</span><span >.</span><span >add_task</span><span >(</span><span >"t3"</span><span >)</span>
<span >t3</span><span >.</span><span >add_trigger</span><span >(</span><span >"t2:a"</span><span >)</span>
<span >t4</span> <span >=</span> <span >f1</span><span >.</span><span >add_task</span><span >(</span><span >"t4"</span><span >)</span>
<span >t4</span><span >.</span><span >add_trigger</span><span >(</span><span >"t2 eq complete"</span><span >)</span>
<span >t4</span><span >.</span><span >add_complete</span><span >(</span><span >"t2:b"</span><span >)</span>
<span >return</span> <span >f1</span>
<span >defs</span> <span >=</span> <span >ecflow</span><span >.</span><span >Defs</span><span >(</span><span >"test.def"</span><span >)</span>
<span >suite</span> <span >=</span> <span >defs</span><span >.</span><span >add_suite</span><span >(</span><span >"test"</span><span >)</span>
<span >suite</span><span >.</span><span >add_variable</span><span >(</span><span >"ECF_INCLUDE"</span><span >,</span><span >os</span><span >.</span><span >getenv</span><span >(</span><span >"HOME"</span><span >)</span> <span >+</span> <span >"/course"</span><span >)</span>
<span >suite</span><span >.</span><span >add_variable</span><span >(</span><span >"ECF_HOME "</span><span >,</span><span >os</span><span >.</span><span >getenv</span><span >(</span><span >"HOME"</span><span >)</span> <span >+</span> <span >"/course"</span><span >)</span>
<span >suite</span><span >.</span><span >add_family</span><span >(</span> <span >create_family_f1</span><span >()</span> <span >)</span>
</pre></div>
</div>
<div >
<div >Completes are used to declare dependencies between two tasks.</div>
<div >For instance, complete <strong>t2:b</strong> might indicate that a specific</div>
<div >event has not occurred so we do not need to run task <strong>t4</strong>.</div>
</div>
<div >
<div >When <a href="/wiki/display/ECFLOW/Glossary#term-ecf-server"><em >ecf_server</em></a> tries to start a <a href="/wiki/display/ECFLOW/Glossary#term-task"><em >task</em></a>, it evaluates the <a href="/wiki/display/ECFLOW/Glossary#term-trigger"><em >trigger</em></a></div>
<div >and <a href="/wiki/display/ECFLOW/Glossary#term-complete-trigger"><em >complete trigger</em></a> expressions. If the <a href="/wiki/display/ECFLOW/Glossary#term-complete-trigger"><em >complete trigger</em></a> condition is correct,</div>
<div >the task will set itself <a href="/wiki/display/ECFLOW/Glossary#term-complete"><em >complete</em></a>.</div>
</div>
<p><a href="/wiki/display/ECFLOW/Glossary#term-complete-trigger"><em >complete trigger</em></a> evaluation takes precedence over the <a href="/wiki/display/ECFLOW/Glossary#term-trigger"><em >trigger</em></a>.</p>
<p>Completes can be between tasks, between families, or both.</p>
<p>What to do:</p>
<ol >
<li>Edit the <a href="/wiki/display/ECFLOW/Glossary#term-suite-definition"><em >suite definition</em></a> file or python to add a complete to task <strong>t4</strong></li>
<li>Load the definition again</li>
<li>Observe the tasks in <a href="/wiki/display/ECFLOW/Glossary#term-ecflowview"><em >ecFlowview</em></a></li>
<li>See the triggers by selecting <strong>t4</strong> and clicking on the <img alt="triggers" src="/wiki/download/attachments/7373012/triggers.jpg" /> icon</li>
<li>See the trigger relation by clicking on the arrow</li>
<li>See the triggers in the tree, using the Show menu</li>
<li>Note the icon indicating that the task has not run</li>
<li>You can modify task <strong>t2</strong> to check that task <strong>t4</strong> will run when the event is not set</li>
</ol>
</div>
|