doc/sphinx/_build/html/_modules/nepi/resources/omf/messages_5_4.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.resources.omf.messages_5_4 &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     <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.0 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.resources.omf.messages_5_4</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 <span class="c">#         Julien Tribino &lt;julien.tribino@inria.fr&gt;</span>
  85
  86 <span class="kn">from</span> <span class="nn">xml.etree</span> <span class="kn">import</span> <span class="n">cElementTree</span> <span class="k">as</span> <span class="n">ET</span>
  87
  88 <div class="viewcode-block" id="MessageHandler"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.messages_5_4.MessageHandler">[docs]</a><span class="k">class</span> <span class="nc">MessageHandler</span><span class="p">():</span>
  89     <span class="sd">&quot;&quot;&quot;</span>
  90 <span class="sd">    .. class:: Class Args :</span>
  91 <span class="sd">      </span>
  92 <span class="sd">        :param sliceid: Slice Name (= Xmpp Slice)</span>
  93 <span class="sd">        :type expid: str</span>
  94 <span class="sd">        :param expid: Experiment ID (= Xmpp User)</span>
  95 <span class="sd">        :type expid: str</span>
  96
  97 <span class="sd">    .. note::</span>
  98
  99 <span class="sd">       This class is used only for OMF 5.4 Protocol and is going to become unused</span>
 100
 101 <span class="sd">    &quot;&quot;&quot;</span>
 102
 103     <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">sliceid</span><span class="p">,</span> <span class="n">expid</span> <span class="p">):</span>
 104         <span class="sd">&quot;&quot;&quot;</span>
 105
 106 <span class="sd">        :param sliceid: Slice Name (= Xmpp Slice)</span>
 107 <span class="sd">        :type expid: str</span>
 108 <span class="sd">        :param expid: Experiment ID (= Xmpp User)</span>
 109 <span class="sd">        :type expid: str</span>
 110
 111 <span class="sd">        &quot;&quot;&quot;</span>
 112         <span class="bp">self</span><span class="o">.</span><span class="n">_slice_id</span> <span class="o">=</span> <span class="n">sliceid</span>
 113         <span class="bp">self</span><span class="o">.</span><span class="n">_exp_id</span> <span class="o">=</span> <span class="n">expid</span>
 114
 115
 116     <span class="k">def</span> <span class="nf">_id_element</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="p">,</span> <span class="n">markup</span><span class="p">):</span>
 117         <span class="sd">&quot;&quot;&quot; Insert a markup element with an id</span>
 118
 119 <span class="sd">        :param parent: Parent element in an XML point of view</span>
 120 <span class="sd">        :type parent: ElementTree Element</span>
 121 <span class="sd">        :param markup: Name of the markup</span>
 122 <span class="sd">        :type markup: str</span>
 123
 124 <span class="sd">        &quot;&quot;&quot;</span>
 125         <span class="n">elt</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">SubElement</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="n">markup</span><span class="p">)</span>
 126         <span class="n">elt</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s">&quot;id&quot;</span><span class="p">,</span> <span class="s">&quot;</span><span class="se">\&#39;</span><span class="s">omf-payload</span><span class="se">\&#39;</span><span class="s">&quot;</span><span class="p">)</span>
 127         <span class="k">return</span> <span class="n">elt</span>
 128
 129     <span class="k">def</span> <span class="nf">_attr_element</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parent</span><span class="p">,</span> <span class="n">markup</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
 130         <span class="sd">&quot;&quot;&quot; Insert a markup element with a text (value)</span>
 131
 132 <span class="sd">        :param parent: Parent element in an XML point of view</span>
 133 <span class="sd">        :type parent: ElementTree Element</span>
 134 <span class="sd">        :param markup: Name of the markup</span>
 135 <span class="sd">        :type markup: str</span>
 136 <span class="sd">        :param text: Value of the markup element</span>
 137 <span class="sd">        :type text: str</span>
 138
 139 <span class="sd">        &quot;&quot;&quot;</span>
 140         <span class="n">elt</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">SubElement</span><span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="n">markup</span><span class="p">)</span>
 141         <span class="n">elt</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="n">text</span>
 142         <span class="k">return</span> <span class="n">elt</span>
 143
 144 <div class="viewcode-block" id="MessageHandler.execute_function"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.messages_5_4.MessageHandler.execute_function">[docs]</a>    <span class="k">def</span> <span class="nf">execute_function</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">target</span><span class="p">,</span> <span class="n">appid</span><span class="p">,</span> <span class="n">cmdlineargs</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">env</span><span class="p">):</span>
 145         <span class="sd">&quot;&quot;&quot; Build an Execute Message</span>
 146
 147 <span class="sd">        :param target: Hrn of the target node (ex : omf.plexus.wlab17)</span>
 148 <span class="sd">        :type target: str</span>
 149 <span class="sd">        :param appid: Application id</span>
 150 <span class="sd">        :type appid: str</span>
 151 <span class="sd">        :param cmdlineargs: Arguments of the application</span>
 152 <span class="sd">        :type cmdlineargs: str</span>
 153 <span class="sd">        :param path: Path of the application</span>
 154 <span class="sd">        :type path: str</span>
 155 <span class="sd">        :param env: Environment variables</span>
 156 <span class="sd">        :type env: str</span>
 157
 158 <span class="sd">        &quot;&quot;&quot;</span>
 159         <span class="n">payload</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">Element</span><span class="p">(</span><span class="s">&quot;omf-message&quot;</span><span class="p">)</span>
 160         <span class="n">execute</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">&quot;EXECUTE&quot;</span><span class="p">)</span>
 161         <span class="n">env</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">execute</span><span class="p">,</span> <span class="s">&quot;ENV&quot;</span><span class="p">,</span> <span class="n">env</span><span class="p">)</span>
 162         <span class="n">sliceid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">execute</span><span class="p">,</span><span class="s">&quot;SLICEID&quot;</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_slice_id</span><span class="p">)</span>
 163         <span class="n">expid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">execute</span><span class="p">,</span><span class="s">&quot;EXPID&quot;</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_exp_id</span><span class="p">)</span>
 164         <span class="n">target</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">execute</span><span class="p">,</span><span class="s">&quot;TARGET&quot;</span><span class="p">,</span><span class="n">target</span><span class="p">)</span>
 165         <span class="n">appid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">execute</span><span class="p">,</span><span class="s">&quot;APPID&quot;</span><span class="p">,</span><span class="n">appid</span><span class="p">)</span>
 166         <span class="n">cmdlineargs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">execute</span><span class="p">,</span><span class="s">&quot;CMDLINEARGS&quot;</span><span class="p">,</span><span class="n">cmdlineargs</span><span class="p">)</span>
 167         <span class="n">path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">execute</span><span class="p">,</span><span class="s">&quot;PATH&quot;</span><span class="p">,</span><span class="n">path</span><span class="p">)</span>
 168         <span class="k">return</span> <span class="n">payload</span>
 169 </div>
 170 <div class="viewcode-block" id="MessageHandler.stdin_function"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.messages_5_4.MessageHandler.stdin_function">[docs]</a>    <span class="k">def</span> <span class="nf">stdin_function</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">target</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">appid</span><span class="p">):</span>
 171         <span class="sd">&quot;&quot;&quot; Build an Execute Message</span>
 172
 173 <span class="sd">        :param value: parameter that go in the stdin</span>
 174 <span class="sd">        :type value: str</span>
 175 <span class="sd">        :param target: Hrn of the target node (ex : omf.plexus.wlab17)</span>
 176 <span class="sd">        :type target: str</span>
 177 <span class="sd">        :param appid: Application id</span>
 178 <span class="sd">        :type appid: str</span>
 179
 180 <span class="sd">        &quot;&quot;&quot;</span>
 181         <span class="n">payload</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">Element</span><span class="p">(</span><span class="s">&quot;omf-message&quot;</span><span class="p">)</span>
 182         <span class="n">stdin</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">&quot;STDIN&quot;</span><span class="p">)</span>
 183         <span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">stdin</span><span class="p">,</span><span class="s">&quot;VALUE&quot;</span><span class="p">,</span><span class="n">value</span><span class="p">)</span>
 184         <span class="n">sliceid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">stdin</span><span class="p">,</span><span class="s">&quot;SLICEID&quot;</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_slice_id</span><span class="p">)</span>
 185         <span class="n">expid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">stdin</span><span class="p">,</span><span class="s">&quot;EXPID&quot;</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_exp_id</span><span class="p">)</span>
 186         <span class="n">target</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">stdin</span><span class="p">,</span><span class="s">&quot;TARGET&quot;</span><span class="p">,</span><span class="n">target</span><span class="p">)</span>
 187         <span class="n">appid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">stdin</span><span class="p">,</span><span class="s">&quot;APPID&quot;</span><span class="p">,</span><span class="n">appid</span><span class="p">)</span>
 188         <span class="k">return</span> <span class="n">payload</span>
 189 </div>
 190 <div class="viewcode-block" id="MessageHandler.exit_function"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.messages_5_4.MessageHandler.exit_function">[docs]</a>    <span class="k">def</span> <span class="nf">exit_function</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">target</span><span class="p">,</span> <span class="n">appid</span><span class="p">):</span>
 191         <span class="sd">&quot;&quot;&quot; Build an Exit Message</span>
 192
 193 <span class="sd">        :param target: Hrn of the target node (ex : omf.plexus.wlab17)</span>
 194 <span class="sd">        :type target: str</span>
 195 <span class="sd">        :param appid: Application id (ex : vlc#1)</span>
 196 <span class="sd">        :type appid: str</span>
 197
 198 <span class="sd">        &quot;&quot;&quot;</span>
 199         <span class="n">payload</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">Element</span><span class="p">(</span><span class="s">&quot;omf-message&quot;</span><span class="p">)</span>
 200         <span class="n">execute</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">&quot;EXIT&quot;</span><span class="p">)</span>
 201         <span class="n">sliceid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">execute</span><span class="p">,</span><span class="s">&quot;SLICEID&quot;</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_slice_id</span><span class="p">)</span>
 202         <span class="n">expid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">execute</span><span class="p">,</span><span class="s">&quot;EXPID&quot;</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_exp_id</span><span class="p">)</span>
 203         <span class="n">target</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">execute</span><span class="p">,</span><span class="s">&quot;TARGET&quot;</span><span class="p">,</span><span class="n">target</span><span class="p">)</span>
 204         <span class="n">appid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">execute</span><span class="p">,</span><span class="s">&quot;APPID&quot;</span><span class="p">,</span><span class="n">appid</span><span class="p">)</span>
 205         <span class="k">return</span> <span class="n">payload</span>
 206 </div>
 207 <div class="viewcode-block" id="MessageHandler.configure_function"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.messages_5_4.MessageHandler.configure_function">[docs]</a>    <span class="k">def</span> <span class="nf">configure_function</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">target</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
 208         <span class="sd">&quot;&quot;&quot; Build a Configure Message</span>
 209
 210 <span class="sd">        :param target: Hrn of the target node (ex : omf.plexus.wlab17)</span>
 211 <span class="sd">        :type target: str</span>
 212 <span class="sd">        :param value: guid of the RM</span>
 213 <span class="sd">        :type value: int</span>
 214 <span class="sd">        :param path: Path of the element to configure (ex : net/w0/channel)</span>
 215 <span class="sd">        :type path: dict</span>
 216
 217 <span class="sd">        &quot;&quot;&quot;</span>
 218         <span class="n">payload</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">Element</span><span class="p">(</span><span class="s">&quot;omf-message&quot;</span><span class="p">)</span>
 219         <span class="n">config</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span> <span class="s">&quot;CONFIGURE&quot;</span><span class="p">)</span>
 220         <span class="n">sliceid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">config</span><span class="p">,</span><span class="s">&quot;SLICEID&quot;</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_slice_id</span><span class="p">)</span>
 221         <span class="n">expid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">config</span><span class="p">,</span><span class="s">&quot;EXPID&quot;</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_exp_id</span><span class="p">)</span>
 222         <span class="n">target</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">config</span><span class="p">,</span><span class="s">&quot;TARGET&quot;</span><span class="p">,</span><span class="n">target</span><span class="p">)</span>
 223         <span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">config</span><span class="p">,</span><span class="s">&quot;VALUE&quot;</span><span class="p">,</span><span class="n">value</span><span class="p">)</span>
 224         <span class="n">path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">config</span><span class="p">,</span><span class="s">&quot;PATH&quot;</span><span class="p">,</span><span class="n">path</span><span class="p">)</span>
 225         <span class="k">return</span> <span class="n">payload</span>
 226 </div>
 227 <div class="viewcode-block" id="MessageHandler.log_function"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.messages_5_4.MessageHandler.log_function">[docs]</a>    <span class="k">def</span> <span class="nf">log_function</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">level</span><span class="p">,</span> <span class="n">logger</span><span class="p">,</span> <span class="n">level_name</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
 228         <span class="sd">&quot;&quot;&quot; Build a Log Message</span>
 229
 230 <span class="sd">        :param level: Level of logging</span>
 231 <span class="sd">        :type level: str</span>
 232 <span class="sd">        :param logger: Element publishing the log</span>
 233 <span class="sd">        :type logger: str</span>
 234 <span class="sd">        :param level_name: Name of the level (ex : INFO)</span>
 235 <span class="sd">        :type level_name: str</span>
 236 <span class="sd">        :param data: Content to publish</span>
 237 <span class="sd">        :type data: str</span>
 238
 239 <span class="sd">        &quot;&quot;&quot;</span>
 240         <span class="n">payload</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">Element</span><span class="p">(</span><span class="s">&quot;omf-message&quot;</span><span class="p">)</span>
 241         <span class="n">log</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span> <span class="s">&quot;LOGGING&quot;</span><span class="p">)</span>
 242         <span class="n">level</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">log</span><span class="p">,</span><span class="s">&quot;LEVEL&quot;</span><span class="p">,</span><span class="n">level</span><span class="p">)</span>
 243         <span class="n">sliceid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">log</span><span class="p">,</span><span class="s">&quot;SLICEID&quot;</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_slice_id</span><span class="p">)</span>
 244         <span class="n">logger</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">log</span><span class="p">,</span><span class="s">&quot;LOGGER&quot;</span><span class="p">,</span><span class="n">logger</span><span class="p">)</span>
 245         <span class="n">expid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">log</span><span class="p">,</span><span class="s">&quot;EXPID&quot;</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_exp_id</span><span class="p">)</span>
 246         <span class="n">level_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">log</span><span class="p">,</span><span class="s">&quot;LEVEL_NAME&quot;</span><span class="p">,</span><span class="n">level_name</span><span class="p">)</span>
 247         <span class="n">data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">log</span><span class="p">,</span><span class="s">&quot;DATA&quot;</span><span class="p">,</span><span class="n">data</span><span class="p">)</span>
 248         <span class="k">return</span> <span class="n">payload</span>
 249 </div>
 250 <div class="viewcode-block" id="MessageHandler.alias_function"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.messages_5_4.MessageHandler.alias_function">[docs]</a>    <span class="k">def</span> <span class="nf">alias_function</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">target</span><span class="p">):</span>
 251         <span class="sd">&quot;&quot;&quot; Build an Alias Message</span>
 252
 253 <span class="sd">        :param name: Name of the new alias</span>
 254 <span class="sd">        :type name: str</span>
 255 <span class="sd">        :param target: Hrn of the target node (ex : omf.plexus.wlab17)</span>
 256 <span class="sd">        :type target: str</span>
 257
 258 <span class="sd">        &quot;&quot;&quot;</span>
 259         <span class="n">payload</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">Element</span><span class="p">(</span><span class="s">&quot;omf-message&quot;</span><span class="p">)</span>
 260         <span class="n">alias</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">&quot;ALIAS&quot;</span><span class="p">)</span>
 261         <span class="n">sliceid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">alias</span><span class="p">,</span><span class="s">&quot;SLICEID&quot;</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_slice_id</span><span class="p">)</span>
 262         <span class="n">expid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">alias</span><span class="p">,</span><span class="s">&quot;EXPID&quot;</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_exp_id</span><span class="p">)</span>
 263         <span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">alias</span><span class="p">,</span><span class="s">&quot;NAME&quot;</span><span class="p">,</span><span class="n">name</span><span class="p">)</span>
 264         <span class="n">target</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">alias</span><span class="p">,</span><span class="s">&quot;TARGET&quot;</span><span class="p">,</span><span class="n">target</span><span class="p">)</span>
 265         <span class="k">return</span> <span class="n">payload</span>
 266 </div>
 267 <div class="viewcode-block" id="MessageHandler.enroll_function"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.messages_5_4.MessageHandler.enroll_function">[docs]</a>    <span class="k">def</span> <span class="nf">enroll_function</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">enrollkey</span><span class="p">,</span> <span class="n">image</span><span class="p">,</span> <span class="n">index</span><span class="p">,</span> <span class="n">target</span> <span class="p">):</span>
 268         <span class="sd">&quot;&quot;&quot; Build an Enroll Message</span>
 269
 270 <span class="sd">        :param enrollkey: Type of enrollment (= 1)</span>
 271 <span class="sd">        :type enrollkey: str</span>
 272 <span class="sd">        :param image: Image (= * when all the nodes are concerned)</span>
 273 <span class="sd">        :type image: str</span>
 274 <span class="sd">        :param index: Index (= 1 in general)</span>
 275 <span class="sd">        :type index: str</span>
 276 <span class="sd">        :param target: Hrn of the target node (ex : omf.plexus.wlab17)</span>
 277 <span class="sd">        :type target: str</span>
 278
 279 <span class="sd">        &quot;&quot;&quot;</span>
 280         <span class="n">payload</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">Element</span><span class="p">(</span><span class="s">&quot;omf-message&quot;</span><span class="p">)</span>
 281         <span class="n">enroll</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">&quot;ENROLL&quot;</span><span class="p">)</span>
 282         <span class="n">enrollkey</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">enroll</span><span class="p">,</span><span class="s">&quot;ENROLLKEY&quot;</span><span class="p">,</span><span class="n">enrollkey</span><span class="p">)</span>
 283         <span class="n">sliceid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">enroll</span><span class="p">,</span><span class="s">&quot;SLICEID&quot;</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_slice_id</span><span class="p">)</span>
 284         <span class="n">image</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">enroll</span><span class="p">,</span><span class="s">&quot;IMAGE&quot;</span><span class="p">,</span><span class="n">image</span><span class="p">)</span>
 285         <span class="n">expid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">enroll</span><span class="p">,</span><span class="s">&quot;EXPID&quot;</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_exp_id</span><span class="p">)</span>
 286         <span class="n">index</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">enroll</span><span class="p">,</span><span class="s">&quot;INDEX&quot;</span><span class="p">,</span><span class="n">index</span><span class="p">)</span>
 287         <span class="n">target</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">enroll</span><span class="p">,</span><span class="s">&quot;TARGET&quot;</span><span class="p">,</span><span class="n">target</span><span class="p">)</span>
 288         <span class="k">return</span> <span class="n">payload</span>
 289 </div>
 290 <div class="viewcode-block" id="MessageHandler.noop_function"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.messages_5_4.MessageHandler.noop_function">[docs]</a>    <span class="k">def</span> <span class="nf">noop_function</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="n">target</span><span class="p">):</span>
 291         <span class="sd">&quot;&quot;&quot; Build a Noop Message</span>
 292
 293 <span class="sd">        :param target: Hrn of the target node (ex : omf.plexus.wlab17)</span>
 294 <span class="sd">        :type target: str</span>
 295
 296 <span class="sd">        &quot;&quot;&quot;</span>
 297         <span class="n">payload</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">Element</span><span class="p">(</span><span class="s">&quot;omf-message&quot;</span><span class="p">)</span>
 298         <span class="n">noop</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">&quot;NOOP&quot;</span><span class="p">)</span>
 299         <span class="n">sliceid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">noop</span><span class="p">,</span><span class="s">&quot;SLICEID&quot;</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_slice_id</span><span class="p">)</span>
 300         <span class="n">expid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">noop</span><span class="p">,</span><span class="s">&quot;EXPID&quot;</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_exp_id</span><span class="p">)</span>
 301         <span class="n">target</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">noop</span><span class="p">,</span><span class="s">&quot;TARGET&quot;</span><span class="p">,</span><span class="n">target</span><span class="p">)</span>
 302         <span class="k">return</span> <span class="n">payload</span>
 303 </div>
 304 <div class="viewcode-block" id="MessageHandler.newexp_function"><a class="viewcode-back" href="../../../../_layout/nepi.resources.omf.html#nepi.resources.omf.messages_5_4.MessageHandler.newexp_function">[docs]</a>    <span class="k">def</span> <span class="nf">newexp_function</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">experimentid</span><span class="p">,</span> <span class="n">address</span><span class="p">):</span>
 305         <span class="sd">&quot;&quot;&quot; Build a NewExp Message</span>
 306
 307 <span class="sd">        :param experimentid: Id of the new experiment</span>
 308 <span class="sd">        :type experimentid: str</span>
 309 <span class="sd">        :param address: Adress of the destination set of nodes</span>
 310 <span class="sd">        :type address: str</span>
 311
 312 <span class="sd">        &quot;&quot;&quot;</span>
 313         <span class="n">payload</span> <span class="o">=</span> <span class="n">ET</span><span class="o">.</span><span class="n">Element</span><span class="p">(</span><span class="s">&quot;omf-message&quot;</span><span class="p">)</span>
 314         <span class="n">newexp</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_id_element</span><span class="p">(</span><span class="n">payload</span><span class="p">,</span><span class="s">&quot;EXPERIMENT_NEW&quot;</span><span class="p">)</span>
 315         <span class="n">experimentid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">newexp</span><span class="p">,</span><span class="s">&quot;EXPERIMENT_ID&quot;</span><span class="p">,</span><span class="n">experimentid</span><span class="p">)</span>
 316         <span class="n">sliceid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">newexp</span><span class="p">,</span><span class="s">&quot;SLICEID&quot;</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_slice_id</span><span class="p">)</span>
 317         <span class="n">expid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">newexp</span><span class="p">,</span><span class="s">&quot;EXPID&quot;</span><span class="p">,</span><span class="bp">self</span><span class="o">.</span><span class="n">_exp_id</span><span class="p">)</span>
 318         <span class="n">address</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_attr_element</span><span class="p">(</span><span class="n">newexp</span><span class="p">,</span><span class="s">&quot;ADDRESS&quot;</span><span class="p">,</span><span class="n">address</span><span class="p">)</span>
 319         <span class="k">return</span> <span class="n">payload</span>
 320 </pre></div></div></div>
 321
 322           </div>
 323         </div>
 324       </div>
 325       <div class="clearer"></div>
 326     </div>
 327     <div class="related">
 328       <h3>Navigation</h3>
 329       <ul>
 330         <li class="right" style="margin-right: 10px">
 331           <a href="../../../../genindex.html" title="General Index"
 332              >index</a></li>
 333         <li class="right" >
 334           <a href="../../../../py-modindex.html" title="Python Module Index"
 335              >modules</a> |</li>
 336         <li><a href="../../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
 337           <li><a href="../../../index.html" >Module code</a> &raquo;</li>
 338       </ul>
 339     </div>
 340     <div class="footer">
 341         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 342       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 343     </div>
 344   </body>
 345 </html>