doc/sphinx/_build/html/_layout/nepi.execution.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8
   9     <title>nepi.execution package &mdash; NEPI 3.0 documentation</title>
  10
  11     <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
  12     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  13
  14     <script type="text/javascript">
  15       var DOCUMENTATION_OPTIONS = {
  16         URL_ROOT:    '../',
  17         VERSION:     '3.0',
  18         COLLAPSE_INDEX: false,
  19         FILE_SUFFIX: '.html',
  20         HAS_SOURCE:  true
  21       };
  22     </script>
  23     <script type="text/javascript" src="../_static/jquery.js"></script>
  24     <script type="text/javascript" src="../_static/underscore.js"></script>
  25     <script type="text/javascript" src="../_static/doctools.js"></script>
  26     <link rel="top" title="NEPI 3.0 documentation" href="../index.html" />
  27   </head>
  28   <body>
  29     <div class="related">
  30       <h3>Navigation</h3>
  31       <ul>
  32         <li class="right" style="margin-right: 10px">
  33           <a href="../genindex.html" title="General Index"
  34              accesskey="I">index</a></li>
  35         <li class="right" >
  36           <a href="../py-modindex.html" title="Python Module Index"
  37              >modules</a> |</li>
  38         <li><a href="../index.html">NEPI 3.0 documentation</a> &raquo;</li>
  39       </ul>
  40     </div>
  41       <div class="sphinxsidebar">
  42         <div class="sphinxsidebarwrapper">
  43   <h3><a href="../index.html">Table Of Contents</a></h3>
  44   <ul>
  45 <li><a class="reference internal" href="#">nepi.execution package</a><ul>
  46 <li><a class="reference internal" href="#submodules">Submodules</a></li>
  47 <li><a class="reference internal" href="#module-nepi.execution.attribute">nepi.execution.attribute module</a></li>
  48 <li><a class="reference internal" href="#module-nepi.execution.ec">nepi.execution.ec module</a></li>
  49 <li><a class="reference internal" href="#module-nepi.execution.resource">nepi.execution.resource module</a></li>
  50 <li><a class="reference internal" href="#module-nepi.execution.runner">nepi.execution.runner module</a></li>
  51 <li><a class="reference internal" href="#module-nepi.execution.scheduler">nepi.execution.scheduler module</a></li>
  52 <li><a class="reference internal" href="#module-nepi.execution.tags">nepi.execution.tags module</a></li>
  53 <li><a class="reference internal" href="#module-nepi.execution.trace">nepi.execution.trace module</a></li>
  54 <li><a class="reference internal" href="#module-nepi.execution">Module contents</a></li>
  55 </ul>
  56 </li>
  57 </ul>
  58
  59   <h3>This Page</h3>
  60   <ul class="this-page-menu">
  61     <li><a href="../_sources/_layout/nepi.execution.txt"
  62            rel="nofollow">Show Source</a></li>
  63   </ul>
  64 <div id="searchbox" style="display: none">
  65   <h3>Quick search</h3>
  66     <form class="search" action="../search.html" method="get">
  67       <input type="text" name="q" />
  68       <input type="submit" value="Go" />
  69       <input type="hidden" name="check_keywords" value="yes" />
  70       <input type="hidden" name="area" value="default" />
  71     </form>
  72     <p class="searchtip" style="font-size: 90%">
  73     Enter search terms or a module, class or function name.
  74     </p>
  75 </div>
  76 <script type="text/javascript">$('#searchbox').show(0);</script>
  77         </div>
  78       </div>
  79
  80     <div class="document">
  81       <div class="documentwrapper">
  82         <div class="bodywrapper">
  83           <div class="body">
  84
  85   <div class="section" id="nepi-execution-package">
  86 <h1>nepi.execution package<a class="headerlink" href="#nepi-execution-package" title="Permalink to this headline">¶</a></h1>
  87 <div class="section" id="submodules">
  88 <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
  89 </div>
  90 <div class="section" id="module-nepi.execution.attribute">
  91 <span id="nepi-execution-attribute-module"></span><h2>nepi.execution.attribute module<a class="headerlink" href="#module-nepi.execution.attribute" title="Permalink to this headline">¶</a></h2>
  92 <dl class="class">
  93 <dt id="nepi.execution.attribute.Attribute">
  94 <em class="property">class </em><tt class="descclassname">nepi.execution.attribute.</tt><tt class="descname">Attribute</tt><big>(</big><em>name</em>, <em>help</em>, <em>type='STRING'</em>, <em>flags=None</em>, <em>default=None</em>, <em>allowed=None</em>, <em>range=None</em>, <em>set_hook=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/attribute.html#Attribute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.attribute.Attribute" title="Permalink to this definition">¶</a></dt>
  95 <dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
  96 <p>An Attribute exposes a configuration parameter of a resource</p>
  97 <dl class="attribute">
  98 <dt id="nepi.execution.attribute.Attribute.allowed">
  99 <tt class="descname">allowed</tt><a class="reference internal" href="../_modules/nepi/execution/attribute.html#Attribute.allowed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.attribute.Attribute.allowed" title="Permalink to this definition">¶</a></dt>
 100 <dd><p>Returns the set of allowed values for the Attribute</p>
 101 </dd></dl>
 102
 103 <dl class="attribute">
 104 <dt id="nepi.execution.attribute.Attribute.default">
 105 <tt class="descname">default</tt><a class="reference internal" href="../_modules/nepi/execution/attribute.html#Attribute.default"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.attribute.Attribute.default" title="Permalink to this definition">¶</a></dt>
 106 <dd><p>Returns the default value of the Attribute</p>
 107 </dd></dl>
 108
 109 <dl class="attribute">
 110 <dt id="nepi.execution.attribute.Attribute.flags">
 111 <tt class="descname">flags</tt><a class="reference internal" href="../_modules/nepi/execution/attribute.html#Attribute.flags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.attribute.Attribute.flags" title="Permalink to this definition">¶</a></dt>
 112 <dd><p>Returns the flags of the Attribute</p>
 113 </dd></dl>
 114
 115 <dl class="method">
 116 <dt id="nepi.execution.attribute.Attribute.get_value">
 117 <tt class="descname">get_value</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/attribute.html#Attribute.get_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.attribute.Attribute.get_value" title="Permalink to this definition">¶</a></dt>
 118 <dd><p>Returns the value of the Attribute</p>
 119 </dd></dl>
 120
 121 <dl class="attribute">
 122 <dt id="nepi.execution.attribute.Attribute.has_changed">
 123 <tt class="descname">has_changed</tt><a class="reference internal" href="../_modules/nepi/execution/attribute.html#Attribute.has_changed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.attribute.Attribute.has_changed" title="Permalink to this definition">¶</a></dt>
 124 <dd><p>Returns True if the value has changed from the default</p>
 125 </dd></dl>
 126
 127 <dl class="method">
 128 <dt id="nepi.execution.attribute.Attribute.has_flag">
 129 <tt class="descname">has_flag</tt><big>(</big><em>flag</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/attribute.html#Attribute.has_flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.attribute.Attribute.has_flag" title="Permalink to this definition">¶</a></dt>
 130 <dd><p>Returns True if the Attribute has the flag &#8216;flag&#8217;</p>
 131 <table class="docutils field-list" frame="void" rules="none">
 132 <col class="field-name" />
 133 <col class="field-body" />
 134 <tbody valign="top">
 135 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>flag</strong> (<em>Flags</em>) &#8211; Flag to be checked</td>
 136 </tr>
 137 </tbody>
 138 </table>
 139 </dd></dl>
 140
 141 <dl class="attribute">
 142 <dt id="nepi.execution.attribute.Attribute.help">
 143 <tt class="descname">help</tt><a class="reference internal" href="../_modules/nepi/execution/attribute.html#Attribute.help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.attribute.Attribute.help" title="Permalink to this definition">¶</a></dt>
 144 <dd><p>Returns the description of the Attribute</p>
 145 </dd></dl>
 146
 147 <dl class="method">
 148 <dt id="nepi.execution.attribute.Attribute.is_valid_value">
 149 <tt class="descname">is_valid_value</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/attribute.html#Attribute.is_valid_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.attribute.Attribute.is_valid_value" title="Permalink to this definition">¶</a></dt>
 150 <dd><p>Attribute subclasses will override this method to add
 151 adequate validation</p>
 152 </dd></dl>
 153
 154 <dl class="attribute">
 155 <dt id="nepi.execution.attribute.Attribute.name">
 156 <tt class="descname">name</tt><a class="reference internal" href="../_modules/nepi/execution/attribute.html#Attribute.name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.attribute.Attribute.name" title="Permalink to this definition">¶</a></dt>
 157 <dd><p>Returns the name of the Attribute</p>
 158 </dd></dl>
 159
 160 <dl class="attribute">
 161 <dt id="nepi.execution.attribute.Attribute.range">
 162 <tt class="descname">range</tt><a class="reference internal" href="../_modules/nepi/execution/attribute.html#Attribute.range"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.attribute.Attribute.range" title="Permalink to this definition">¶</a></dt>
 163 <dd><p>Returns the range of allowed numerical values for the Attribute</p>
 164 </dd></dl>
 165
 166 <dl class="method">
 167 <dt id="nepi.execution.attribute.Attribute.set_value">
 168 <tt class="descname">set_value</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/attribute.html#Attribute.set_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.attribute.Attribute.set_value" title="Permalink to this definition">¶</a></dt>
 169 <dd><p>Configure a new value for the Attribute</p>
 170 </dd></dl>
 171
 172 <dl class="attribute">
 173 <dt id="nepi.execution.attribute.Attribute.type">
 174 <tt class="descname">type</tt><a class="reference internal" href="../_modules/nepi/execution/attribute.html#Attribute.type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.attribute.Attribute.type" title="Permalink to this definition">¶</a></dt>
 175 <dd><p>Returns the type of the Attribute</p>
 176 </dd></dl>
 177
 178 <dl class="attribute">
 179 <dt id="nepi.execution.attribute.Attribute.value">
 180 <tt class="descname">value</tt><a class="headerlink" href="#nepi.execution.attribute.Attribute.value" title="Permalink to this definition">¶</a></dt>
 181 <dd><p>Returns the value of the Attribute</p>
 182 </dd></dl>
 183
 184 </dd></dl>
 185
 186 <dl class="class">
 187 <dt id="nepi.execution.attribute.Flags">
 188 <em class="property">class </em><tt class="descclassname">nepi.execution.attribute.</tt><tt class="descname">Flags</tt><a class="reference internal" href="../_modules/nepi/execution/attribute.html#Flags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.attribute.Flags" title="Permalink to this definition">¶</a></dt>
 189 <dd><p>Flags to characterize the scope of an Attribute</p>
 190 <dl class="attribute">
 191 <dt id="nepi.execution.attribute.Flags.Construct">
 192 <tt class="descname">Construct</tt><em class="property"> = 8</em><a class="headerlink" href="#nepi.execution.attribute.Flags.Construct" title="Permalink to this definition">¶</a></dt>
 193 <dd></dd></dl>
 194
 195 <dl class="attribute">
 196 <dt id="nepi.execution.attribute.Flags.Credential">
 197 <tt class="descname">Credential</tt><em class="property"> = 20</em><a class="headerlink" href="#nepi.execution.attribute.Flags.Credential" title="Permalink to this definition">¶</a></dt>
 198 <dd></dd></dl>
 199
 200 <dl class="attribute">
 201 <dt id="nepi.execution.attribute.Flags.Design">
 202 <tt class="descname">Design</tt><em class="property"> = 4</em><a class="headerlink" href="#nepi.execution.attribute.Flags.Design" title="Permalink to this definition">¶</a></dt>
 203 <dd></dd></dl>
 204
 205 <dl class="attribute">
 206 <dt id="nepi.execution.attribute.Flags.Filter">
 207 <tt class="descname">Filter</tt><em class="property"> = 36</em><a class="headerlink" href="#nepi.execution.attribute.Flags.Filter" title="Permalink to this definition">¶</a></dt>
 208 <dd></dd></dl>
 209
 210 <dl class="attribute">
 211 <dt id="nepi.execution.attribute.Flags.Global">
 212 <tt class="descname">Global</tt><em class="property"> = 128</em><a class="headerlink" href="#nepi.execution.attribute.Flags.Global" title="Permalink to this definition">¶</a></dt>
 213 <dd></dd></dl>
 214
 215 <dl class="attribute">
 216 <dt id="nepi.execution.attribute.Flags.NoRead">
 217 <tt class="descname">NoRead</tt><em class="property"> = 1</em><a class="headerlink" href="#nepi.execution.attribute.Flags.NoRead" title="Permalink to this definition">¶</a></dt>
 218 <dd></dd></dl>
 219
 220 <dl class="attribute">
 221 <dt id="nepi.execution.attribute.Flags.NoWrite">
 222 <tt class="descname">NoWrite</tt><em class="property"> = 2</em><a class="headerlink" href="#nepi.execution.attribute.Flags.NoWrite" title="Permalink to this definition">¶</a></dt>
 223 <dd></dd></dl>
 224
 225 <dl class="attribute">
 226 <dt id="nepi.execution.attribute.Flags.Reserved">
 227 <tt class="descname">Reserved</tt><em class="property"> = 64</em><a class="headerlink" href="#nepi.execution.attribute.Flags.Reserved" title="Permalink to this definition">¶</a></dt>
 228 <dd></dd></dl>
 229
 230 </dd></dl>
 231
 232 <dl class="class">
 233 <dt id="nepi.execution.attribute.Types">
 234 <em class="property">class </em><tt class="descclassname">nepi.execution.attribute.</tt><tt class="descname">Types</tt><a class="reference internal" href="../_modules/nepi/execution/attribute.html#Types"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.attribute.Types" title="Permalink to this definition">¶</a></dt>
 235 <dd><p>Allowed types for the Attribute value</p>
 236 <dl class="attribute">
 237 <dt id="nepi.execution.attribute.Types.Bool">
 238 <tt class="descname">Bool</tt><em class="property"> = 'BOOL'</em><a class="headerlink" href="#nepi.execution.attribute.Types.Bool" title="Permalink to this definition">¶</a></dt>
 239 <dd></dd></dl>
 240
 241 <dl class="attribute">
 242 <dt id="nepi.execution.attribute.Types.Double">
 243 <tt class="descname">Double</tt><em class="property"> = 'DOUBLE'</em><a class="headerlink" href="#nepi.execution.attribute.Types.Double" title="Permalink to this definition">¶</a></dt>
 244 <dd></dd></dl>
 245
 246 <dl class="attribute">
 247 <dt id="nepi.execution.attribute.Types.Enumerate">
 248 <tt class="descname">Enumerate</tt><em class="property"> = 'ENUM'</em><a class="headerlink" href="#nepi.execution.attribute.Types.Enumerate" title="Permalink to this definition">¶</a></dt>
 249 <dd></dd></dl>
 250
 251 <dl class="attribute">
 252 <dt id="nepi.execution.attribute.Types.Integer">
 253 <tt class="descname">Integer</tt><em class="property"> = 'INTEGER'</em><a class="headerlink" href="#nepi.execution.attribute.Types.Integer" title="Permalink to this definition">¶</a></dt>
 254 <dd></dd></dl>
 255
 256 <dl class="attribute">
 257 <dt id="nepi.execution.attribute.Types.String">
 258 <tt class="descname">String</tt><em class="property"> = 'STRING'</em><a class="headerlink" href="#nepi.execution.attribute.Types.String" title="Permalink to this definition">¶</a></dt>
 259 <dd></dd></dl>
 260
 261 </dd></dl>
 262
 263 </div>
 264 <div class="section" id="module-nepi.execution.ec">
 265 <span id="nepi-execution-ec-module"></span><h2>nepi.execution.ec module<a class="headerlink" href="#module-nepi.execution.ec" title="Permalink to this headline">¶</a></h2>
 266 <dl class="class">
 267 <dt id="nepi.execution.ec.ECState">
 268 <em class="property">class </em><tt class="descclassname">nepi.execution.ec.</tt><tt class="descname">ECState</tt><a class="reference internal" href="../_modules/nepi/execution/ec.html#ECState"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ECState" title="Permalink to this definition">¶</a></dt>
 269 <dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
 270 <p>Possible states of the ExperimentController</p>
 271 <dl class="attribute">
 272 <dt id="nepi.execution.ec.ECState.FAILED">
 273 <tt class="descname">FAILED</tt><em class="property"> = 2</em><a class="headerlink" href="#nepi.execution.ec.ECState.FAILED" title="Permalink to this definition">¶</a></dt>
 274 <dd></dd></dl>
 275
 276 <dl class="attribute">
 277 <dt id="nepi.execution.ec.ECState.RELEASED">
 278 <tt class="descname">RELEASED</tt><em class="property"> = 3</em><a class="headerlink" href="#nepi.execution.ec.ECState.RELEASED" title="Permalink to this definition">¶</a></dt>
 279 <dd></dd></dl>
 280
 281 <dl class="attribute">
 282 <dt id="nepi.execution.ec.ECState.RUNNING">
 283 <tt class="descname">RUNNING</tt><em class="property"> = 1</em><a class="headerlink" href="#nepi.execution.ec.ECState.RUNNING" title="Permalink to this definition">¶</a></dt>
 284 <dd></dd></dl>
 285
 286 <dl class="attribute">
 287 <dt id="nepi.execution.ec.ECState.TERMINATED">
 288 <tt class="descname">TERMINATED</tt><em class="property"> = 4</em><a class="headerlink" href="#nepi.execution.ec.ECState.TERMINATED" title="Permalink to this definition">¶</a></dt>
 289 <dd></dd></dl>
 290
 291 </dd></dl>
 292
 293 <dl class="class">
 294 <dt id="nepi.execution.ec.ExperimentController">
 295 <em class="property">class </em><tt class="descclassname">nepi.execution.ec.</tt><tt class="descname">ExperimentController</tt><big>(</big><em>exp_id=None</em>, <em>local_dir=None</em>, <em>persist=False</em>, <em>fm=None</em>, <em>add_node_callback=None</em>, <em>add_edge_callback=None</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController" title="Permalink to this definition">¶</a></dt>
 296 <dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
 297 <p>An experiment, or scenario, is defined by a concrete set of resources,
 298 and the behavior, configuration and interconnection of those resources.
 299 The Experiment Description (ED) is a detailed representation of a
 300 single experiment. It contains all the necessary information to
 301 allow repeating the experiment. NEPI allows to describe
 302 experiments by registering components (resources), configuring them
 303 and interconnecting them.</p>
 304 <p>A same experiment (scenario) can be executed many times, generating
 305 different results. We call an experiment execution (instance) a &#8216;run&#8217;.</p>
 306 <p>The ExperimentController (EC), is the entity responsible of
 307 managing an experiment run. The same scenario can be
 308 recreated (and re-run) by instantiating an EC and recreating
 309 the same experiment description.</p>
 310 <p>An experiment is represented as a graph of interconnected
 311 resources. A resource is a generic concept in the sense that any
 312 component taking part of an experiment, whether physical of
 313 virtual, is considered a resource. A resources could be a host,
 314 a virtual machine, an application, a simulator, a IP address.</p>
 315 <p>A ResourceManager (RM), is the entity responsible for managing a
 316 single resource. ResourceManagers are specific to a resource
 317 type (i.e. An RM to control a Linux application will not be
 318 the same as the RM used to control a ns-3 simulation).
 319 To support a new type of resource, a new RM must be implemented.
 320 NEPI already provides a variety of RMs to control basic resources,
 321 and new can be extended from the existing ones.</p>
 322 <p>Through the EC interface the user can create ResourceManagers (RMs),
 323 configure them and interconnect them, to describe an experiment.
 324 Describing an experiment through the EC does not run the experiment.
 325 Only when the &#8216;deploy()&#8217; method is invoked on the EC, the EC will take
 326 actions to transform the &#8216;described&#8217; experiment into a &#8216;running&#8217; experiment.</p>
 327 <p>While the experiment is running, it is possible to continue to
 328 create/configure/connect RMs, and to deploy them to involve new
 329 resources in the experiment (this is known as &#8216;interactive&#8217; deployment).</p>
 330 <p>An experiments in NEPI is identified by a string id,
 331 which is either given by the user, or automatically generated by NEPI.
 332 The purpose of this identifier is to separate files and results that
 333 belong to different experiment scenarios.
 334 However, since a same &#8216;experiment&#8217; can be run many times, the experiment
 335 id is not enough to identify an experiment instance (run).
 336 For this reason, the ExperimentController has two identifier, the
 337 exp_id, which can be re-used in different ExperimentController,
 338 and the run_id, which is unique to one ExperimentController instance, and
 339 is automatically generated by NEPI.</p>
 340 <dl class="attribute">
 341 <dt id="nepi.execution.ec.ExperimentController.abort">
 342 <tt class="descname">abort</tt><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.abort"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.abort" title="Permalink to this definition">¶</a></dt>
 343 <dd><p>Returns True if the experiment has failed and should be interrupted,
 344 False otherwise.</p>
 345 </dd></dl>
 346
 347 <dl class="method">
 348 <dt id="nepi.execution.ec.ExperimentController.deploy">
 349 <tt class="descname">deploy</tt><big>(</big><em>guids=None</em>, <em>wait_all_ready=True</em>, <em>group=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.deploy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.deploy" title="Permalink to this definition">¶</a></dt>
 350 <dd><p>Deploys all ResourceManagers in the guids list.</p>
 351 <p>If the argument &#8216;guids&#8217; is not given, all RMs with state NEW
 352 are deployed.</p>
 353 <blockquote>
 354 <div><table class="docutils field-list" frame="void" rules="none">
 355 <col class="field-name" />
 356 <col class="field-body" />
 357 <tbody valign="top">
 358 <tr class="field-odd field"><th class="field-name">param guids:</th><td class="field-body">List of guids of RMs to deploy</td>
 359 </tr>
 360 <tr class="field-even field"><th class="field-name">type guids:</th><td class="field-body">list</td>
 361 </tr>
 362 <tr class="field-odd field"><th class="field-name" colspan="2">param wait_all_ready:</th></tr>
 363 <tr class="field-odd field"><td>&nbsp;</td><td class="field-body">Wait until all RMs are ready in
 364 order to start the RMs</td>
 365 </tr>
 366 <tr class="field-even field"><th class="field-name">type guid:</th><td class="field-body">int</td>
 367 </tr>
 368 <tr class="field-odd field"><th class="field-name">param group:</th><td class="field-body">Id of deployment group in which to deploy RMs</td>
 369 </tr>
 370 <tr class="field-even field"><th class="field-name">type group:</th><td class="field-body">int</td>
 371 </tr>
 372 </tbody>
 373 </table>
 374 </div></blockquote>
 375 </dd></dl>
 376
 377 <dl class="method">
 378 <dt id="nepi.execution.ec.ExperimentController.discover">
 379 <tt class="descname">discover</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.discover"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.discover" title="Permalink to this definition">¶</a></dt>
 380 <dd><p>Discovers an available resource matching the criteria defined
 381 by the RM with guid &#8216;guid&#8217;, and associates that resource to the RM</p>
 382 <p>Not all RM types require (or are capable of) performing resource
 383 discovery. For the RM types which are not capable of doing so,
 384 invoking this method does not have any consequences.</p>
 385 <blockquote>
 386 <div><table class="docutils field-list" frame="void" rules="none">
 387 <col class="field-name" />
 388 <col class="field-body" />
 389 <tbody valign="top">
 390 <tr class="field-odd field"><th class="field-name">param guid:</th><td class="field-body">Guid of the RM</td>
 391 </tr>
 392 <tr class="field-even field"><th class="field-name">type guid:</th><td class="field-body">int</td>
 393 </tr>
 394 </tbody>
 395 </table>
 396 </div></blockquote>
 397 </dd></dl>
 398
 399 <dl class="attribute">
 400 <dt id="nepi.execution.ec.ExperimentController.ecstate">
 401 <tt class="descname">ecstate</tt><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.ecstate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.ecstate" title="Permalink to this definition">¶</a></dt>
 402 <dd><p>Returns the state of the Experiment Controller</p>
 403 </dd></dl>
 404
 405 <dl class="method">
 406 <dt id="nepi.execution.ec.ExperimentController.enable_trace">
 407 <tt class="descname">enable_trace</tt><big>(</big><em>guid</em>, <em>name</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.enable_trace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.enable_trace" title="Permalink to this definition">¶</a></dt>
 408 <dd><p>Enables a trace to be collected during the experiment run</p>
 409 <table class="docutils field-list" frame="void" rules="none">
 410 <col class="field-name" />
 411 <col class="field-body" />
 412 <tbody valign="top">
 413 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the trace</td>
 414 </tr>
 415 </tbody>
 416 </table>
 417 </dd></dl>
 418
 419 <dl class="attribute">
 420 <dt id="nepi.execution.ec.ExperimentController.exp_dir">
 421 <tt class="descname">exp_dir</tt><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.exp_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.exp_dir" title="Permalink to this definition">¶</a></dt>
 422 <dd><p>Local directory to store results and other files related to the
 423 experiment.</p>
 424 </dd></dl>
 425
 426 <dl class="attribute">
 427 <dt id="nepi.execution.ec.ExperimentController.exp_id">
 428 <tt class="descname">exp_id</tt><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.exp_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.exp_id" title="Permalink to this definition">¶</a></dt>
 429 <dd><p>Returns the experiment id assigned by the user</p>
 430 </dd></dl>
 431
 432 <dl class="attribute">
 433 <dt id="nepi.execution.ec.ExperimentController.failure_level">
 434 <tt class="descname">failure_level</tt><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.failure_level"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.failure_level" title="Permalink to this definition">¶</a></dt>
 435 <dd><p>Returns the level of FAILURE of th experiment</p>
 436 </dd></dl>
 437
 438 <dl class="method">
 439 <dt id="nepi.execution.ec.ExperimentController.filter_resources">
 440 <tt class="descname">filter_resources</tt><big>(</big><em>rtype</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.filter_resources"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.filter_resources" title="Permalink to this definition">¶</a></dt>
 441 <dd><p>Returns the guids of all ResourceManagers of type rtype</p>
 442 <table class="docutils field-list" frame="void" rules="none">
 443 <col class="field-name" />
 444 <col class="field-body" />
 445 <tbody valign="top">
 446 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>rtype</strong> (<a class="reference external" href="http://docs.python.org/library/string.html#module-string" title="(in Python v2.7)"><em>string</em></a>) &#8211; Resource type</td>
 447 </tr>
 448 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list of guids</td>
 449 </tr>
 450 </tbody>
 451 </table>
 452 </dd></dl>
 453
 454 <dl class="attribute">
 455 <dt id="nepi.execution.ec.ExperimentController.fm">
 456 <tt class="descname">fm</tt><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.fm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.fm" title="Permalink to this definition">¶</a></dt>
 457 <dd><p>Returns the failure manager</p>
 458 </dd></dl>
 459
 460 <dl class="method">
 461 <dt id="nepi.execution.ec.ExperimentController.get">
 462 <tt class="descname">get</tt><big>(</big><em>guid</em>, <em>name</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.get" title="Permalink to this definition">¶</a></dt>
 463 <dd><p>Returns the value of the attribute with name &#8216;name&#8217; on the
 464 RM with guid &#8216;guid&#8217;</p>
 465 <blockquote>
 466 <div><table class="docutils field-list" frame="void" rules="none">
 467 <col class="field-name" />
 468 <col class="field-body" />
 469 <tbody valign="top">
 470 <tr class="field-odd field"><th class="field-name">param guid:</th><td class="field-body">Guid of the RM</td>
 471 </tr>
 472 <tr class="field-even field"><th class="field-name">type guid:</th><td class="field-body">int</td>
 473 </tr>
 474 <tr class="field-odd field"><th class="field-name">param name:</th><td class="field-body">Name of the attribute</td>
 475 </tr>
 476 <tr class="field-even field"><th class="field-name">type name:</th><td class="field-body">str</td>
 477 </tr>
 478 <tr class="field-odd field"><th class="field-name">return:</th><td class="field-body">The value of the attribute with name &#8216;name&#8217;</td>
 479 </tr>
 480 </tbody>
 481 </table>
 482 </div></blockquote>
 483 </dd></dl>
 484
 485 <dl class="method">
 486 <dt id="nepi.execution.ec.ExperimentController.get_attribute">
 487 <tt class="descname">get_attribute</tt><big>(</big><em>guid</em>, <em>name</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.get_attribute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.get_attribute" title="Permalink to this definition">¶</a></dt>
 488 <dd><p>Returns the attribute &#8216;name&#8217; of the RM with guid &#8216;guid&#8217;</p>
 489 <table class="docutils field-list" frame="void" rules="none">
 490 <col class="field-name" />
 491 <col class="field-body" />
 492 <tbody valign="top">
 493 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 494 <li><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Guid of the RM</li>
 495 <li><strong>name</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the attribute</li>
 496 </ul>
 497 </td>
 498 </tr>
 499 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The attribute with name &#8216;name&#8217;</p>
 500 </td>
 501 </tr>
 502 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Attribute</p>
 503 </td>
 504 </tr>
 505 </tbody>
 506 </table>
 507 </dd></dl>
 508
 509 <dl class="method">
 510 <dt id="nepi.execution.ec.ExperimentController.get_attributes">
 511 <tt class="descname">get_attributes</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.get_attributes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.get_attributes" title="Permalink to this definition">¶</a></dt>
 512 <dd><p>Returns all the attributes of the RM with guid &#8216;guid&#8217;</p>
 513 <table class="docutils field-list" frame="void" rules="none">
 514 <col class="field-name" />
 515 <col class="field-body" />
 516 <tbody valign="top">
 517 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Guid of the RM</td>
 518 </tr>
 519 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of attributes</td>
 520 </tr>
 521 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">list</td>
 522 </tr>
 523 </tbody>
 524 </table>
 525 </dd></dl>
 526
 527 <dl class="method">
 528 <dt id="nepi.execution.ec.ExperimentController.get_discover_time">
 529 <tt class="descname">get_discover_time</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.get_discover_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.get_discover_time" title="Permalink to this definition">¶</a></dt>
 530 <dd><p>Returns the discover time of the RM as a timestamp</p>
 531 </dd></dl>
 532
 533 <dl class="method">
 534 <dt id="nepi.execution.ec.ExperimentController.get_failed_time">
 535 <tt class="descname">get_failed_time</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.get_failed_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.get_failed_time" title="Permalink to this definition">¶</a></dt>
 536 <dd><p>Returns the time failure occured for the RM as a timestamp</p>
 537 </dd></dl>
 538
 539 <dl class="method">
 540 <dt id="nepi.execution.ec.ExperimentController.get_global">
 541 <tt class="descname">get_global</tt><big>(</big><em>rtype</em>, <em>name</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.get_global"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.get_global" title="Permalink to this definition">¶</a></dt>
 542 <dd><p>Returns the value of the global attribute with name &#8216;name&#8217; on the
 543 RMs of rtype &#8216;rtype&#8217;.</p>
 544 <blockquote>
 545 <div><table class="docutils field-list" frame="void" rules="none">
 546 <col class="field-name" />
 547 <col class="field-body" />
 548 <tbody valign="top">
 549 <tr class="field-odd field"><th class="field-name">param guid:</th><td class="field-body">Guid of the RM</td>
 550 </tr>
 551 <tr class="field-even field"><th class="field-name">type guid:</th><td class="field-body">int</td>
 552 </tr>
 553 <tr class="field-odd field"><th class="field-name">param name:</th><td class="field-body">Name of the attribute</td>
 554 </tr>
 555 <tr class="field-even field"><th class="field-name">type name:</th><td class="field-body">str</td>
 556 </tr>
 557 <tr class="field-odd field"><th class="field-name">return:</th><td class="field-body">The value of the attribute with name &#8216;name&#8217;</td>
 558 </tr>
 559 </tbody>
 560 </table>
 561 </div></blockquote>
 562 </dd></dl>
 563
 564 <dl class="method">
 565 <dt id="nepi.execution.ec.ExperimentController.get_provision_time">
 566 <tt class="descname">get_provision_time</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.get_provision_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.get_provision_time" title="Permalink to this definition">¶</a></dt>
 567 <dd><p>Returns the provision time of the RM as a timestamp</p>
 568 </dd></dl>
 569
 570 <dl class="method">
 571 <dt id="nepi.execution.ec.ExperimentController.get_ready_time">
 572 <tt class="descname">get_ready_time</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.get_ready_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.get_ready_time" title="Permalink to this definition">¶</a></dt>
 573 <dd><p>Returns the deployment time of the RM as a timestamp</p>
 574 </dd></dl>
 575
 576 <dl class="method">
 577 <dt id="nepi.execution.ec.ExperimentController.get_release_time">
 578 <tt class="descname">get_release_time</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.get_release_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.get_release_time" title="Permalink to this definition">¶</a></dt>
 579 <dd><p>Returns the release time of the RM as a timestamp</p>
 580 </dd></dl>
 581
 582 <dl class="method">
 583 <dt id="nepi.execution.ec.ExperimentController.get_resource">
 584 <tt class="descname">get_resource</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.get_resource"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.get_resource" title="Permalink to this definition">¶</a></dt>
 585 <dd><p>Returns a registered ResourceManager by its guid</p>
 586 <table class="docutils field-list" frame="void" rules="none">
 587 <col class="field-name" />
 588 <col class="field-body" />
 589 <tbody valign="top">
 590 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Id of the resource</td>
 591 </tr>
 592 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">ResourceManager</td>
 593 </tr>
 594 </tbody>
 595 </table>
 596 </dd></dl>
 597
 598 <dl class="method">
 599 <dt id="nepi.execution.ec.ExperimentController.get_resources_by_type">
 600 <tt class="descname">get_resources_by_type</tt><big>(</big><em>rtype</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.get_resources_by_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.get_resources_by_type" title="Permalink to this definition">¶</a></dt>
 601 <dd><p>Returns the ResourceManager objects of type rtype</p>
 602 <table class="docutils field-list" frame="void" rules="none">
 603 <col class="field-name" />
 604 <col class="field-body" />
 605 <tbody valign="top">
 606 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>rtype</strong> (<a class="reference external" href="http://docs.python.org/library/string.html#module-string" title="(in Python v2.7)"><em>string</em></a>) &#8211; Resource type</td>
 607 </tr>
 608 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list of ResourceManagers</td>
 609 </tr>
 610 </tbody>
 611 </table>
 612 </dd></dl>
 613
 614 <dl class="method">
 615 <dt id="nepi.execution.ec.ExperimentController.get_start_time">
 616 <tt class="descname">get_start_time</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.get_start_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.get_start_time" title="Permalink to this definition">¶</a></dt>
 617 <dd><p>Returns the start time of the RM as a timestamp</p>
 618 </dd></dl>
 619
 620 <dl class="method">
 621 <dt id="nepi.execution.ec.ExperimentController.get_stop_time">
 622 <tt class="descname">get_stop_time</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.get_stop_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.get_stop_time" title="Permalink to this definition">¶</a></dt>
 623 <dd><p>Returns the stop time of the RM as a timestamp</p>
 624 </dd></dl>
 625
 626 <dl class="method">
 627 <dt id="nepi.execution.ec.ExperimentController.get_task">
 628 <tt class="descname">get_task</tt><big>(</big><em>tid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.get_task"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.get_task" title="Permalink to this definition">¶</a></dt>
 629 <dd><p>Returns a task by its id</p>
 630 <table class="docutils field-list" frame="void" rules="none">
 631 <col class="field-name" />
 632 <col class="field-body" />
 633 <tbody valign="top">
 634 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Id of the task</td>
 635 </tr>
 636 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Task</td>
 637 </tr>
 638 </tbody>
 639 </table>
 640 </dd></dl>
 641
 642 <dl class="method">
 643 <dt id="nepi.execution.ec.ExperimentController.get_traces">
 644 <tt class="descname">get_traces</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.get_traces"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.get_traces" title="Permalink to this definition">¶</a></dt>
 645 <dd><p>Returns the list of the trace names of the RM with guid &#8216;guid&#8217;</p>
 646 <table class="docutils field-list" frame="void" rules="none">
 647 <col class="field-name" />
 648 <col class="field-body" />
 649 <tbody valign="top">
 650 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Guid of the RM</td>
 651 </tr>
 652 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of trace names</td>
 653 </tr>
 654 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">list</td>
 655 </tr>
 656 </tbody>
 657 </table>
 658 </dd></dl>
 659
 660 <dl class="method">
 661 <dt id="nepi.execution.ec.ExperimentController.inform_failure">
 662 <tt class="descname">inform_failure</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.inform_failure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.inform_failure" title="Permalink to this definition">¶</a></dt>
 663 <dd><p>Reports a failure in a RM to the EC for evaluation</p>
 664 <table class="docutils field-list" frame="void" rules="none">
 665 <col class="field-name" />
 666 <col class="field-body" />
 667 <tbody valign="top">
 668 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Resource id</td>
 669 </tr>
 670 </tbody>
 671 </table>
 672 </dd></dl>
 673
 674 <dl class="classmethod">
 675 <dt id="nepi.execution.ec.ExperimentController.load">
 676 <em class="property">classmethod </em><tt class="descname">load</tt><big>(</big><em>filepath</em>, <em>format='xml'</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.load"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.load" title="Permalink to this definition">¶</a></dt>
 677 <dd></dd></dl>
 678
 679 <dl class="attribute">
 680 <dt id="nepi.execution.ec.ExperimentController.local_dir">
 681 <tt class="descname">local_dir</tt><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.local_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.local_dir" title="Permalink to this definition">¶</a></dt>
 682 <dd><p>Root local directory for experiment files</p>
 683 </dd></dl>
 684
 685 <dl class="attribute">
 686 <dt id="nepi.execution.ec.ExperimentController.logger">
 687 <tt class="descname">logger</tt><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.logger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.logger" title="Permalink to this definition">¶</a></dt>
 688 <dd><p>Returns the logger instance of the Experiment Controller</p>
 689 </dd></dl>
 690
 691 <dl class="attribute">
 692 <dt id="nepi.execution.ec.ExperimentController.netgraph">
 693 <tt class="descname">netgraph</tt><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.netgraph"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.netgraph" title="Permalink to this definition">¶</a></dt>
 694 <dd><p>Return NetGraph instance if experiment description was automatically
 695 generated</p>
 696 </dd></dl>
 697
 698 <dl class="attribute">
 699 <dt id="nepi.execution.ec.ExperimentController.nthreads">
 700 <tt class="descname">nthreads</tt><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.nthreads"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.nthreads" title="Permalink to this definition">¶</a></dt>
 701 <dd><p>Returns the number of processing nthreads used</p>
 702 </dd></dl>
 703
 704 <dl class="attribute">
 705 <dt id="nepi.execution.ec.ExperimentController.persist">
 706 <tt class="descname">persist</tt><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.persist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.persist" title="Permalink to this definition">¶</a></dt>
 707 <dd><p>If True, persists the ExperimentController to XML format upon
 708 experiment completion</p>
 709 </dd></dl>
 710
 711 <dl class="method">
 712 <dt id="nepi.execution.ec.ExperimentController.plot">
 713 <tt class="descname">plot</tt><big>(</big><em>dirpath=None</em>, <em>format='figure'</em>, <em>show=False</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.plot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.plot" title="Permalink to this definition">¶</a></dt>
 714 <dd></dd></dl>
 715
 716 <dl class="method">
 717 <dt id="nepi.execution.ec.ExperimentController.provision">
 718 <tt class="descname">provision</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.provision"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.provision" title="Permalink to this definition">¶</a></dt>
 719 <dd><p>Provisions the resource associated to the RM with guid &#8216;guid&#8217;.</p>
 720 <p>Provisioning means making a resource &#8216;accessible&#8217; to the user.
 721 Not all RM types require (or are capable of) performing resource
 722 provisioning. For the RM types which are not capable of doing so,
 723 invoking this method does not have any consequences.</p>
 724 <blockquote>
 725 <div><table class="docutils field-list" frame="void" rules="none">
 726 <col class="field-name" />
 727 <col class="field-body" />
 728 <tbody valign="top">
 729 <tr class="field-odd field"><th class="field-name">param guid:</th><td class="field-body">Guid of the RM</td>
 730 </tr>
 731 <tr class="field-even field"><th class="field-name">type guid:</th><td class="field-body">int</td>
 732 </tr>
 733 </tbody>
 734 </table>
 735 </div></blockquote>
 736 </dd></dl>
 737
 738 <dl class="method">
 739 <dt id="nepi.execution.ec.ExperimentController.register_condition">
 740 <tt class="descname">register_condition</tt><big>(</big><em>guids1</em>, <em>action</em>, <em>guids2</em>, <em>state</em>, <em>time=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.register_condition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.register_condition" title="Permalink to this definition">¶</a></dt>
 741 <dd><p>Registers an action START, STOP or DEPLOY for all RM on list
 742 guids1 to occur at time &#8216;time&#8217; after all elements in list guids2
 743 have reached state &#8216;state&#8217;.</p>
 744 <blockquote>
 745 <div><table class="docutils field-list" frame="void" rules="none">
 746 <col class="field-name" />
 747 <col class="field-body" />
 748 <tbody valign="top">
 749 <tr class="field-odd field"><th class="field-name">param guids1:</th><td class="field-body">List of guids of RMs subjected to action</td>
 750 </tr>
 751 <tr class="field-even field"><th class="field-name">type guids1:</th><td class="field-body">list</td>
 752 </tr>
 753 <tr class="field-odd field"><th class="field-name">param action:</th><td class="field-body">Action to perform (either START, STOP or DEPLOY)</td>
 754 </tr>
 755 <tr class="field-even field"><th class="field-name">type action:</th><td class="field-body">ResourceAction</td>
 756 </tr>
 757 <tr class="field-odd field"><th class="field-name">param guids2:</th><td class="field-body">List of guids of RMs to we waited for</td>
 758 </tr>
 759 <tr class="field-even field"><th class="field-name">type guids2:</th><td class="field-body">list</td>
 760 </tr>
 761 <tr class="field-odd field"><th class="field-name">param state:</th><td class="field-body">State to wait for on RMs of list guids2 (STARTED,
 762 STOPPED, etc)</td>
 763 </tr>
 764 <tr class="field-even field"><th class="field-name">type state:</th><td class="field-body">ResourceState</td>
 765 </tr>
 766 <tr class="field-odd field"><th class="field-name">param time:</th><td class="field-body">Time to wait after guids2 has reached status</td>
 767 </tr>
 768 <tr class="field-even field"><th class="field-name">type time:</th><td class="field-body">string</td>
 769 </tr>
 770 </tbody>
 771 </table>
 772 </div></blockquote>
 773 </dd></dl>
 774
 775 <dl class="method">
 776 <dt id="nepi.execution.ec.ExperimentController.register_connection">
 777 <tt class="descname">register_connection</tt><big>(</big><em>guid1</em>, <em>guid2</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.register_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.register_connection" title="Permalink to this definition">¶</a></dt>
 778 <dd><p>Registers a connection between a RM with guid &#8216;guid1&#8217;
 779 and another RM with guid &#8216;guid2&#8217;.</p>
 780 <p>The order of the in which the two guids are provided is not
 781 important, since the connection relationship is symmetric.</p>
 782 <blockquote>
 783 <div><table class="docutils field-list" frame="void" rules="none">
 784 <col class="field-name" />
 785 <col class="field-body" />
 786 <tbody valign="top">
 787 <tr class="field-odd field"><th class="field-name">param guid1:</th><td class="field-body">First guid to connect</td>
 788 </tr>
 789 <tr class="field-even field"><th class="field-name">type guid1:</th><td class="field-body">ResourceManager</td>
 790 </tr>
 791 <tr class="field-odd field"><th class="field-name">param guid2:</th><td class="field-body">Second guid to connect</td>
 792 </tr>
 793 <tr class="field-even field"><th class="field-name">type guid:</th><td class="field-body">ResourceManager</td>
 794 </tr>
 795 </tbody>
 796 </table>
 797 </div></blockquote>
 798 </dd></dl>
 799
 800 <dl class="method">
 801 <dt id="nepi.execution.ec.ExperimentController.register_resource">
 802 <tt class="descname">register_resource</tt><big>(</big><em>rtype</em>, <em>guid=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.register_resource"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.register_resource" title="Permalink to this definition">¶</a></dt>
 803 <dd><p>Registers a new ResourceManager of type &#8216;rtype&#8217; in the experiment</p>
 804 <p>This method will assign a new &#8216;guid&#8217; for the RM, if no guid
 805 is specified.</p>
 806 <blockquote>
 807 <div><table class="docutils field-list" frame="void" rules="none">
 808 <col class="field-name" />
 809 <col class="field-body" />
 810 <tbody valign="top">
 811 <tr class="field-odd field"><th class="field-name">param rtype:</th><td class="field-body">Type of the RM</td>
 812 </tr>
 813 <tr class="field-even field"><th class="field-name">type rtype:</th><td class="field-body">str</td>
 814 </tr>
 815 <tr class="field-odd field"><th class="field-name">return:</th><td class="field-body">Guid of the RM</td>
 816 </tr>
 817 <tr class="field-even field"><th class="field-name">rtype:</th><td class="field-body">int</td>
 818 </tr>
 819 </tbody>
 820 </table>
 821 </div></blockquote>
 822 </dd></dl>
 823
 824 <dl class="method">
 825 <dt id="nepi.execution.ec.ExperimentController.release">
 826 <tt class="descname">release</tt><big>(</big><em>guids=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.release" title="Permalink to this definition">¶</a></dt>
 827 <dd><p>Releases all ResourceManagers in the guids list.</p>
 828 <p>If the argument &#8216;guids&#8217; is not given, all RMs registered
 829 in the experiment are released.</p>
 830 <blockquote>
 831 <div><table class="docutils field-list" frame="void" rules="none">
 832 <col class="field-name" />
 833 <col class="field-body" />
 834 <tbody valign="top">
 835 <tr class="field-odd field"><th class="field-name">param guids:</th><td class="field-body">List of RM guids</td>
 836 </tr>
 837 <tr class="field-even field"><th class="field-name">type guids:</th><td class="field-body">list</td>
 838 </tr>
 839 </tbody>
 840 </table>
 841 </div></blockquote>
 842 </dd></dl>
 843
 844 <dl class="method">
 845 <dt id="nepi.execution.ec.ExperimentController.remove_resource">
 846 <tt class="descname">remove_resource</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.remove_resource"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.remove_resource" title="Permalink to this definition">¶</a></dt>
 847 <dd></dd></dl>
 848
 849 <dl class="attribute">
 850 <dt id="nepi.execution.ec.ExperimentController.resources">
 851 <tt class="descname">resources</tt><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.resources"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.resources" title="Permalink to this definition">¶</a></dt>
 852 <dd><p>Returns the guids of all ResourceManagers</p>
 853 <table class="docutils field-list" frame="void" rules="none">
 854 <col class="field-name" />
 855 <col class="field-body" />
 856 <tbody valign="top">
 857 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Set of all RM guids</td>
 858 </tr>
 859 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list</td>
 860 </tr>
 861 </tbody>
 862 </table>
 863 </dd></dl>
 864
 865 <dl class="attribute">
 866 <dt id="nepi.execution.ec.ExperimentController.run_dir">
 867 <tt class="descname">run_dir</tt><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.run_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.run_dir" title="Permalink to this definition">¶</a></dt>
 868 <dd><p>Local directory to store results and other files related to the
 869 experiment run.</p>
 870 </dd></dl>
 871
 872 <dl class="attribute">
 873 <dt id="nepi.execution.ec.ExperimentController.run_id">
 874 <tt class="descname">run_id</tt><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.run_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.run_id" title="Permalink to this definition">¶</a></dt>
 875 <dd><p>Returns the experiment instance (run) identifier (automatically
 876 generated)</p>
 877 </dd></dl>
 878
 879 <dl class="method">
 880 <dt id="nepi.execution.ec.ExperimentController.save">
 881 <tt class="descname">save</tt><big>(</big><em>dirpath=None</em>, <em>format='xml'</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.save" title="Permalink to this definition">¶</a></dt>
 882 <dd></dd></dl>
 883
 884 <dl class="method">
 885 <dt id="nepi.execution.ec.ExperimentController.schedule">
 886 <tt class="descname">schedule</tt><big>(</big><em>date</em>, <em>callback</em>, <em>track=False</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.schedule"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.schedule" title="Permalink to this definition">¶</a></dt>
 887 <dd><p>Schedules a callback to be executed at time &#8216;date&#8217;.</p>
 888 <table class="docutils field-list" frame="void" rules="none">
 889 <col class="field-name" />
 890 <col class="field-body" />
 891 <tbody valign="top">
 892 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 893 <li><strong>date</strong> &#8211; string containing execution time for the task.
 894 It can be expressed as an absolute time, using
 895 timestamp format, or as a relative time matching
 896 ^d+.d+(h|m|s|ms|us)$</li>
 897 <li><strong>callback</strong> &#8211; code to be executed for the task. Must be a
 898 Python function, and receives args and kwargs
 899 as arguments.</li>
 900 <li><strong>track</strong> &#8211; if set to True, the task will be retrievable with
 901 the get_task() method</li>
 902 </ul>
 903 </td>
 904 </tr>
 905 </tbody>
 906 </table>
 907 <p>:return : The Id of the task
 908 :rtype: int</p>
 909 </dd></dl>
 910
 911 <dl class="method">
 912 <dt id="nepi.execution.ec.ExperimentController.serialize">
 913 <tt class="descname">serialize</tt><big>(</big><em>format='xml'</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.serialize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.serialize" title="Permalink to this definition">¶</a></dt>
 914 <dd></dd></dl>
 915
 916 <dl class="method">
 917 <dt id="nepi.execution.ec.ExperimentController.set">
 918 <tt class="descname">set</tt><big>(</big><em>guid</em>, <em>name</em>, <em>value</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.set" title="Permalink to this definition">¶</a></dt>
 919 <dd><p>Modifies the value of the attribute with name &#8216;name&#8217; on the
 920 RM with guid &#8216;guid&#8217;.</p>
 921 <blockquote>
 922 <div><table class="docutils field-list" frame="void" rules="none">
 923 <col class="field-name" />
 924 <col class="field-body" />
 925 <tbody valign="top">
 926 <tr class="field-odd field"><th class="field-name">param guid:</th><td class="field-body">Guid of the RM</td>
 927 </tr>
 928 <tr class="field-even field"><th class="field-name">type guid:</th><td class="field-body">int</td>
 929 </tr>
 930 <tr class="field-odd field"><th class="field-name">param name:</th><td class="field-body">Name of the attribute</td>
 931 </tr>
 932 <tr class="field-even field"><th class="field-name">type name:</th><td class="field-body">str</td>
 933 </tr>
 934 <tr class="field-odd field"><th class="field-name">param value:</th><td class="field-body">Value of the attribute</td>
 935 </tr>
 936 </tbody>
 937 </table>
 938 </div></blockquote>
 939 </dd></dl>
 940
 941 <dl class="method">
 942 <dt id="nepi.execution.ec.ExperimentController.set_global">
 943 <tt class="descname">set_global</tt><big>(</big><em>rtype</em>, <em>name</em>, <em>value</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.set_global"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.set_global" title="Permalink to this definition">¶</a></dt>
 944 <dd><p>Modifies the value of the global attribute with name &#8216;name&#8217; on the
 945 RMs of with rtype &#8216;rtype&#8217;.</p>
 946 <blockquote>
 947 <div><table class="docutils field-list" frame="void" rules="none">
 948 <col class="field-name" />
 949 <col class="field-body" />
 950 <tbody valign="top">
 951 <tr class="field-odd field"><th class="field-name">param guid:</th><td class="field-body">Guid of the RM</td>
 952 </tr>
 953 <tr class="field-even field"><th class="field-name">type guid:</th><td class="field-body">int</td>
 954 </tr>
 955 <tr class="field-odd field"><th class="field-name">param name:</th><td class="field-body">Name of the attribute</td>
 956 </tr>
 957 <tr class="field-even field"><th class="field-name">type name:</th><td class="field-body">str</td>
 958 </tr>
 959 <tr class="field-odd field"><th class="field-name">param value:</th><td class="field-body">Value of the attribute</td>
 960 </tr>
 961 </tbody>
 962 </table>
 963 </div></blockquote>
 964 </dd></dl>
 965
 966 <dl class="method">
 967 <dt id="nepi.execution.ec.ExperimentController.set_with_conditions">
 968 <tt class="descname">set_with_conditions</tt><big>(</big><em>name</em>, <em>value</em>, <em>guids1</em>, <em>guids2</em>, <em>state</em>, <em>time=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.set_with_conditions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.set_with_conditions" title="Permalink to this definition">¶</a></dt>
 969 <dd><p>Modifies the value of attribute with name &#8216;name&#8217; on all RMs
 970 on the guids1 list when time &#8216;time&#8217; has elapsed since all
 971 elements in guids2 list have reached state &#8216;state&#8217;.</p>
 972 <blockquote>
 973 <div><table class="docutils field-list" frame="void" rules="none">
 974 <col class="field-name" />
 975 <col class="field-body" />
 976 <tbody valign="top">
 977 <tr class="field-odd field"><th class="field-name">param name:</th><td class="field-body">Name of attribute to set in RM</td>
 978 </tr>
 979 <tr class="field-even field"><th class="field-name">type name:</th><td class="field-body">string</td>
 980 </tr>
 981 <tr class="field-odd field"><th class="field-name">param value:</th><td class="field-body">Value of attribute to set in RM</td>
 982 </tr>
 983 <tr class="field-even field"><th class="field-name">type name:</th><td class="field-body">string</td>
 984 </tr>
 985 <tr class="field-odd field"><th class="field-name">param guids1:</th><td class="field-body">List of guids of RMs subjected to action</td>
 986 </tr>
 987 <tr class="field-even field"><th class="field-name">type guids1:</th><td class="field-body">list</td>
 988 </tr>
 989 <tr class="field-odd field"><th class="field-name">param action:</th><td class="field-body">Action to register (either START or STOP)</td>
 990 </tr>
 991 <tr class="field-even field"><th class="field-name">type action:</th><td class="field-body">ResourceAction</td>
 992 </tr>
 993 <tr class="field-odd field"><th class="field-name">param guids2:</th><td class="field-body">List of guids of RMs to we waited for</td>
 994 </tr>
 995 <tr class="field-even field"><th class="field-name">type guids2:</th><td class="field-body">list</td>
 996 </tr>
 997 <tr class="field-odd field"><th class="field-name">param state:</th><td class="field-body">State to wait for on RMs (STARTED, STOPPED, etc)</td>
 998 </tr>
 999 <tr class="field-even field"><th class="field-name">type state:</th><td class="field-body">ResourceState</td>
1000 </tr>
1001 <tr class="field-odd field"><th class="field-name">param time:</th><td class="field-body">Time to wait after guids2 has reached status</td>
1002 </tr>
1003 <tr class="field-even field"><th class="field-name">type time:</th><td class="field-body">string</td>
1004 </tr>
1005 </tbody>
1006 </table>
1007 </div></blockquote>
1008 </dd></dl>
1009
1010 <dl class="method">
1011 <dt id="nepi.execution.ec.ExperimentController.shutdown">
1012 <tt class="descname">shutdown</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.shutdown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.shutdown" title="Permalink to this definition">¶</a></dt>
1013 <dd><p>Releases all resources and stops the ExperimentController</p>
1014 </dd></dl>
1015
1016 <dl class="method">
1017 <dt id="nepi.execution.ec.ExperimentController.start">
1018 <tt class="descname">start</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.start" title="Permalink to this definition">¶</a></dt>
1019 <dd><p>Starts the RM with guid &#8216;guid&#8217;</p>
1020 <p>Starting a RM means that the resource it controls will
1021 begin taking part of the experiment.</p>
1022 <blockquote>
1023 <div><table class="docutils field-list" frame="void" rules="none">
1024 <col class="field-name" />
1025 <col class="field-body" />
1026 <tbody valign="top">
1027 <tr class="field-odd field"><th class="field-name">param guid:</th><td class="field-body">Guid of the RM</td>
1028 </tr>
1029 <tr class="field-even field"><th class="field-name">type guid:</th><td class="field-body">int</td>
1030 </tr>
1031 </tbody>
1032 </table>
1033 </div></blockquote>
1034 </dd></dl>
1035
1036 <dl class="method">
1037 <dt id="nepi.execution.ec.ExperimentController.state">
1038 <tt class="descname">state</tt><big>(</big><em>guid</em>, <em>hr=False</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.state" title="Permalink to this definition">¶</a></dt>
1039 <dd><p>Returns the state of a resource</p>
1040 <table class="docutils field-list" frame="void" rules="none">
1041 <col class="field-name" />
1042 <col class="field-body" />
1043 <tbody valign="top">
1044 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1045 <li><strong>guid</strong> (<em>integer</em>) &#8211; Resource guid</li>
1046 <li><strong>hr</strong> (<em>boolean</em>) &#8211; Human readable. Forces return of a
1047 status string instead of a number</li>
1048 </ul>
1049 </td>
1050 </tr>
1051 </tbody>
1052 </table>
1053 </dd></dl>
1054
1055 <dl class="method">
1056 <dt id="nepi.execution.ec.ExperimentController.stop">
1057 <tt class="descname">stop</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.stop" title="Permalink to this definition">¶</a></dt>
1058 <dd><p>Stops the RM with guid &#8216;guid&#8217;</p>
1059 <p>Stopping a RM means that the resource it controls will
1060 no longer take part of the experiment.</p>
1061 <blockquote>
1062 <div><table class="docutils field-list" frame="void" rules="none">
1063 <col class="field-name" />
1064 <col class="field-body" />
1065 <tbody valign="top">
1066 <tr class="field-odd field"><th class="field-name">param guid:</th><td class="field-body">Guid of the RM</td>
1067 </tr>
1068 <tr class="field-even field"><th class="field-name">type guid:</th><td class="field-body">int</td>
1069 </tr>
1070 </tbody>
1071 </table>
1072 </div></blockquote>
1073 </dd></dl>
1074
1075 <dl class="method">
1076 <dt id="nepi.execution.ec.ExperimentController.trace">
1077 <tt class="descname">trace</tt><big>(</big><em>guid</em>, <em>name</em>, <em>attr='all'</em>, <em>block=512</em>, <em>offset=0</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.trace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.trace" title="Permalink to this definition">¶</a></dt>
1078 <dd><p>Returns information on a collected trace, the trace stream or
1079 blocks (chunks) of the trace stream</p>
1080 <blockquote>
1081 <div><table class="docutils field-list" frame="void" rules="none">
1082 <col class="field-name" />
1083 <col class="field-body" />
1084 <tbody valign="top">
1085 <tr class="field-odd field"><th class="field-name">param name:</th><td class="field-body"><p class="first">Name of the trace</p>
1086 </td>
1087 </tr>
1088 <tr class="field-even field"><th class="field-name">type name:</th><td class="field-body"><p class="first">str</p>
1089 </td>
1090 </tr>
1091 <tr class="field-odd field"><th class="field-name">param attr:</th><td class="field-body"><p class="first">Can be one of:
1092 - TraceAttr.ALL (complete trace content),
1093 - TraceAttr.STREAM (block in bytes to read starting</p>
1094 <blockquote>
1095 <div><p>at offset),</p>
1096 </div></blockquote>
1097 <ul class="simple">
1098 <li>TraceAttr.PATH (full path to the trace file),</li>
1099 <li>TraceAttr.SIZE (size of trace file).</li>
1100 </ul>
1101 </td>
1102 </tr>
1103 <tr class="field-even field"><th class="field-name">type attr:</th><td class="field-body"><p class="first">str</p>
1104 </td>
1105 </tr>
1106 <tr class="field-odd field"><th class="field-name">param block:</th><td class="field-body"><p class="first">Number of bytes to retrieve from trace, when attr is
1107 TraceAttr.STREAM</p>
1108 </td>
1109 </tr>
1110 <tr class="field-even field"><th class="field-name">type name:</th><td class="field-body"><p class="first">int</p>
1111 </td>
1112 </tr>
1113 <tr class="field-odd field"><th class="field-name">param offset:</th><td class="field-body"><p class="first">Number of &#8216;blocks&#8217; to skip, when attr is TraceAttr.STREAM</p>
1114 </td>
1115 </tr>
1116 <tr class="field-even field"><th class="field-name">type name:</th><td class="field-body"><p class="first">int</p>
1117 </td>
1118 </tr>
1119 <tr class="field-odd field"><th class="field-name">rtype:</th><td class="field-body"><p class="first last">str</p>
1120 </td>
1121 </tr>
1122 </tbody>
1123 </table>
1124 </div></blockquote>
1125 </dd></dl>
1126
1127 <dl class="method">
1128 <dt id="nepi.execution.ec.ExperimentController.trace_enabled">
1129 <tt class="descname">trace_enabled</tt><big>(</big><em>guid</em>, <em>name</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.trace_enabled"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.trace_enabled" title="Permalink to this definition">¶</a></dt>
1130 <dd><p>Returns True if the trace of name &#8216;name&#8217; is enabled</p>
1131 <table class="docutils field-list" frame="void" rules="none">
1132 <col class="field-name" />
1133 <col class="field-body" />
1134 <tbody valign="top">
1135 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the trace</td>
1136 </tr>
1137 </tbody>
1138 </table>
1139 </dd></dl>
1140
1141 <dl class="method">
1142 <dt id="nepi.execution.ec.ExperimentController.wait">
1143 <tt class="descname">wait</tt><big>(</big><em>guids</em>, <em>state</em>, <em>quit</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.wait"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.wait" title="Permalink to this definition">¶</a></dt>
1144 <dd><p>Blocking method that waits until all RMs in the &#8216;guids&#8217; list
1145 have reached a state &gt;= &#8216;state&#8217;, or until the &#8216;quit&#8217; callback
1146 yields True</p>
1147 <blockquote>
1148 <div><table class="docutils field-list" frame="void" rules="none">
1149 <col class="field-name" />
1150 <col class="field-body" />
1151 <tbody valign="top">
1152 <tr class="field-odd field"><th class="field-name">param guids:</th><td class="field-body">List of guids</td>
1153 </tr>
1154 <tr class="field-even field"><th class="field-name">type guids:</th><td class="field-body">list</td>
1155 </tr>
1156 </tbody>
1157 </table>
1158 </div></blockquote>
1159 </dd></dl>
1160
1161 <dl class="method">
1162 <dt id="nepi.execution.ec.ExperimentController.wait_deployed">
1163 <tt class="descname">wait_deployed</tt><big>(</big><em>guids</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.wait_deployed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.wait_deployed" title="Permalink to this definition">¶</a></dt>
1164 <dd><p>Blocking method that waits until all RMs in the &#8216;guids&#8217; list
1165 have reached a state &gt;= READY, or until a failure in the
1166 experiment occurs (i.e. abort == True)</p>
1167 <blockquote>
1168 <div><table class="docutils field-list" frame="void" rules="none">
1169 <col class="field-name" />
1170 <col class="field-body" />
1171 <tbody valign="top">
1172 <tr class="field-odd field"><th class="field-name">param guids:</th><td class="field-body">List of guids</td>
1173 </tr>
1174 <tr class="field-even field"><th class="field-name">type guids:</th><td class="field-body">list</td>
1175 </tr>
1176 </tbody>
1177 </table>
1178 </div></blockquote>
1179 </dd></dl>
1180
1181 <dl class="method">
1182 <dt id="nepi.execution.ec.ExperimentController.wait_finished">
1183 <tt class="descname">wait_finished</tt><big>(</big><em>guids</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.wait_finished"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.wait_finished" title="Permalink to this definition">¶</a></dt>
1184 <dd><p>Blocking method that waits until all RMs in the &#8216;guids&#8217; list
1185 have reached a state &gt;= STOPPED (i.e. STOPPED, FAILED or
1186 RELEASED ), or until a failure in the experiment occurs
1187 (i.e. abort == True)</p>
1188 <blockquote>
1189 <div><table class="docutils field-list" frame="void" rules="none">
1190 <col class="field-name" />
1191 <col class="field-body" />
1192 <tbody valign="top">
1193 <tr class="field-odd field"><th class="field-name">param guids:</th><td class="field-body">List of guids</td>
1194 </tr>
1195 <tr class="field-even field"><th class="field-name">type guids:</th><td class="field-body">list</td>
1196 </tr>
1197 </tbody>
1198 </table>
1199 </div></blockquote>
1200 </dd></dl>
1201
1202 <dl class="method">
1203 <dt id="nepi.execution.ec.ExperimentController.wait_released">
1204 <tt class="descname">wait_released</tt><big>(</big><em>guids</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.wait_released"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.wait_released" title="Permalink to this definition">¶</a></dt>
1205 <dd><p>Blocking method that waits until all RMs in the &#8216;guids&#8217; list
1206 have reached a state == RELEASED, or until the EC fails</p>
1207 <blockquote>
1208 <div><table class="docutils field-list" frame="void" rules="none">
1209 <col class="field-name" />
1210 <col class="field-body" />
1211 <tbody valign="top">
1212 <tr class="field-odd field"><th class="field-name">param guids:</th><td class="field-body">List of guids</td>
1213 </tr>
1214 <tr class="field-even field"><th class="field-name">type guids:</th><td class="field-body">list</td>
1215 </tr>
1216 </tbody>
1217 </table>
1218 </div></blockquote>
1219 </dd></dl>
1220
1221 <dl class="method">
1222 <dt id="nepi.execution.ec.ExperimentController.wait_started">
1223 <tt class="descname">wait_started</tt><big>(</big><em>guids</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#ExperimentController.wait_started"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.ExperimentController.wait_started" title="Permalink to this definition">¶</a></dt>
1224 <dd><p>Blocking method that waits until all RMs in the &#8216;guids&#8217; list
1225 have reached a state &gt;= STARTED, or until a failure in the
1226 experiment occurs (i.e. abort == True)</p>
1227 <blockquote>
1228 <div><table class="docutils field-list" frame="void" rules="none">
1229 <col class="field-name" />
1230 <col class="field-body" />
1231 <tbody valign="top">
1232 <tr class="field-odd field"><th class="field-name">param guids:</th><td class="field-body">List of guids</td>
1233 </tr>
1234 <tr class="field-even field"><th class="field-name">type guids:</th><td class="field-body">list</td>
1235 </tr>
1236 </tbody>
1237 </table>
1238 </div></blockquote>
1239 </dd></dl>
1240
1241 </dd></dl>
1242
1243 <dl class="class">
1244 <dt id="nepi.execution.ec.FailureLevel">
1245 <em class="property">class </em><tt class="descclassname">nepi.execution.ec.</tt><tt class="descname">FailureLevel</tt><a class="reference internal" href="../_modules/nepi/execution/ec.html#FailureLevel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.FailureLevel" title="Permalink to this definition">¶</a></dt>
1246 <dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
1247 <p>Possible failure states for the experiment</p>
1248 <dl class="attribute">
1249 <dt id="nepi.execution.ec.FailureLevel.EC_FAILURE">
1250 <tt class="descname">EC_FAILURE</tt><em class="property"> = 3</em><a class="headerlink" href="#nepi.execution.ec.FailureLevel.EC_FAILURE" title="Permalink to this definition">¶</a></dt>
1251 <dd></dd></dl>
1252
1253 <dl class="attribute">
1254 <dt id="nepi.execution.ec.FailureLevel.OK">
1255 <tt class="descname">OK</tt><em class="property"> = 1</em><a class="headerlink" href="#nepi.execution.ec.FailureLevel.OK" title="Permalink to this definition">¶</a></dt>
1256 <dd></dd></dl>
1257
1258 <dl class="attribute">
1259 <dt id="nepi.execution.ec.FailureLevel.RM_FAILURE">
1260 <tt class="descname">RM_FAILURE</tt><em class="property"> = 2</em><a class="headerlink" href="#nepi.execution.ec.FailureLevel.RM_FAILURE" title="Permalink to this definition">¶</a></dt>
1261 <dd></dd></dl>
1262
1263 </dd></dl>
1264
1265 <dl class="class">
1266 <dt id="nepi.execution.ec.FailureManager">
1267 <em class="property">class </em><tt class="descclassname">nepi.execution.ec.</tt><tt class="descname">FailureManager</tt><a class="reference internal" href="../_modules/nepi/execution/ec.html#FailureManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.FailureManager" title="Permalink to this definition">¶</a></dt>
1268 <dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
1269 <p>The FailureManager is responsible for handling errors
1270 and deciding whether an experiment should be aborted or not</p>
1271 <dl class="attribute">
1272 <dt id="nepi.execution.ec.FailureManager.abort">
1273 <tt class="descname">abort</tt><a class="reference internal" href="../_modules/nepi/execution/ec.html#FailureManager.abort"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.FailureManager.abort" title="Permalink to this definition">¶</a></dt>
1274 <dd></dd></dl>
1275
1276 <dl class="attribute">
1277 <dt id="nepi.execution.ec.FailureManager.ec">
1278 <tt class="descname">ec</tt><a class="reference internal" href="../_modules/nepi/execution/ec.html#FailureManager.ec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.FailureManager.ec" title="Permalink to this definition">¶</a></dt>
1279 <dd><p>Returns the ExperimentController associated to this FailureManager</p>
1280 </dd></dl>
1281
1282 <dl class="method">
1283 <dt id="nepi.execution.ec.FailureManager.eval_failure">
1284 <tt class="descname">eval_failure</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#FailureManager.eval_failure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.FailureManager.eval_failure" title="Permalink to this definition">¶</a></dt>
1285 <dd><p>Implements failure policy and sets the abort state of the
1286 experiment based on the failure state and criticality of
1287 the RM</p>
1288 <table class="docutils field-list" frame="void" rules="none">
1289 <col class="field-name" />
1290 <col class="field-body" />
1291 <tbody valign="top">
1292 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Guid of the RM upon which the failure of the experiment
1293 is evaluated</td>
1294 </tr>
1295 </tbody>
1296 </table>
1297 </dd></dl>
1298
1299 <dl class="method">
1300 <dt id="nepi.execution.ec.FailureManager.set_ec">
1301 <tt class="descname">set_ec</tt><big>(</big><em>ec</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#FailureManager.set_ec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.FailureManager.set_ec" title="Permalink to this definition">¶</a></dt>
1302 <dd></dd></dl>
1303
1304 <dl class="method">
1305 <dt id="nepi.execution.ec.FailureManager.set_ec_failure">
1306 <tt class="descname">set_ec_failure</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/ec.html#FailureManager.set_ec_failure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.ec.FailureManager.set_ec_failure" title="Permalink to this definition">¶</a></dt>
1307 <dd></dd></dl>
1308
1309 </dd></dl>
1310
1311 </div>
1312 <div class="section" id="module-nepi.execution.resource">
1313 <span id="nepi-execution-resource-module"></span><h2>nepi.execution.resource module<a class="headerlink" href="#module-nepi.execution.resource" title="Permalink to this headline">¶</a></h2>
1314 <dl class="class">
1315 <dt id="nepi.execution.resource.ResourceAction">
1316 <em class="property">class </em><tt class="descclassname">nepi.execution.resource.</tt><tt class="descname">ResourceAction</tt><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceAction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceAction" title="Permalink to this definition">¶</a></dt>
1317 <dd><p>Action that a user can order to a Resource Manager</p>
1318 <dl class="attribute">
1319 <dt id="nepi.execution.resource.ResourceAction.DEPLOY">
1320 <tt class="descname">DEPLOY</tt><em class="property"> = 0</em><a class="headerlink" href="#nepi.execution.resource.ResourceAction.DEPLOY" title="Permalink to this definition">¶</a></dt>
1321 <dd></dd></dl>
1322
1323 <dl class="attribute">
1324 <dt id="nepi.execution.resource.ResourceAction.START">
1325 <tt class="descname">START</tt><em class="property"> = 1</em><a class="headerlink" href="#nepi.execution.resource.ResourceAction.START" title="Permalink to this definition">¶</a></dt>
1326 <dd></dd></dl>
1327
1328 <dl class="attribute">
1329 <dt id="nepi.execution.resource.ResourceAction.STOP">
1330 <tt class="descname">STOP</tt><em class="property"> = 2</em><a class="headerlink" href="#nepi.execution.resource.ResourceAction.STOP" title="Permalink to this definition">¶</a></dt>
1331 <dd></dd></dl>
1332
1333 </dd></dl>
1334
1335 <dl class="class">
1336 <dt id="nepi.execution.resource.ResourceFactory">
1337 <em class="property">class </em><tt class="descclassname">nepi.execution.resource.</tt><tt class="descname">ResourceFactory</tt><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceFactory" title="Permalink to this definition">¶</a></dt>
1338 <dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
1339 <dl class="classmethod">
1340 <dt id="nepi.execution.resource.ResourceFactory.create">
1341 <em class="property">classmethod </em><tt class="descname">create</tt><big>(</big><em>rtype</em>, <em>ec</em>, <em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceFactory.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceFactory.create" title="Permalink to this definition">¶</a></dt>
1342 <dd><p>Create a new instance of a Ressource Manager</p>
1343 </dd></dl>
1344
1345 <dl class="classmethod">
1346 <dt id="nepi.execution.resource.ResourceFactory.get_resource_type">
1347 <em class="property">classmethod </em><tt class="descname">get_resource_type</tt><big>(</big><em>rtype</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceFactory.get_resource_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceFactory.get_resource_type" title="Permalink to this definition">¶</a></dt>
1348 <dd><p>Return the type of the Class</p>
1349 </dd></dl>
1350
1351 <dl class="classmethod">
1352 <dt id="nepi.execution.resource.ResourceFactory.register_type">
1353 <em class="property">classmethod </em><tt class="descname">register_type</tt><big>(</big><em>rclass</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceFactory.register_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceFactory.register_type" title="Permalink to this definition">¶</a></dt>
1354 <dd><p>Register a new Ressource Manager</p>
1355 </dd></dl>
1356
1357 <dl class="classmethod">
1358 <dt id="nepi.execution.resource.ResourceFactory.resource_types">
1359 <em class="property">classmethod </em><tt class="descname">resource_types</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceFactory.resource_types"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceFactory.resource_types" title="Permalink to this definition">¶</a></dt>
1360 <dd><p>Return the type of the Class</p>
1361 </dd></dl>
1362
1363 </dd></dl>
1364
1365 <dl class="class">
1366 <dt id="nepi.execution.resource.ResourceManager">
1367 <em class="property">class </em><tt class="descclassname">nepi.execution.resource.</tt><tt class="descname">ResourceManager</tt><big>(</big><em>ec</em>, <em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager" title="Permalink to this definition">¶</a></dt>
1368 <dd><p>Bases: <a class="reference internal" href="nepi.util.html#nepi.util.logger.Logger" title="nepi.util.logger.Logger"><tt class="xref py py-class docutils literal"><span class="pre">nepi.util.logger.Logger</span></tt></a></p>
1369 <p>Base clase for all ResourceManagers.</p>
1370 <p>A ResourceManger is specific to a resource type (e.g. Node,
1371 Switch, Application, etc) on a specific platform (e.g. PlanetLab,
1372 OMF, etc).</p>
1373 <p>The ResourceManager instances are responsible for interacting with
1374 and controlling concrete (physical or virtual) resources in the
1375 experimental platforms.</p>
1376 <dl class="attribute">
1377 <dt id="nepi.execution.resource.ResourceManager.conditions">
1378 <tt class="descname">conditions</tt><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.conditions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.conditions" title="Permalink to this definition">¶</a></dt>
1379 <dd><p>Returns the conditions to which the RM is subjected to.</p>
1380 <p>This method returns a dictionary of conditions lists indexed by
1381 a ResourceAction.</p>
1382 </dd></dl>
1383
1384 <dl class="method">
1385 <dt id="nepi.execution.resource.ResourceManager.configure">
1386 <tt class="descname">configure</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.configure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.configure" title="Permalink to this definition">¶</a></dt>
1387 <dd></dd></dl>
1388
1389 <dl class="attribute">
1390 <dt id="nepi.execution.resource.ResourceManager.connections">
1391 <tt class="descname">connections</tt><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.connections"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.connections" title="Permalink to this definition">¶</a></dt>
1392 <dd><p>Returns the set of guids of connected RMs</p>
1393 </dd></dl>
1394
1395 <dl class="method">
1396 <dt id="nepi.execution.resource.ResourceManager.deploy">
1397 <tt class="descname">deploy</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.deploy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.deploy" title="Permalink to this definition">¶</a></dt>
1398 <dd></dd></dl>
1399
1400 <dl class="method">
1401 <dt id="nepi.execution.resource.ResourceManager.deploy_with_conditions">
1402 <tt class="descname">deploy_with_conditions</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.deploy_with_conditions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.deploy_with_conditions" title="Permalink to this definition">¶</a></dt>
1403 <dd><p>Deploy RM when all the conditions in self.conditions for
1404 action &#8216;READY&#8217; are satisfied.</p>
1405 </dd></dl>
1406
1407 <dl class="method">
1408 <dt id="nepi.execution.resource.ResourceManager.discover">
1409 <tt class="descname">discover</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.discover"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.discover" title="Permalink to this definition">¶</a></dt>
1410 <dd></dd></dl>
1411
1412 <dl class="attribute">
1413 <dt id="nepi.execution.resource.ResourceManager.discover_time">
1414 <tt class="descname">discover_time</tt><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.discover_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.discover_time" title="Permalink to this definition">¶</a></dt>
1415 <dd><p>Returns the discover time of the RM as a timestamp</p>
1416 </dd></dl>
1417
1418 <dl class="method">
1419 <dt id="nepi.execution.resource.ResourceManager.do_configure">
1420 <tt class="descname">do_configure</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.do_configure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.do_configure" title="Permalink to this definition">¶</a></dt>
1421 <dd></dd></dl>
1422
1423 <dl class="method">
1424 <dt id="nepi.execution.resource.ResourceManager.do_connect">
1425 <tt class="descname">do_connect</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.do_connect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.do_connect" title="Permalink to this definition">¶</a></dt>
1426 <dd><p>Performs actions that need to be taken upon associating RMs.
1427 This method should be redefined when necessary in child classes.</p>
1428 </dd></dl>
1429
1430 <dl class="method">
1431 <dt id="nepi.execution.resource.ResourceManager.do_deploy">
1432 <tt class="descname">do_deploy</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.do_deploy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.do_deploy" title="Permalink to this definition">¶</a></dt>
1433 <dd></dd></dl>
1434
1435 <dl class="method">
1436 <dt id="nepi.execution.resource.ResourceManager.do_disconnect">
1437 <tt class="descname">do_disconnect</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.do_disconnect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.do_disconnect" title="Permalink to this definition">¶</a></dt>
1438 <dd><p>Performs actions that need to be taken upon disassociating RMs.
1439 This method should be redefined when necessary in child classes.</p>
1440 </dd></dl>
1441
1442 <dl class="method">
1443 <dt id="nepi.execution.resource.ResourceManager.do_discover">
1444 <tt class="descname">do_discover</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.do_discover"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.do_discover" title="Permalink to this definition">¶</a></dt>
1445 <dd></dd></dl>
1446
1447 <dl class="method">
1448 <dt id="nepi.execution.resource.ResourceManager.do_fail">
1449 <tt class="descname">do_fail</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.do_fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.do_fail" title="Permalink to this definition">¶</a></dt>
1450 <dd></dd></dl>
1451
1452 <dl class="method">
1453 <dt id="nepi.execution.resource.ResourceManager.do_provision">
1454 <tt class="descname">do_provision</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.do_provision"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.do_provision" title="Permalink to this definition">¶</a></dt>
1455 <dd></dd></dl>
1456
1457 <dl class="method">
1458 <dt id="nepi.execution.resource.ResourceManager.do_release">
1459 <tt class="descname">do_release</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.do_release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.do_release" title="Permalink to this definition">¶</a></dt>
1460 <dd></dd></dl>
1461
1462 <dl class="method">
1463 <dt id="nepi.execution.resource.ResourceManager.do_reserve">
1464 <tt class="descname">do_reserve</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.do_reserve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.do_reserve" title="Permalink to this definition">¶</a></dt>
1465 <dd></dd></dl>
1466
1467 <dl class="method">
1468 <dt id="nepi.execution.resource.ResourceManager.do_start">
1469 <tt class="descname">do_start</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.do_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.do_start" title="Permalink to this definition">¶</a></dt>
1470 <dd></dd></dl>
1471
1472 <dl class="method">
1473 <dt id="nepi.execution.resource.ResourceManager.do_stop">
1474 <tt class="descname">do_stop</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.do_stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.do_stop" title="Permalink to this definition">¶</a></dt>
1475 <dd></dd></dl>
1476
1477 <dl class="attribute">
1478 <dt id="nepi.execution.resource.ResourceManager.ec">
1479 <tt class="descname">ec</tt><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.ec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.ec" title="Permalink to this definition">¶</a></dt>
1480 <dd><p>Returns the Experiment Controller of the RM</p>
1481 </dd></dl>
1482
1483 <dl class="method">
1484 <dt id="nepi.execution.resource.ResourceManager.enable_trace">
1485 <tt class="descname">enable_trace</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.enable_trace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.enable_trace" title="Permalink to this definition">¶</a></dt>
1486 <dd><p>Explicitly enable trace generation</p>
1487 <table class="docutils field-list" frame="void" rules="none">
1488 <col class="field-name" />
1489 <col class="field-body" />
1490 <tbody valign="top">
1491 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the trace</td>
1492 </tr>
1493 </tbody>
1494 </table>
1495 </dd></dl>
1496
1497 <dl class="method">
1498 <dt id="nepi.execution.resource.ResourceManager.fail">
1499 <tt class="descname">fail</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.fail" title="Permalink to this definition">¶</a></dt>
1500 <dd><p>Sets the RM to state FAILED.</p>
1501 <p>This method should not be overridden directly. Specific functionality
1502 should be added in the do_fail method.</p>
1503 </dd></dl>
1504
1505 <dl class="attribute">
1506 <dt id="nepi.execution.resource.ResourceManager.failed_time">
1507 <tt class="descname">failed_time</tt><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.failed_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.failed_time" title="Permalink to this definition">¶</a></dt>
1508 <dd><p>Returns the time failure occurred for the RM as a timestamp</p>
1509 </dd></dl>
1510
1511 <dl class="method">
1512 <dt id="nepi.execution.resource.ResourceManager.get">
1513 <tt class="descname">get</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.get" title="Permalink to this definition">¶</a></dt>
1514 <dd><p>Returns the value of the attribute</p>
1515 <table class="docutils field-list" frame="void" rules="none">
1516 <col class="field-name" />
1517 <col class="field-body" />
1518 <tbody valign="top">
1519 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the attribute</td>
1520 </tr>
1521 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>
1522 </tr>
1523 </tbody>
1524 </table>
1525 </dd></dl>
1526
1527 <dl class="classmethod">
1528 <dt id="nepi.execution.resource.ResourceManager.get_attribute">
1529 <em class="property">classmethod </em><tt class="descname">get_attribute</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.get_attribute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.get_attribute" title="Permalink to this definition">¶</a></dt>
1530 <dd><p>Returns a copy of the attribute with name &#8216;name&#8217;</p>
1531 </dd></dl>
1532
1533 <dl class="classmethod">
1534 <dt id="nepi.execution.resource.ResourceManager.get_attributes">
1535 <em class="property">classmethod </em><tt class="descname">get_attributes</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.get_attributes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.get_attributes" title="Permalink to this definition">¶</a></dt>
1536 <dd><p>Returns a copy of the attributes</p>
1537 </dd></dl>
1538
1539 <dl class="method">
1540 <dt id="nepi.execution.resource.ResourceManager.get_connected">
1541 <tt class="descname">get_connected</tt><big>(</big><em>rtype=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.get_connected"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.get_connected" title="Permalink to this definition">¶</a></dt>
1542 <dd><p>Returns the list of RM with the type &#8216;rtype&#8217;</p>
1543 <table class="docutils field-list" frame="void" rules="none">
1544 <col class="field-name" />
1545 <col class="field-body" />
1546 <tbody valign="top">
1547 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>rtype</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Type of the RM we look for</td>
1548 </tr>
1549 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">list of guid</td>
1550 </tr>
1551 </tbody>
1552 </table>
1553 </dd></dl>
1554
1555 <dl class="classmethod">
1556 <dt id="nepi.execution.resource.ResourceManager.get_global">
1557 <em class="property">classmethod </em><tt class="descname">get_global</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.get_global"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.get_global" title="Permalink to this definition">¶</a></dt>
1558 <dd><dl class="docutils">
1559 <dt>Returns the value of a global attribute</dt>
1560 <dd>Global attribute meaning an attribute for
1561 all the resources from a rtype</dd>
1562 </dl>
1563 <table class="docutils field-list" frame="void" rules="none">
1564 <col class="field-name" />
1565 <col class="field-body" />
1566 <tbody valign="top">
1567 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the attribute</td>
1568 </tr>
1569 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>
1570 </tr>
1571 </tbody>
1572 </table>
1573 </dd></dl>
1574
1575 <dl class="classmethod">
1576 <dt id="nepi.execution.resource.ResourceManager.get_help">
1577 <em class="property">classmethod </em><tt class="descname">get_help</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.get_help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.get_help" title="Permalink to this definition">¶</a></dt>
1578 <dd><p>Returns the description of the type of Resource</p>
1579 </dd></dl>
1580
1581 <dl class="classmethod">
1582 <dt id="nepi.execution.resource.ResourceManager.get_platform">
1583 <em class="property">classmethod </em><tt class="descname">get_platform</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.get_platform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.get_platform" title="Permalink to this definition">¶</a></dt>
1584 <dd><p>Returns the identified of the platform (i.e. testbed type)
1585 for the Resource</p>
1586 </dd></dl>
1587
1588 <dl class="classmethod">
1589 <dt id="nepi.execution.resource.ResourceManager.get_rtype">
1590 <em class="property">classmethod </em><tt class="descname">get_rtype</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.get_rtype"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.get_rtype" title="Permalink to this definition">¶</a></dt>
1591 <dd><p>Returns the type of the Resource Manager</p>
1592 </dd></dl>
1593
1594 <dl class="classmethod">
1595 <dt id="nepi.execution.resource.ResourceManager.get_traces">
1596 <em class="property">classmethod </em><tt class="descname">get_traces</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.get_traces"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.get_traces" title="Permalink to this definition">¶</a></dt>
1597 <dd><p>Returns a copy of the traces</p>
1598 </dd></dl>
1599
1600 <dl class="attribute">
1601 <dt id="nepi.execution.resource.ResourceManager.guid">
1602 <tt class="descname">guid</tt><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.guid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.guid" title="Permalink to this definition">¶</a></dt>
1603 <dd><p>Returns the global unique identifier of the RM</p>
1604 </dd></dl>
1605
1606 <dl class="method">
1607 <dt id="nepi.execution.resource.ResourceManager.has_attribute">
1608 <tt class="descname">has_attribute</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.has_attribute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.has_attribute" title="Permalink to this definition">¶</a></dt>
1609 <dd><p>Returns true if the RM has an attribute with name</p>
1610 <table class="docutils field-list" frame="void" rules="none">
1611 <col class="field-name" />
1612 <col class="field-body" />
1613 <tbody valign="top">
1614 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<a class="reference external" href="http://docs.python.org/library/string.html#module-string" title="(in Python v2.7)"><em>string</em></a>) &#8211; name of the attribute</td>
1615 </tr>
1616 </tbody>
1617 </table>
1618 </dd></dl>
1619
1620 <dl class="method">
1621 <dt id="nepi.execution.resource.ResourceManager.has_changed">
1622 <tt class="descname">has_changed</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.has_changed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.has_changed" title="Permalink to this definition">¶</a></dt>
1623 <dd><dl class="docutils">
1624 <dt>Returns the True is the value of the attribute</dt>
1625 <dd>has been modified by the user.</dd>
1626 </dl>
1627 <table class="docutils field-list" frame="void" rules="none">
1628 <col class="field-name" />
1629 <col class="field-body" />
1630 <tbody valign="top">
1631 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the attribute</td>
1632 </tr>
1633 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>
1634 </tr>
1635 </tbody>
1636 </table>
1637 </dd></dl>
1638
1639 <dl class="method">
1640 <dt id="nepi.execution.resource.ResourceManager.has_flag">
1641 <tt class="descname">has_flag</tt><big>(</big><em>name</em>, <em>flag</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.has_flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.has_flag" title="Permalink to this definition">¶</a></dt>
1642 <dd><p>Returns true if the attribute has the flag &#8216;flag&#8217;</p>
1643 <table class="docutils field-list" frame="void" rules="none">
1644 <col class="field-name" />
1645 <col class="field-body" />
1646 <tbody valign="top">
1647 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>flag</strong> (<em>Flags</em>) &#8211; Flag to be checked</td>
1648 </tr>
1649 </tbody>
1650 </table>
1651 </dd></dl>
1652
1653 <dl class="method">
1654 <dt id="nepi.execution.resource.ResourceManager.is_rm_instance">
1655 <tt class="descname">is_rm_instance</tt><big>(</big><em>rtype</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.is_rm_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.is_rm_instance" title="Permalink to this definition">¶</a></dt>
1656 <dd><p>Returns True if the RM is instance of &#8216;rtype&#8217;</p>
1657 <table class="docutils field-list" frame="void" rules="none">
1658 <col class="field-name" />
1659 <col class="field-body" />
1660 <tbody valign="top">
1661 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>rtype</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Type of the RM we look for</td>
1662 </tr>
1663 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True|False</td>
1664 </tr>
1665 </tbody>
1666 </table>
1667 </dd></dl>
1668
1669 <dl class="method">
1670 <dt id="nepi.execution.resource.ResourceManager.log_message">
1671 <tt class="descname">log_message</tt><big>(</big><em>msg</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.log_message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.log_message" title="Permalink to this definition">¶</a></dt>
1672 <dd><p>Returns the log message formatted with added information.</p>
1673 <table class="docutils field-list" frame="void" rules="none">
1674 <col class="field-name" />
1675 <col class="field-body" />
1676 <tbody valign="top">
1677 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>msg</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; text message</td>
1678 </tr>
1679 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">str</td>
1680 </tr>
1681 </tbody>
1682 </table>
1683 </dd></dl>
1684
1685 <dl class="method">
1686 <dt id="nepi.execution.resource.ResourceManager.provision">
1687 <tt class="descname">provision</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.provision"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.provision" title="Permalink to this definition">¶</a></dt>
1688 <dd></dd></dl>
1689
1690 <dl class="attribute">
1691 <dt id="nepi.execution.resource.ResourceManager.provision_time">
1692 <tt class="descname">provision_time</tt><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.provision_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.provision_time" title="Permalink to this definition">¶</a></dt>
1693 <dd><p>Returns the provision time of the RM as a timestamp</p>
1694 </dd></dl>
1695
1696 <dl class="attribute">
1697 <dt id="nepi.execution.resource.ResourceManager.ready_time">
1698 <tt class="descname">ready_time</tt><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.ready_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.ready_time" title="Permalink to this definition">¶</a></dt>
1699 <dd><p>Returns the deployment time of the RM as a timestamp</p>
1700 </dd></dl>
1701
1702 <dl class="method">
1703 <dt id="nepi.execution.resource.ResourceManager.register_condition">
1704 <tt class="descname">register_condition</tt><big>(</big><em>action</em>, <em>group</em>, <em>state</em>, <em>time=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.register_condition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.register_condition" title="Permalink to this definition">¶</a></dt>
1705 <dd><p>Registers a condition on the resource manager to allow execution
1706 of &#8216;action&#8217; only after &#8216;time&#8217; has elapsed from the moment all resources
1707 in &#8216;group&#8217; reached state &#8216;state&#8217;</p>
1708 <table class="docutils field-list" frame="void" rules="none">
1709 <col class="field-name" />
1710 <col class="field-body" />
1711 <tbody valign="top">
1712 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1713 <li><strong>action</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Action to restrict to condition (either &#8216;START&#8217; or &#8216;STOP&#8217;)</li>
1714 <li><strong>group</strong> (<em>int or list of int</em>) &#8211; Group of RMs to wait for (list of guids)</li>
1715 <li><strong>state</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; State to wait for on all RM in group. (either &#8216;STARTED&#8217;, &#8216;STOPPED&#8217; or &#8216;READY&#8217;)</li>
1716 <li><strong>time</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Time to wait after &#8216;state&#8217; is reached on all RMs in group. (e.g. &#8216;2s&#8217;)</li>
1717 </ul>
1718 </td>
1719 </tr>
1720 </tbody>
1721 </table>
1722 </dd></dl>
1723
1724 <dl class="method">
1725 <dt id="nepi.execution.resource.ResourceManager.register_connection">
1726 <tt class="descname">register_connection</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.register_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.register_connection" title="Permalink to this definition">¶</a></dt>
1727 <dd><p>Registers a connection to the RM identified by guid</p>
1728 <p>This method should not be overridden. Specific functionality
1729 should be added in the do_connect method.</p>
1730 <table class="docutils field-list" frame="void" rules="none">
1731 <col class="field-name" />
1732 <col class="field-body" />
1733 <tbody valign="top">
1734 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Global unique identified of the RM to connect to</td>
1735 </tr>
1736 </tbody>
1737 </table>
1738 </dd></dl>
1739
1740 <dl class="method">
1741 <dt id="nepi.execution.resource.ResourceManager.release">
1742 <tt class="descname">release</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.release"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.release" title="Permalink to this definition">¶</a></dt>
1743 <dd><p>Perform actions to free resources used by the RM.</p>
1744 <p>This  method is responsible for releasing resources that were
1745 used during the experiment by the RM.</p>
1746 <p>This method should not be overridden directly. Specific functionality
1747 should be added in the do_release method.</p>
1748 </dd></dl>
1749
1750 <dl class="attribute">
1751 <dt id="nepi.execution.resource.ResourceManager.release_time">
1752 <tt class="descname">release_time</tt><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.release_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.release_time" title="Permalink to this definition">¶</a></dt>
1753 <dd><p>Returns the release time of the RM as a timestamp</p>
1754 </dd></dl>
1755
1756 <dl class="attribute">
1757 <dt id="nepi.execution.resource.ResourceManager.reschedule_delay">
1758 <tt class="descname">reschedule_delay</tt><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.reschedule_delay"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.reschedule_delay" title="Permalink to this definition">¶</a></dt>
1759 <dd><p>Returns default reschedule delay</p>
1760 </dd></dl>
1761
1762 <dl class="method">
1763 <dt id="nepi.execution.resource.ResourceManager.reserve">
1764 <tt class="descname">reserve</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.reserve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.reserve" title="Permalink to this definition">¶</a></dt>
1765 <dd></dd></dl>
1766
1767 <dl class="attribute">
1768 <dt id="nepi.execution.resource.ResourceManager.reserved_time">
1769 <tt class="descname">reserved_time</tt><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.reserved_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.reserved_time" title="Permalink to this definition">¶</a></dt>
1770 <dd><p>Returns the reserved time of the RM as a timestamp</p>
1771 </dd></dl>
1772
1773 <dl class="method">
1774 <dt id="nepi.execution.resource.ResourceManager.set">
1775 <tt class="descname">set</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.set" title="Permalink to this definition">¶</a></dt>
1776 <dd><p>Set the value of the attribute</p>
1777 <table class="docutils field-list" frame="void" rules="none">
1778 <col class="field-name" />
1779 <col class="field-body" />
1780 <tbody valign="top">
1781 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1782 <li><strong>name</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the attribute</li>
1783 <li><strong>name</strong> &#8211; Value of the attribute</li>
1784 </ul>
1785 </td>
1786 </tr>
1787 </tbody>
1788 </table>
1789 </dd></dl>
1790
1791 <dl class="method">
1792 <dt id="nepi.execution.resource.ResourceManager.set_discovered">
1793 <tt class="descname">set_discovered</tt><big>(</big><em>time=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.set_discovered"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.set_discovered" title="Permalink to this definition">¶</a></dt>
1794 <dd><p>Mark ResourceManager as DISCOVERED</p>
1795 </dd></dl>
1796
1797 <dl class="method">
1798 <dt id="nepi.execution.resource.ResourceManager.set_failed">
1799 <tt class="descname">set_failed</tt><big>(</big><em>time=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.set_failed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.set_failed" title="Permalink to this definition">¶</a></dt>
1800 <dd><p>Mark ResourceManager as FAILED</p>
1801 </dd></dl>
1802
1803 <dl class="classmethod">
1804 <dt id="nepi.execution.resource.ResourceManager.set_global">
1805 <em class="property">classmethod </em><tt class="descname">set_global</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.set_global"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.set_global" title="Permalink to this definition">¶</a></dt>
1806 <dd><p>Set value for a global attribute</p>
1807 <table class="docutils field-list" frame="void" rules="none">
1808 <col class="field-name" />
1809 <col class="field-body" />
1810 <tbody valign="top">
1811 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1812 <li><strong>name</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the attribute</li>
1813 <li><strong>name</strong> &#8211; Value of the attribute</li>
1814 </ul>
1815 </td>
1816 </tr>
1817 </tbody>
1818 </table>
1819 </dd></dl>
1820
1821 <dl class="method">
1822 <dt id="nepi.execution.resource.ResourceManager.set_provisioned">
1823 <tt class="descname">set_provisioned</tt><big>(</big><em>time=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.set_provisioned"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.set_provisioned" title="Permalink to this definition">¶</a></dt>
1824 <dd><p>Mark ResourceManager as PROVISIONED</p>
1825 </dd></dl>
1826
1827 <dl class="method">
1828 <dt id="nepi.execution.resource.ResourceManager.set_ready">
1829 <tt class="descname">set_ready</tt><big>(</big><em>time=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.set_ready"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.set_ready" title="Permalink to this definition">¶</a></dt>
1830 <dd><p>Mark ResourceManager as READY</p>
1831 </dd></dl>
1832
1833 <dl class="method">
1834 <dt id="nepi.execution.resource.ResourceManager.set_released">
1835 <tt class="descname">set_released</tt><big>(</big><em>time=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.set_released"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.set_released" title="Permalink to this definition">¶</a></dt>
1836 <dd><p>Mark ResourceManager as REALEASED</p>
1837 </dd></dl>
1838
1839 <dl class="method">
1840 <dt id="nepi.execution.resource.ResourceManager.set_reserved">
1841 <tt class="descname">set_reserved</tt><big>(</big><em>time=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.set_reserved"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.set_reserved" title="Permalink to this definition">¶</a></dt>
1842 <dd><p>Mark ResourceManager as RESERVED</p>
1843 </dd></dl>
1844
1845 <dl class="method">
1846 <dt id="nepi.execution.resource.ResourceManager.set_started">
1847 <tt class="descname">set_started</tt><big>(</big><em>time=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.set_started"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.set_started" title="Permalink to this definition">¶</a></dt>
1848 <dd><p>Mark ResourceManager as STARTED</p>
1849 </dd></dl>
1850
1851 <dl class="method">
1852 <dt id="nepi.execution.resource.ResourceManager.set_state">
1853 <tt class="descname">set_state</tt><big>(</big><em>state</em>, <em>state_time_attr</em>, <em>time=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.set_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.set_state" title="Permalink to this definition">¶</a></dt>
1854 <dd><p>Set the state of the RM while keeping a trace of the time</p>
1855 </dd></dl>
1856
1857 <dl class="method">
1858 <dt id="nepi.execution.resource.ResourceManager.set_state_time">
1859 <tt class="descname">set_state_time</tt><big>(</big><em>state</em>, <em>state_time_attr</em>, <em>time</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.set_state_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.set_state_time" title="Permalink to this definition">¶</a></dt>
1860 <dd><p>Set the time for the RM state change</p>
1861 </dd></dl>
1862
1863 <dl class="method">
1864 <dt id="nepi.execution.resource.ResourceManager.set_stopped">
1865 <tt class="descname">set_stopped</tt><big>(</big><em>time=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.set_stopped"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.set_stopped" title="Permalink to this definition">¶</a></dt>
1866 <dd><p>Mark ResourceManager as STOPPED</p>
1867 </dd></dl>
1868
1869 <dl class="method">
1870 <dt id="nepi.execution.resource.ResourceManager.set_with_conditions">
1871 <tt class="descname">set_with_conditions</tt><big>(</big><em>name</em>, <em>value</em>, <em>group</em>, <em>state</em>, <em>time</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.set_with_conditions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.set_with_conditions" title="Permalink to this definition">¶</a></dt>
1872 <dd><p>Set value &#8216;value&#8217; on attribute with name &#8216;name&#8217; when &#8216;time&#8217;
1873 has elapsed since all elements in &#8216;group&#8217; have reached state
1874 &#8216;state&#8217;</p>
1875 <table class="docutils field-list" frame="void" rules="none">
1876 <col class="field-name" />
1877 <col class="field-body" />
1878 <tbody valign="top">
1879 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1880 <li><strong>name</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the attribute to set</li>
1881 <li><strong>name</strong> &#8211; Value of the attribute to set</li>
1882 <li><strong>group</strong> (<em>int or list of int</em>) &#8211; Group of RMs to wait for (list of guids)</li>
1883 <li><strong>state</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; State to wait for on all RM in group. (either &#8216;STARTED&#8217;, &#8216;STOPPED&#8217; or &#8216;READY&#8217;)</li>
1884 <li><strong>time</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Time to wait after &#8216;state&#8217; is reached on all RMs in group. (e.g. &#8216;2s&#8217;)</li>
1885 </ul>
1886 </td>
1887 </tr>
1888 </tbody>
1889 </table>
1890 </dd></dl>
1891
1892 <dl class="method">
1893 <dt id="nepi.execution.resource.ResourceManager.start">
1894 <tt class="descname">start</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.start" title="Permalink to this definition">¶</a></dt>
1895 <dd></dd></dl>
1896
1897 <dl class="attribute">
1898 <dt id="nepi.execution.resource.ResourceManager.start_time">
1899 <tt class="descname">start_time</tt><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.start_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.start_time" title="Permalink to this definition">¶</a></dt>
1900 <dd><p>Returns the start time of the RM as a timestamp</p>
1901 </dd></dl>
1902
1903 <dl class="method">
1904 <dt id="nepi.execution.resource.ResourceManager.start_with_conditions">
1905 <tt class="descname">start_with_conditions</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.start_with_conditions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.start_with_conditions" title="Permalink to this definition">¶</a></dt>
1906 <dd><p>Starts RM when all the conditions in self.conditions for
1907 action &#8216;START&#8217; are satisfied.</p>
1908 </dd></dl>
1909
1910 <dl class="attribute">
1911 <dt id="nepi.execution.resource.ResourceManager.state">
1912 <tt class="descname">state</tt><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.state" title="Permalink to this definition">¶</a></dt>
1913 <dd><p>Get the current state of the RM</p>
1914 </dd></dl>
1915
1916 <dl class="method">
1917 <dt id="nepi.execution.resource.ResourceManager.stop">
1918 <tt class="descname">stop</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.stop" title="Permalink to this definition">¶</a></dt>
1919 <dd></dd></dl>
1920
1921 <dl class="attribute">
1922 <dt id="nepi.execution.resource.ResourceManager.stop_time">
1923 <tt class="descname">stop_time</tt><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.stop_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.stop_time" title="Permalink to this definition">¶</a></dt>
1924 <dd><p>Returns the stop time of the RM as a timestamp</p>
1925 </dd></dl>
1926
1927 <dl class="method">
1928 <dt id="nepi.execution.resource.ResourceManager.stop_with_conditions">
1929 <tt class="descname">stop_with_conditions</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.stop_with_conditions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.stop_with_conditions" title="Permalink to this definition">¶</a></dt>
1930 <dd><p>Stops RM when all the conditions in self.conditions for
1931 action &#8216;STOP&#8217; are satisfied.</p>
1932 </dd></dl>
1933
1934 <dl class="method">
1935 <dt id="nepi.execution.resource.ResourceManager.trace">
1936 <tt class="descname">trace</tt><big>(</big><em>name</em>, <em>attr='all'</em>, <em>block=512</em>, <em>offset=0</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.trace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.trace" title="Permalink to this definition">¶</a></dt>
1937 <dd><p>Get information on collected trace</p>
1938 <table class="docutils field-list" frame="void" rules="none">
1939 <col class="field-name" />
1940 <col class="field-body" />
1941 <tbody valign="top">
1942 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
1943 <li><strong>name</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Name of the trace</li>
1944 <li><strong>attr</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Can be one of:
1945 - TraceAttr.ALL (complete trace content),
1946 - TraceAttr.STREAM (block in bytes to read starting at offset),
1947 - TraceAttr.PATH (full path to the trace file),
1948 - TraceAttr.SIZE (size of trace file).</li>
1949 <li><strong>block</strong> &#8211; Number of bytes to retrieve from trace, when attr is TraceAttr.STREAM</li>
1950 <li><strong>offset</strong> &#8211; Number of &#8216;blocks&#8217; to skip, when attr is TraceAttr.STREAM</li>
1951 </ul>
1952 </td>
1953 </tr>
1954 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
1955 </td>
1956 </tr>
1957 </tbody>
1958 </table>
1959 </dd></dl>
1960
1961 <dl class="method">
1962 <dt id="nepi.execution.resource.ResourceManager.trace_enabled">
1963 <tt class="descname">trace_enabled</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.trace_enabled"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.trace_enabled" title="Permalink to this definition">¶</a></dt>
1964 <dd><p>Returns True if trace is enables</p>
1965 <table class="docutils field-list" frame="void" rules="none">
1966 <col class="field-name" />
1967 <col class="field-body" />
1968 <tbody valign="top">
1969 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Name of the trace</td>
1970 </tr>
1971 </tbody>
1972 </table>
1973 </dd></dl>
1974
1975 <dl class="method">
1976 <dt id="nepi.execution.resource.ResourceManager.unregister_condition">
1977 <tt class="descname">unregister_condition</tt><big>(</big><em>group</em>, <em>action=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.unregister_condition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.unregister_condition" title="Permalink to this definition">¶</a></dt>
1978 <dd><p>Removed conditions for a certain group of guids</p>
1979 <table class="docutils field-list" frame="void" rules="none">
1980 <col class="field-name" />
1981 <col class="field-body" />
1982 <tbody valign="top">
1983 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1984 <li><strong>action</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#str" title="(in Python v2.7)"><em>str</em></a>) &#8211; Action to restrict to condition (either &#8216;START&#8217;, &#8216;STOP&#8217; or &#8216;READY&#8217;)</li>
1985 <li><strong>group</strong> (<em>int or list of int</em>) &#8211; Group of RMs to wait for (list of guids)</li>
1986 </ul>
1987 </td>
1988 </tr>
1989 </tbody>
1990 </table>
1991 </dd></dl>
1992
1993 <dl class="method">
1994 <dt id="nepi.execution.resource.ResourceManager.unregister_connection">
1995 <tt class="descname">unregister_connection</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.unregister_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.unregister_connection" title="Permalink to this definition">¶</a></dt>
1996 <dd><p>Removes a registered connection to the RM identified by guid</p>
1997 <p>This method should not be overridden. Specific functionality
1998 should be added in the do_disconnect method.</p>
1999 <table class="docutils field-list" frame="void" rules="none">
2000 <col class="field-name" />
2001 <col class="field-body" />
2002 <tbody valign="top">
2003 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Global unique identified of the RM to connect to</td>
2004 </tr>
2005 </tbody>
2006 </table>
2007 </dd></dl>
2008
2009 <dl class="method">
2010 <dt id="nepi.execution.resource.ResourceManager.valid_connection">
2011 <tt class="descname">valid_connection</tt><big>(</big><em>guid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceManager.valid_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceManager.valid_connection" title="Permalink to this definition">¶</a></dt>
2012 <dd><p>Checks whether a connection with the other RM
2013 is valid.
2014 This method need to be redefined by each new Resource Manager.</p>
2015 <table class="docutils field-list" frame="void" rules="none">
2016 <col class="field-name" />
2017 <col class="field-body" />
2018 <tbody valign="top">
2019 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>guid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Guid of the current Resource Manager</td>
2020 </tr>
2021 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Boolean</td>
2022 </tr>
2023 </tbody>
2024 </table>
2025 </dd></dl>
2026
2027 </dd></dl>
2028
2029 <dl class="class">
2030 <dt id="nepi.execution.resource.ResourceState">
2031 <em class="property">class </em><tt class="descclassname">nepi.execution.resource.</tt><tt class="descname">ResourceState</tt><a class="reference internal" href="../_modules/nepi/execution/resource.html#ResourceState"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.ResourceState" title="Permalink to this definition">¶</a></dt>
2032 <dd><p>State of a Resource Manager</p>
2033 <dl class="attribute">
2034 <dt id="nepi.execution.resource.ResourceState.DISCOVERED">
2035 <tt class="descname">DISCOVERED</tt><em class="property"> = 1</em><a class="headerlink" href="#nepi.execution.resource.ResourceState.DISCOVERED" title="Permalink to this definition">¶</a></dt>
2036 <dd></dd></dl>
2037
2038 <dl class="attribute">
2039 <dt id="nepi.execution.resource.ResourceState.FAILED">
2040 <tt class="descname">FAILED</tt><em class="property"> = 7</em><a class="headerlink" href="#nepi.execution.resource.ResourceState.FAILED" title="Permalink to this definition">¶</a></dt>
2041 <dd></dd></dl>
2042
2043 <dl class="attribute">
2044 <dt id="nepi.execution.resource.ResourceState.NEW">
2045 <tt class="descname">NEW</tt><em class="property"> = 0</em><a class="headerlink" href="#nepi.execution.resource.ResourceState.NEW" title="Permalink to this definition">¶</a></dt>
2046 <dd></dd></dl>
2047
2048 <dl class="attribute">
2049 <dt id="nepi.execution.resource.ResourceState.PROVISIONED">
2050 <tt class="descname">PROVISIONED</tt><em class="property"> = 3</em><a class="headerlink" href="#nepi.execution.resource.ResourceState.PROVISIONED" title="Permalink to this definition">¶</a></dt>
2051 <dd></dd></dl>
2052
2053 <dl class="attribute">
2054 <dt id="nepi.execution.resource.ResourceState.READY">
2055 <tt class="descname">READY</tt><em class="property"> = 4</em><a class="headerlink" href="#nepi.execution.resource.ResourceState.READY" title="Permalink to this definition">¶</a></dt>
2056 <dd></dd></dl>
2057
2058 <dl class="attribute">
2059 <dt id="nepi.execution.resource.ResourceState.RELEASED">
2060 <tt class="descname">RELEASED</tt><em class="property"> = 8</em><a class="headerlink" href="#nepi.execution.resource.ResourceState.RELEASED" title="Permalink to this definition">¶</a></dt>
2061 <dd></dd></dl>
2062
2063 <dl class="attribute">
2064 <dt id="nepi.execution.resource.ResourceState.RESERVED">
2065 <tt class="descname">RESERVED</tt><em class="property"> = 2</em><a class="headerlink" href="#nepi.execution.resource.ResourceState.RESERVED" title="Permalink to this definition">¶</a></dt>
2066 <dd></dd></dl>
2067
2068 <dl class="attribute">
2069 <dt id="nepi.execution.resource.ResourceState.STARTED">
2070 <tt class="descname">STARTED</tt><em class="property"> = 5</em><a class="headerlink" href="#nepi.execution.resource.ResourceState.STARTED" title="Permalink to this definition">¶</a></dt>
2071 <dd></dd></dl>
2072
2073 <dl class="attribute">
2074 <dt id="nepi.execution.resource.ResourceState.STOPPED">
2075 <tt class="descname">STOPPED</tt><em class="property"> = 6</em><a class="headerlink" href="#nepi.execution.resource.ResourceState.STOPPED" title="Permalink to this definition">¶</a></dt>
2076 <dd></dd></dl>
2077
2078 </dd></dl>
2079
2080 <dl class="function">
2081 <dt id="nepi.execution.resource.clsinit">
2082 <tt class="descclassname">nepi.execution.resource.</tt><tt class="descname">clsinit</tt><big>(</big><em>cls</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#clsinit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.clsinit" title="Permalink to this definition">¶</a></dt>
2083 <dd><p>Initializes template information (i.e. attributes and traces)
2084 on classes derived from the ResourceManager class.</p>
2085 <p>It is used as a decorator in the class declaration as follows:</p>
2086 <blockquote>
2087 <div><p>&#64;clsinit
2088 class MyResourceManager(ResourceManager):</p>
2089 <blockquote>
2090 <div>...</div></blockquote>
2091 </div></blockquote>
2092 </dd></dl>
2093
2094 <dl class="function">
2095 <dt id="nepi.execution.resource.clsinit_copy">
2096 <tt class="descclassname">nepi.execution.resource.</tt><tt class="descname">clsinit_copy</tt><big>(</big><em>cls</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#clsinit_copy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.clsinit_copy" title="Permalink to this definition">¶</a></dt>
2097 <dd><p>Initializes template information (i.e. attributes and traces)
2098 on classes derived from the ResourceManager class.
2099 It differs from the clsinit method in that it forces inheritance
2100 of attributes and traces from the parent class.</p>
2101 <p>It is used as a decorator in the class declaration as follows:</p>
2102 <blockquote>
2103 <div><p>&#64;clsinit
2104 class MyResourceManager(ResourceManager):</p>
2105 <blockquote>
2106 <div>...</div></blockquote>
2107 </div></blockquote>
2108 <p>clsinit_copy should be prefered to clsinit when creating new
2109 ResourceManager child classes.</p>
2110 </dd></dl>
2111
2112 <dl class="function">
2113 <dt id="nepi.execution.resource.failtrap">
2114 <tt class="descclassname">nepi.execution.resource.</tt><tt class="descname">failtrap</tt><big>(</big><em>func</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#failtrap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.failtrap" title="Permalink to this definition">¶</a></dt>
2115 <dd><p>Decorator function for instance methods that should set the
2116 RM state to FAILED when an error is raised. The methods that must be
2117 decorated are: discover, reserved, provision, deploy, start, stop.</p>
2118 </dd></dl>
2119
2120 <dl class="function">
2121 <dt id="nepi.execution.resource.find_types">
2122 <tt class="descclassname">nepi.execution.resource.</tt><tt class="descname">find_types</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#find_types"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.find_types" title="Permalink to this definition">¶</a></dt>
2123 <dd><p>Look into the different folders to find all the
2124 availables Resources Managers</p>
2125 </dd></dl>
2126
2127 <dl class="function">
2128 <dt id="nepi.execution.resource.populate_factory">
2129 <tt class="descclassname">nepi.execution.resource.</tt><tt class="descname">populate_factory</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/resource.html#populate_factory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.resource.populate_factory" title="Permalink to this definition">¶</a></dt>
2130 <dd><p>Find and rgister all available RMs</p>
2131 </dd></dl>
2132
2133 </div>
2134 <div class="section" id="module-nepi.execution.runner">
2135 <span id="nepi-execution-runner-module"></span><h2>nepi.execution.runner module<a class="headerlink" href="#module-nepi.execution.runner" title="Permalink to this headline">¶</a></h2>
2136 <dl class="class">
2137 <dt id="nepi.execution.runner.ExperimentRunner">
2138 <em class="property">class </em><tt class="descclassname">nepi.execution.runner.</tt><tt class="descname">ExperimentRunner</tt><a class="reference internal" href="../_modules/nepi/execution/runner.html#ExperimentRunner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.runner.ExperimentRunner" title="Permalink to this definition">¶</a></dt>
2139 <dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
2140 <p>The ExperimentRunner entity is responsible of
2141 re-running an experiment described by an ExperimentController
2142 multiple time</p>
2143 <dl class="method">
2144 <dt id="nepi.execution.runner.ExperimentRunner.evaluate_normal_convergence">
2145 <tt class="descname">evaluate_normal_convergence</tt><big>(</big><em>ec</em>, <em>run</em>, <em>metrics</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/runner.html#ExperimentRunner.evaluate_normal_convergence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.runner.ExperimentRunner.evaluate_normal_convergence" title="Permalink to this definition">¶</a></dt>
2146 <dd><p>Returns True when the confidence interval of the sample mean is
2147 less than 5% of the mean value, for a 95% confidence level,
2148 assuming normal distribution of the data</p>
2149 </dd></dl>
2150
2151 <dl class="method">
2152 <dt id="nepi.execution.runner.ExperimentRunner.run">
2153 <tt class="descname">run</tt><big>(</big><em>ec</em>, <em>min_runs=1</em>, <em>max_runs=-1</em>, <em>wait_time=0</em>, <em>wait_guids=[]</em>, <em>compute_metric_callback=None</em>, <em>evaluate_convergence_callback=None</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/runner.html#ExperimentRunner.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.runner.ExperimentRunner.run" title="Permalink to this definition">¶</a></dt>
2154 <dd><p>Run a same experiment independently multiple times, until the
2155 evaluate_convergence_callback function returns True</p>
2156 <table class="docutils field-list" frame="void" rules="none">
2157 <col class="field-name" />
2158 <col class="field-body" />
2159 <tbody valign="top">
2160 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
2161 <li><strong>ec</strong> (<em>ExperimentController</em>) &#8211; Description of experiment to replicate.
2162 The runner takes care of deploying the EC, so ec.deploy()
2163 must not be invoked directly before or after invoking
2164 runner.run().</li>
2165 <li><strong>min_runs</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Minimum number of times the experiment must be
2166 replicated</li>
2167 <li><strong>max_runs</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Maximum number of times the experiment can be
2168 replicated</li>
2169 <li><strong>wait_time</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#float" title="(in Python v2.7)"><em>float</em></a>) &#8211; Time to wait in seconds on each run between invoking
2170 ec.deploy() and ec.release().</li>
2171 <li><strong>wait_guids</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#list" title="(in Python v2.7)"><em>list</em></a>) &#8211; List of guids wait for finalization on each run.
2172 This list is passed to ec.wait_finished()</li>
2173 <li><strong>compute_metric_callback</strong> (<em>function</em>) &#8211; <p>User defined function invoked after
2174 each experiment run to compute a metric. The metric is usually
2175 a network measurement obtained from the data collected
2176 during experiment execution.
2177 The function is invoked passing the ec and the run number as arguments.
2178 It must return the value for the computed metric(s) (usually a single
2179 numerical value, but it can be several).</p>
2180 <blockquote>
2181 <div>metric = compute_metric_callback(ec, run)</div></blockquote>
2182 </li>
2183 <li><strong>evaluate_convergence_callback</strong> (<em>function</em>) &#8211; <p>User defined function invoked after
2184 computing the metric on each run, to evaluate the experiment was
2185 run enough times. It takes the list of cumulated metrics produced by
2186 the compute_metric_callback up to the current run, and decided
2187 whether the metrics have statistically converged to a meaningful value
2188 or not. It must return either True or False.</p>
2189 <blockquote>
2190 <div>stop = evaluate_convergence_callback(ec, run, metrics)</div></blockquote>
2191 <p>If stop is True, then the runner will exit.</p>
2192 </li>
2193 </ul>
2194 </td>
2195 </tr>
2196 </tbody>
2197 </table>
2198 </dd></dl>
2199
2200 <dl class="method">
2201 <dt id="nepi.execution.runner.ExperimentRunner.run_experiment">
2202 <tt class="descname">run_experiment</tt><big>(</big><em>filepath</em>, <em>wait_time</em>, <em>wait_guids</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/runner.html#ExperimentRunner.run_experiment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.runner.ExperimentRunner.run_experiment" title="Permalink to this definition">¶</a></dt>
2203 <dd><p>Run an experiment based on the description stored
2204 in filepath.</p>
2205 </dd></dl>
2206
2207 </dd></dl>
2208
2209 </div>
2210 <div class="section" id="module-nepi.execution.scheduler">
2211 <span id="nepi-execution-scheduler-module"></span><h2>nepi.execution.scheduler module<a class="headerlink" href="#module-nepi.execution.scheduler" title="Permalink to this headline">¶</a></h2>
2212 <dl class="class">
2213 <dt id="nepi.execution.scheduler.HeapScheduler">
2214 <em class="property">class </em><tt class="descclassname">nepi.execution.scheduler.</tt><tt class="descname">HeapScheduler</tt><a class="reference internal" href="../_modules/nepi/execution/scheduler.html#HeapScheduler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.scheduler.HeapScheduler" title="Permalink to this definition">¶</a></dt>
2215 <dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
2216 <p>Create a Heap Scheduler</p>
2217 <div class="admonition note">
2218 <p class="first admonition-title">Note</p>
2219 <p class="last">This class is thread safe.
2220 All calls to C Extensions are made atomic by the GIL in the CPython implementation.
2221 heapq.heappush, heapq.heappop, and list access are therefore thread-safe.</p>
2222 </div>
2223 <dl class="method">
2224 <dt id="nepi.execution.scheduler.HeapScheduler.next">
2225 <tt class="descname">next</tt><big>(</big><big>)</big><a class="reference internal" href="../_modules/nepi/execution/scheduler.html#HeapScheduler.next"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.scheduler.HeapScheduler.next" title="Permalink to this definition">¶</a></dt>
2226 <dd><p>Get the next task in the queue by timestamp and arrival order</p>
2227 </dd></dl>
2228
2229 <dl class="attribute">
2230 <dt id="nepi.execution.scheduler.HeapScheduler.pending">
2231 <tt class="descname">pending</tt><a class="reference internal" href="../_modules/nepi/execution/scheduler.html#HeapScheduler.pending"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.scheduler.HeapScheduler.pending" title="Permalink to this definition">¶</a></dt>
2232 <dd><p>Returns the list of pending task ids</p>
2233 </dd></dl>
2234
2235 <dl class="method">
2236 <dt id="nepi.execution.scheduler.HeapScheduler.remove">
2237 <tt class="descname">remove</tt><big>(</big><em>tid</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/scheduler.html#HeapScheduler.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.scheduler.HeapScheduler.remove" title="Permalink to this definition">¶</a></dt>
2238 <dd><p>Remove a task form the queue</p>
2239 <table class="docutils field-list" frame="void" rules="none">
2240 <col class="field-name" />
2241 <col class="field-body" />
2242 <tbody valign="top">
2243 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tid</strong> (<a class="reference external" href="http://docs.python.org/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) &#8211; Id of the task to be removed</td>
2244 </tr>
2245 </tbody>
2246 </table>
2247 </dd></dl>
2248
2249 <dl class="method">
2250 <dt id="nepi.execution.scheduler.HeapScheduler.schedule">
2251 <tt class="descname">schedule</tt><big>(</big><em>task</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/scheduler.html#HeapScheduler.schedule"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.scheduler.HeapScheduler.schedule" title="Permalink to this definition">¶</a></dt>
2252 <dd><p>Add a task to the queue ordered by task.timestamp and arrival order</p>
2253 <table class="docutils field-list" frame="void" rules="none">
2254 <col class="field-name" />
2255 <col class="field-body" />
2256 <tbody valign="top">
2257 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>task</strong> (<em>task</em>) &#8211; task to schedule</td>
2258 </tr>
2259 </tbody>
2260 </table>
2261 </dd></dl>
2262
2263 </dd></dl>
2264
2265 <dl class="class">
2266 <dt id="nepi.execution.scheduler.Task">
2267 <em class="property">class </em><tt class="descclassname">nepi.execution.scheduler.</tt><tt class="descname">Task</tt><big>(</big><em>timestamp</em>, <em>callback</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/scheduler.html#Task"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.scheduler.Task" title="Permalink to this definition">¶</a></dt>
2268 <dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
2269 <p>A Task represents an operation to be executed by the
2270 ExperimentController scheduler</p>
2271 </dd></dl>
2272
2273 <dl class="class">
2274 <dt id="nepi.execution.scheduler.TaskStatus">
2275 <em class="property">class </em><tt class="descclassname">nepi.execution.scheduler.</tt><tt class="descname">TaskStatus</tt><a class="reference internal" href="../_modules/nepi/execution/scheduler.html#TaskStatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.scheduler.TaskStatus" title="Permalink to this definition">¶</a></dt>
2276 <dd><p>Execution state of the Task</p>
2277 <dl class="attribute">
2278 <dt id="nepi.execution.scheduler.TaskStatus.DONE">
2279 <tt class="descname">DONE</tt><em class="property"> = 1</em><a class="headerlink" href="#nepi.execution.scheduler.TaskStatus.DONE" title="Permalink to this definition">¶</a></dt>
2280 <dd></dd></dl>
2281
2282 <dl class="attribute">
2283 <dt id="nepi.execution.scheduler.TaskStatus.ERROR">
2284 <tt class="descname">ERROR</tt><em class="property"> = 2</em><a class="headerlink" href="#nepi.execution.scheduler.TaskStatus.ERROR" title="Permalink to this definition">¶</a></dt>
2285 <dd></dd></dl>
2286
2287 <dl class="attribute">
2288 <dt id="nepi.execution.scheduler.TaskStatus.NEW">
2289 <tt class="descname">NEW</tt><em class="property"> = 0</em><a class="headerlink" href="#nepi.execution.scheduler.TaskStatus.NEW" title="Permalink to this definition">¶</a></dt>
2290 <dd></dd></dl>
2291
2292 </dd></dl>
2293
2294 </div>
2295 <div class="section" id="module-nepi.execution.tags">
2296 <span id="nepi-execution-tags-module"></span><h2>nepi.execution.tags module<a class="headerlink" href="#module-nepi.execution.tags" title="Permalink to this headline">¶</a></h2>
2297 </div>
2298 <div class="section" id="module-nepi.execution.trace">
2299 <span id="nepi-execution-trace-module"></span><h2>nepi.execution.trace module<a class="headerlink" href="#module-nepi.execution.trace" title="Permalink to this headline">¶</a></h2>
2300 <dl class="class">
2301 <dt id="nepi.execution.trace.Trace">
2302 <em class="property">class </em><tt class="descclassname">nepi.execution.trace.</tt><tt class="descname">Trace</tt><big>(</big><em>name</em>, <em>help</em>, <em>enabled=False</em><big>)</big><a class="reference internal" href="../_modules/nepi/execution/trace.html#Trace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.trace.Trace" title="Permalink to this definition">¶</a></dt>
2303 <dd><p>Bases: <a class="reference external" href="http://docs.python.org/library/functions.html#object" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></a></p>
2304 <p>A Trace represents information about a Resource that can
2305 be collected</p>
2306 <dl class="attribute">
2307 <dt id="nepi.execution.trace.Trace.help">
2308 <tt class="descname">help</tt><a class="reference internal" href="../_modules/nepi/execution/trace.html#Trace.help"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.trace.Trace.help" title="Permalink to this definition">¶</a></dt>
2309 <dd><p>Returns the help of the trace</p>
2310 </dd></dl>
2311
2312 <dl class="attribute">
2313 <dt id="nepi.execution.trace.Trace.name">
2314 <tt class="descname">name</tt><a class="reference internal" href="../_modules/nepi/execution/trace.html#Trace.name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.trace.Trace.name" title="Permalink to this definition">¶</a></dt>
2315 <dd><p>Returns the name of the trace</p>
2316 </dd></dl>
2317
2318 </dd></dl>
2319
2320 <dl class="class">
2321 <dt id="nepi.execution.trace.TraceAttr">
2322 <em class="property">class </em><tt class="descclassname">nepi.execution.trace.</tt><tt class="descname">TraceAttr</tt><a class="reference internal" href="../_modules/nepi/execution/trace.html#TraceAttr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nepi.execution.trace.TraceAttr" title="Permalink to this definition">¶</a></dt>
2323 <dd><p>A Trace attribute defines information about a Trace that can
2324 be queried</p>
2325 <dl class="attribute">
2326 <dt id="nepi.execution.trace.TraceAttr.ALL">
2327 <tt class="descname">ALL</tt><em class="property"> = 'all'</em><a class="headerlink" href="#nepi.execution.trace.TraceAttr.ALL" title="Permalink to this definition">¶</a></dt>
2328 <dd></dd></dl>
2329
2330 <dl class="attribute">
2331 <dt id="nepi.execution.trace.TraceAttr.PATH">
2332 <tt class="descname">PATH</tt><em class="property"> = 'path'</em><a class="headerlink" href="#nepi.execution.trace.TraceAttr.PATH" title="Permalink to this definition">¶</a></dt>
2333 <dd></dd></dl>
2334
2335 <dl class="attribute">
2336 <dt id="nepi.execution.trace.TraceAttr.SIZE">
2337 <tt class="descname">SIZE</tt><em class="property"> = 'size'</em><a class="headerlink" href="#nepi.execution.trace.TraceAttr.SIZE" title="Permalink to this definition">¶</a></dt>
2338 <dd></dd></dl>
2339
2340 <dl class="attribute">
2341 <dt id="nepi.execution.trace.TraceAttr.STREAM">
2342 <tt class="descname">STREAM</tt><em class="property"> = 'stream'</em><a class="headerlink" href="#nepi.execution.trace.TraceAttr.STREAM" title="Permalink to this definition">¶</a></dt>
2343 <dd></dd></dl>
2344
2345 </dd></dl>
2346
2347 </div>
2348 <div class="section" id="module-nepi.execution">
2349 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-nepi.execution" title="Permalink to this headline">¶</a></h2>
2350 </div>
2351 </div>
2352
2353
2354           </div>
2355         </div>
2356       </div>
2357       <div class="clearer"></div>
2358     </div>
2359     <div class="related">
2360       <h3>Navigation</h3>
2361       <ul>
2362         <li class="right" style="margin-right: 10px">
2363           <a href="../genindex.html" title="General Index"
2364              >index</a></li>
2365         <li class="right" >
2366           <a href="../py-modindex.html" title="Python Module Index"
2367              >modules</a> |</li>
2368         <li><a href="../index.html">NEPI 3.0 documentation</a> &raquo;</li>
2369       </ul>
2370     </div>
2371     <div class="footer">
2372         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
2373       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
2374     </div>
2375   </body>
2376 </html>