doc/sphinx/_build/html/_modules/nepi/execution/trace.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.trace &mdash; NEPI 3.2 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.2',
  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.2 documentation" href="../../../index.html" />
  27     <link rel="up" title="Module code" href="../../index.html" />
  28   </head>
  29   <body>
  30     <div class="related">
  31       <h3>Navigation</h3>
  32       <ul>
  33         <li class="right" style="margin-right: 10px">
  34           <a href="../../../genindex.html" title="General Index"
  35              accesskey="I">index</a></li>
  36         <li class="right" >
  37           <a href="../../../py-modindex.html" title="Python Module Index"
  38              >modules</a> |</li>
  39         <li><a href="../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
  40           <li><a href="../../index.html" accesskey="U">Module code</a> &raquo;</li>
  41       </ul>
  42     </div>
  43       <div class="sphinxsidebar">
  44         <div class="sphinxsidebarwrapper">
  45 <div id="searchbox" style="display: none">
  46   <h3>Quick search</h3>
  47     <form class="search" action="../../../search.html" method="get">
  48       <input type="text" name="q" />
  49       <input type="submit" value="Go" />
  50       <input type="hidden" name="check_keywords" value="yes" />
  51       <input type="hidden" name="area" value="default" />
  52     </form>
  53     <p class="searchtip" style="font-size: 90%">
  54     Enter search terms or a module, class or function name.
  55     </p>
  56 </div>
  57 <script type="text/javascript">$('#searchbox').show(0);</script>
  58         </div>
  59       </div>
  60
  61     <div class="document">
  62       <div class="documentwrapper">
  63         <div class="bodywrapper">
  64           <div class="body">
  65
  66   <h1>Source code for nepi.execution.trace</h1><div class="highlight"><pre>
  67 <span class="c">#</span>
  68 <span class="c">#    NEPI, a framework to manage network experiments</span>
  69 <span class="c">#    Copyright (C) 2013 INRIA</span>
  70 <span class="c">#</span>
  71 <span class="c">#    This program is free software: you can redistribute it and/or modify</span>
  72 <span class="c">#    it under the terms of the GNU General Public License version 2 as</span>
  73 <span class="c">#    published by the Free Software Foundation;</span>
  74 <span class="c">#</span>
  75 <span class="c">#    This program is distributed in the hope that it will be useful,</span>
  76 <span class="c">#    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  77 <span class="c">#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
  78 <span class="c">#    GNU General Public License for more details.</span>
  79 <span class="c">#</span>
  80 <span class="c">#    You should have received a copy of the GNU General Public License</span>
  81 <span class="c">#    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
  82 <span class="c">#</span>
  83 <span class="c"># Author: Alina Quereilhac &lt;alina.quereilhac@inria.fr&gt;</span>
  84
  85 <div class="viewcode-block" id="TraceAttr"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.trace.TraceAttr">[docs]</a><span class="k">class</span> <span class="nc">TraceAttr</span><span class="p">:</span>
  86     <span class="sd">&quot;&quot;&quot;A Trace attribute defines information about a Trace that can</span>
  87 <span class="sd">    be queried</span>
  88 <span class="sd">    &quot;&quot;&quot;</span>
  89     <span class="n">ALL</span> <span class="o">=</span> <span class="s">&quot;all&quot;</span>
  90     <span class="n">STREAM</span> <span class="o">=</span> <span class="s">&quot;stream&quot;</span>
  91     <span class="n">PATH</span> <span class="o">=</span> <span class="s">&quot;path&quot;</span>
  92     <span class="n">SIZE</span> <span class="o">=</span> <span class="s">&quot;size&quot;</span>
  93 </div>
  94 <div class="viewcode-block" id="Trace"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.trace.Trace">[docs]</a><span class="k">class</span> <span class="nc">Trace</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  95     <span class="sd">&quot;&quot;&quot; A Trace represents information about a Resource that can </span>
  96 <span class="sd">    be collected </span>
  97 <span class="sd">    &quot;&quot;&quot;</span>
  98
  99     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">help</span><span class="p">,</span> <span class="n">enabled</span> <span class="o">=</span> <span class="bp">False</span><span class="p">):</span>
 100         <span class="sd">&quot;&quot;&quot;</span>
 101 <span class="sd">        :param name: Name of the Trace</span>
 102 <span class="sd">        :type name: str</span>
 103
 104 <span class="sd">        :param help: Description of the Trace</span>
 105 <span class="sd">        :type help: str</span>
 106 <span class="sd">        </span>
 107 <span class="sd">        :param enabled: Sets activation state of Trace</span>
 108 <span class="sd">        :type enabled: bool</span>
 109 <span class="sd">        &quot;&quot;&quot;</span>
 110         <span class="bp">self</span><span class="o">.</span><span class="n">_name</span> <span class="o">=</span> <span class="n">name</span>
 111         <span class="bp">self</span><span class="o">.</span><span class="n">_help</span> <span class="o">=</span> <span class="n">help</span>
 112         <span class="bp">self</span><span class="o">.</span><span class="n">enabled</span> <span class="o">=</span> <span class="n">enabled</span>
 113
 114     <span class="nd">@property</span>
 115 <div class="viewcode-block" id="Trace.name"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.trace.Trace.name">[docs]</a>    <span class="k">def</span> <span class="nf">name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 116         <span class="sd">&quot;&quot;&quot; Returns the name of the trace &quot;&quot;&quot;</span>
 117         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_name</span>
 118 </div>
 119     <span class="nd">@property</span>
 120 <div class="viewcode-block" id="Trace.help"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.trace.Trace.help">[docs]</a>    <span class="k">def</span> <span class="nf">help</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 121         <span class="sd">&quot;&quot;&quot; Returns the help of the trace &quot;&quot;&quot;</span>
 122         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_help</span>
 123 </pre></div></div></div>
 124
 125           </div>
 126         </div>
 127       </div>
 128       <div class="clearer"></div>
 129     </div>
 130     <div class="related">
 131       <h3>Navigation</h3>
 132       <ul>
 133         <li class="right" style="margin-right: 10px">
 134           <a href="../../../genindex.html" title="General Index"
 135              >index</a></li>
 136         <li class="right" >
 137           <a href="../../../py-modindex.html" title="Python Module Index"
 138              >modules</a> |</li>
 139         <li><a href="../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
 140           <li><a href="../../index.html" >Module code</a> &raquo;</li>
 141       </ul>
 142     </div>
 143     <div class="footer">
 144         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 145       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 146     </div>
 147   </body>
 148 </html>