--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>nepi.execution.attribute — NEPI 3.0 documentation</title>
+
+ <link rel="stylesheet" href="../../../_static/sphinxdoc.css" type="text/css" />
+ <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../',
+ VERSION: '3.0',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../../_static/doctools.js"></script>
+ <link rel="top" title="NEPI 3.0 documentation" href="../../../index.html" />
+ <link rel="up" title="Module code" href="../../index.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../index.html">NEPI 3.0 documentation</a> »</li>
+ <li><a href="../../index.html" accesskey="U">Module code</a> »</li>
+ </ul>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <h1>Source code for nepi.execution.attribute</h1><div class="highlight"><pre>
+<span class="c">#</span>
+<span class="c"># NEPI, a framework to manage network experiments</span>
+<span class="c"># Copyright (C) 2013 INRIA</span>
+<span class="c">#</span>
+<span class="c"># This program is free software: you can redistribute it and/or modify</span>
+<span class="c"># it under the terms of the GNU General Public License version 2 as</span>
+<span class="c"># published by the Free Software Foundation;</span>
+<span class="c">#</span>
+<span class="c"># This program is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
+<span class="c"># GNU General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU General Public License</span>
+<span class="c"># along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
+<span class="c">#</span>
+<span class="c"># Author: Alina Quereilhac <alina.quereilhac@inria.fr></span>
+
+<span class="c">### Attribute Types</span>
+<div class="viewcode-block" id="Types"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.attribute.Types">[docs]</a><span class="k">class</span> <span class="nc">Types</span><span class="p">:</span>
+ <span class="sd">""" Allowed types for the Attribute value</span>
+<span class="sd"> """</span>
+ <span class="n">String</span> <span class="o">=</span> <span class="s">"STRING"</span>
+ <span class="n">Bool</span> <span class="o">=</span> <span class="s">"BOOL"</span>
+ <span class="n">Enumerate</span> <span class="o">=</span> <span class="s">"ENUM"</span>
+ <span class="n">Double</span> <span class="o">=</span> <span class="s">"DOUBLE"</span>
+ <span class="n">Integer</span> <span class="o">=</span> <span class="s">"INTEGER"</span>
+
+<span class="c">### Attribute Flags</span></div>
+<div class="viewcode-block" id="Flags"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.attribute.Flags">[docs]</a><span class="k">class</span> <span class="nc">Flags</span><span class="p">:</span>
+ <span class="sd">""" Flags to characterize the scope of an Attribute</span>
+<span class="sd"> """</span>
+ <span class="c"># Attribute value can not be read (it is hidden to the user) </span>
+ <span class="n">NoRead</span> <span class="o">=</span> <span class="mi">1</span> <span class="c"># 1</span>
+
+ <span class="c"># Attribute value can not be modified (it is not editable by the user)</span>
+ <span class="n">NoWrite</span> <span class="o">=</span> <span class="mi">1</span> <span class="o"><<</span> <span class="mi">1</span> <span class="c"># 2</span>
+
+ <span class="c"># Attribute value can be modified only before deployment</span>
+ <span class="n">Design</span> <span class="o">=</span> <span class="mi">1</span> <span class="o"><<</span> <span class="mi">2</span> <span class="c"># 4</span>
+
+ <span class="c"># Attribute value will be used at deployment time for initial configuration</span>
+ <span class="n">Construct</span> <span class="o">=</span> <span class="mi">1</span> <span class="o"><<</span> <span class="mi">3</span> <span class="c"># 8</span>
+
+ <span class="c"># Attribute provides credentials to access resources</span>
+ <span class="n">Credential</span> <span class="o">=</span> <span class="mi">1</span> <span class="o"><<</span> <span class="mi">4</span> <span class="o">|</span> <span class="n">Design</span> <span class="c"># 16 + 4</span>
+
+ <span class="c"># Attribute is a filter used to discover resources</span>
+ <span class="n">Filter</span> <span class="o">=</span> <span class="mi">1</span> <span class="o"><<</span> <span class="mi">5</span> <span class="o">|</span> <span class="n">Design</span> <span class="c"># 32 + 4</span>
+
+ <span class="c"># Attribute Flag is reserved for internal RM usage (i.e. should be </span>
+ <span class="c"># transparent to the user)</span>
+ <span class="n">Reserved</span> <span class="o">=</span> <span class="mi">1</span> <span class="o"><<</span> <span class="mi">6</span> <span class="c"># 64</span>
+
+ <span class="c"># Attribute global is set to all resources of rtype</span>
+ <span class="n">Global</span> <span class="o">=</span> <span class="mi">1</span> <span class="o"><<</span> <span class="mi">7</span> <span class="c"># 128</span>
+
+</div>
+<div class="viewcode-block" id="Attribute"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.attribute.Attribute">[docs]</a><span class="k">class</span> <span class="nc">Attribute</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+ <span class="sd">""" An Attribute exposes a configuration parameter of a resource</span>
+<span class="sd"> """</span>
+
+ <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="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">String</span><span class="p">,</span>
+ <span class="n">flags</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">default</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">set_hook</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> :param name: Name of the Attribute</span>
+<span class="sd"> :type name: str</span>
+
+<span class="sd"> :param help: Description of the Attribute</span>
+<span class="sd"> :type help: str</span>
+<span class="sd"> </span>
+<span class="sd"> :param type: The type expected for the Attribute value.</span>
+<span class="sd"> Should be one of Attribute.Types</span>
+<span class="sd"> :type type: str</span>
+
+<span class="sd"> :param flags: Defines Attribute behavior (i.e. whether it is read-only,</span>
+<span class="sd"> read and write, etc). This parameter must take its values from</span>
+<span class="sd"> Attribute.Flags. Flags values can be bitwised</span>
+<span class="sd"> :type flags: hex</span>
+
+<span class="sd"> :param default: Default value for the Attribute</span>
+<span class="sd"> :type default: Depends on the type of Attribute</span>
+<span class="sd"> </span>
+<span class="sd"> :param allowed: List of values that the Attribute can take. </span>
+<span class="sd"> This parameter is only meaningful for Enumerate type Attributes</span>
+<span class="sd"> :type allowed: list</span>
+<span class="sd"> </span>
+<span class="sd"> :param range: (max, min) tuple with range of possible values for</span>
+<span class="sd"> Attributes.</span>
+<span class="sd"> This parameter is only meaningful for Integer or Double type</span>
+<span class="sd"> Attributes</span>
+<span class="sd"> :type range: (int, int) or (float, float)</span>
+<span class="sd"> </span>
+<span class="sd"> :param set_hook: Function that will be executed whenever a new </span>
+<span class="sd"> value is set for the Attribute.</span>
+<span class="sd"> :type set_hook: function</span>
+
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_name</span> <span class="o">=</span> <span class="n">name</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_help</span> <span class="o">=</span> <span class="n">help</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_type</span> <span class="o">=</span> <span class="nb">type</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_flags</span> <span class="o">=</span> <span class="n">flags</span> <span class="ow">or</span> <span class="mi">0</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_allowed</span> <span class="o">=</span> <span class="n">allowed</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_range</span> <span class="o">=</span> <span class="nb">range</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_default</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="n">default</span>
+ <span class="c"># callback to be invoked upon changing the </span>
+ <span class="c"># attribute value</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_hook</span> <span class="o">=</span> <span class="n">set_hook</span>
+
+ <span class="nd">@property</span>
+<div class="viewcode-block" id="Attribute.name"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.attribute.Attribute.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>
+ <span class="sd">""" Returns the name of the Attribute """</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_name</span>
+</div>
+ <span class="nd">@property</span>
+<div class="viewcode-block" id="Attribute.default"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.attribute.Attribute.default">[docs]</a> <span class="k">def</span> <span class="nf">default</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">""" Returns the default value of the Attribute """</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_default</span>
+</div>
+ <span class="nd">@property</span>
+<div class="viewcode-block" id="Attribute.type"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.attribute.Attribute.type">[docs]</a> <span class="k">def</span> <span class="nf">type</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">""" Returns the type of the Attribute """</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_type</span>
+</div>
+ <span class="nd">@property</span>
+<div class="viewcode-block" id="Attribute.help"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.attribute.Attribute.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>
+ <span class="sd">""" Returns the description of the Attribute """</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_help</span>
+</div>
+ <span class="nd">@property</span>
+<div class="viewcode-block" id="Attribute.flags"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.attribute.Attribute.flags">[docs]</a> <span class="k">def</span> <span class="nf">flags</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">""" Returns the flags of the Attribute """</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_flags</span>
+</div>
+ <span class="nd">@property</span>
+<div class="viewcode-block" id="Attribute.allowed"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.attribute.Attribute.allowed">[docs]</a> <span class="k">def</span> <span class="nf">allowed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">""" Returns the set of allowed values for the Attribute """</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_allowed</span>
+</div>
+ <span class="nd">@property</span>
+<div class="viewcode-block" id="Attribute.range"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.attribute.Attribute.range">[docs]</a> <span class="k">def</span> <span class="nf">range</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">""" Returns the range of allowed numerical values for the Attribute """</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_range</span>
+</div>
+<div class="viewcode-block" id="Attribute.has_flag"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.attribute.Attribute.has_flag">[docs]</a> <span class="k">def</span> <span class="nf">has_flag</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">flag</span><span class="p">):</span>
+ <span class="sd">""" Returns True if the Attribute has the flag 'flag'</span>
+
+<span class="sd"> :param flag: Flag to be checked</span>
+<span class="sd"> :type flag: Flags</span>
+<span class="sd"> """</span>
+ <span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_flags</span> <span class="o">&</span> <span class="n">flag</span><span class="p">)</span> <span class="o">==</span> <span class="n">flag</span>
+</div>
+<div class="viewcode-block" id="Attribute.get_value"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.attribute.Attribute.get_value">[docs]</a> <span class="k">def</span> <span class="nf">get_value</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">""" Returns the value of the Attribute """</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span>
+</div>
+<div class="viewcode-block" id="Attribute.set_value"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.attribute.Attribute.set_value">[docs]</a> <span class="k">def</span> <span class="nf">set_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="sd">""" Configure a new value for the Attribute """</span>
+ <span class="n">valid</span> <span class="o">=</span> <span class="bp">True</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">type</span> <span class="o">==</span> <span class="n">Types</span><span class="o">.</span><span class="n">Enumerate</span><span class="p">:</span>
+ <span class="n">valid</span> <span class="o">=</span> <span class="n">value</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_allowed</span>
+
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">type</span> <span class="ow">in</span> <span class="p">[</span><span class="n">Types</span><span class="o">.</span><span class="n">Double</span><span class="p">,</span> <span class="n">Types</span><span class="o">.</span><span class="n">Integer</span><span class="p">]</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">range</span><span class="p">:</span>
+ <span class="p">(</span><span class="nb">min</span><span class="p">,</span> <span class="nb">max</span><span class="p">)</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">range</span>
+
+ <span class="n">value</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
+
+ <span class="n">valid</span> <span class="o">=</span> <span class="p">(</span><span class="n">value</span> <span class="o">>=</span> <span class="nb">min</span> <span class="ow">and</span> <span class="n">value</span> <span class="o"><=</span> <span class="nb">max</span><span class="p">)</span>
+
+ <span class="n">valid</span> <span class="o">=</span> <span class="n">valid</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_valid_value</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">valid</span><span class="p">:</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">set_hook</span><span class="p">:</span>
+ <span class="c"># Hook receives old value, new value</span>
+ <span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">set_hook</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="n">value</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Invalid value </span><span class="si">%s</span><span class="s"> for attribute </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span>
+ <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">),</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>
+</div>
+ <span class="n">value</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_value</span><span class="p">,</span> <span class="n">set_value</span><span class="p">)</span>
+
+<div class="viewcode-block" id="Attribute.is_valid_value"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.attribute.Attribute.is_valid_value">[docs]</a> <span class="k">def</span> <span class="nf">is_valid_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+ <span class="sd">""" Attribute subclasses will override this method to add </span>
+<span class="sd"> adequate validation"""</span>
+ <span class="k">return</span> <span class="bp">True</span>
+</div>
+ <span class="nd">@property</span>
+<div class="viewcode-block" id="Attribute.has_changed"><a class="viewcode-back" href="../../../_layout/nepi.execution.html#nepi.execution.attribute.Attribute.has_changed">[docs]</a> <span class="k">def</span> <span class="nf">has_changed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">""" Returns True if the value has changed from the default """</span>
+ <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">default</span>
+</pre></div></div></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../index.html">NEPI 3.0 documentation</a> »</li>
+ <li><a href="../../index.html" >Module code</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
+ </div>
+ </body>
+</html>
\ No newline at end of file
git://git.onelab.eu / nepi.git / blobdiff