aboutsummaryrefslogtreecommitdiff
path: root/html/SmootLight.behaviors.ModifyParam-pysrc.html
diff options
context:
space:
mode:
Diffstat (limited to 'html/SmootLight.behaviors.ModifyParam-pysrc.html')
-rw-r--r--html/SmootLight.behaviors.ModifyParam-pysrc.html149
1 files changed, 149 insertions, 0 deletions
diff --git a/html/SmootLight.behaviors.ModifyParam-pysrc.html b/html/SmootLight.behaviors.ModifyParam-pysrc.html
new file mode 100644
index 0000000..30cdc88
--- /dev/null
+++ b/html/SmootLight.behaviors.ModifyParam-pysrc.html
@@ -0,0 +1,149 @@
+<?xml version="1.0" encoding="ascii"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>SmootLight.behaviors.ModifyParam</title>
+ <link rel="stylesheet" href="epydoc.css" type="text/css" />
+ <script type="text/javascript" src="epydoc.js"></script>
+</head>
+
+<body bgcolor="white" text="black" link="blue" vlink="#204080"
+ alink="#204080">
+<!-- ==================== NAVIGATION BAR ==================== -->
+<table class="navbar" border="0" width="100%" cellpadding="0"
+ bgcolor="#a0c0ff" cellspacing="0">
+ <tr valign="middle">
+ <!-- Home link -->
+ <th>&nbsp;&nbsp;&nbsp;<a
+ href="SmootLight-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
+
+ <!-- Tree link -->
+ <th>&nbsp;&nbsp;&nbsp;<a
+ href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
+
+ <!-- Index link -->
+ <th>&nbsp;&nbsp;&nbsp;<a
+ href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
+
+ <!-- Help link -->
+ <th>&nbsp;&nbsp;&nbsp;<a
+ href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
+
+ <th class="navbar" width="100%"></th>
+ </tr>
+</table>
+<table width="100%" cellpadding="0" cellspacing="0">
+ <tr valign="top">
+ <td width="100%">
+ <span class="breadcrumbs">
+ <a href="SmootLight-module.html">Package&nbsp;SmootLight</a> ::
+ <a href="SmootLight.behaviors-module.html">Package&nbsp;behaviors</a> ::
+ Module&nbsp;ModifyParam
+ </span>
+ </td>
+ <td>
+ <table cellpadding="0" cellspacing="0">
+ <!-- hide/show private -->
+ <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
+ onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
+ <tr><td align="right"><span class="options"
+ >[<a href="frames.html" target="_top">frames</a
+ >]&nbsp;|&nbsp;<a href="SmootLight.behaviors.ModifyParam-pysrc.html"
+ target="_top">no&nbsp;frames</a>]</span></td></tr>
+ </table>
+ </td>
+ </tr>
+</table>
+<h1 class="epydoc">Source Code for <a href="SmootLight.behaviors.ModifyParam-module.html">Module SmootLight.behaviors.ModifyParam</a></h1>
+<pre class="py-src">
+<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Package SmootLight.operationscore=SmootLight.operationscore-module.html"><a title="SmootLight.operationscore" class="py-name" href="#" onclick="return doclink('link-0', 'operationscore', 'link-0');">operationscore</a></tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Module SmootLight.operationscore.Behavior=SmootLight.operationscore.Behavior-module.html,Class SmootLight.operationscore.Behavior.Behavior=SmootLight.operationscore.Behavior.Behavior-class.html"><a title="SmootLight.operationscore.Behavior
+SmootLight.operationscore.Behavior.Behavior" class="py-name" href="#" onclick="return doclink('link-1', 'Behavior', 'link-1');">Behavior</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
+<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">math</tt> </tt>
+<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment">#Class to perform a given operation on some element of an argDict. Designed to be used a recursive hook, but can serve sensor-based functions as well. Specify ParamType (Sensor or Recurse), ParamName, and ParamOp, (a valid python statement with the old value represented as {val})</tt> </tt>
+<a name="ModifyParam"></a><div id="ModifyParam-def"><a name="L4"></a><tt class="py-lineno"> 4</tt> <a class="py-toggle" href="#" id="ModifyParam-toggle" onclick="return toggle('ModifyParam');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="SmootLight.behaviors.ModifyParam.ModifyParam-class.html">ModifyParam</a><tt class="py-op">(</tt><tt class="py-base-class">Behavior</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="ModifyParam-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="ModifyParam-expanded"><a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"> <tt class="py-docstring">"""ModifyParam is a powerful class to perform an action on a specified key in the Argument</tt> </tt>
+<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-docstring"> Dictionary of a response. Specify:</tt> </tt>
+<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-docstring"> &lt;ParamType&gt; -- Sensor or Recurse</tt> </tt>
+<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-docstring"> &lt;ParamName&gt; -- The name of the parameter you wish to modify</tt> </tt>
+<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-docstring"> &lt;ParamOp&gt; -- The modification you wish to do. Use {val} to specify the current value of the</tt> </tt>
+<a name="L10"></a><tt class="py-lineno">10</tt> <tt class="py-line"><tt class="py-docstring"> parameter in question. Special hooks for {x} and {y} also exist to access the x and y</tt> </tt>
+<a name="L11"></a><tt class="py-lineno">11</tt> <tt class="py-line"><tt class="py-docstring"> locations."""</tt> </tt>
+<a name="L12"></a><tt class="py-lineno">12</tt> <tt class="py-line"> </tt>
+<a name="ModifyParam.processResponse"></a><div id="ModifyParam.processResponse-def"><a name="L13"></a><tt class="py-lineno">13</tt> <a class="py-toggle" href="#" id="ModifyParam.processResponse-toggle" onclick="return toggle('ModifyParam.processResponse');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="SmootLight.behaviors.ModifyParam.ModifyParam-class.html#processResponse">processResponse</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">sensorInputs</tt><tt class="py-op">,</tt> <tt class="py-param">recursiveInputs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
+</div><div id="ModifyParam.processResponse-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="ModifyParam.processResponse-expanded"><a name="L14"></a><tt class="py-lineno">14</tt> <tt class="py-line"> <tt class="py-name">paramType</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-string">'ParamType'</tt><tt class="py-op">]</tt> </tt>
+<a name="L15"></a><tt class="py-lineno">15</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">paramType</tt> <tt class="py-op">==</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
+<a name="L16"></a><tt class="py-lineno">16</tt> <tt class="py-line"> <tt class="py-name">paramType</tt> <tt class="py-op">=</tt> <tt class="py-string">'Sensor'</tt> </tt>
+<a name="L17"></a><tt class="py-lineno">17</tt> <tt class="py-line"> <tt class="py-name">paramName</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-string">'ParamName'</tt><tt class="py-op">]</tt> </tt>
+<a name="L18"></a><tt class="py-lineno">18</tt> <tt class="py-line"> <tt class="py-name">paramOp</tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-string">'ParamOp'</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
+<a name="L19"></a><tt class="py-lineno">19</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">paramType</tt> <tt class="py-op">==</tt> <tt class="py-string">'Sensor'</tt><tt class="py-op">:</tt> </tt>
+<a name="L20"></a><tt class="py-lineno">20</tt> <tt class="py-line"> <tt class="py-name">searchSet</tt> <tt class="py-op">=</tt> <tt class="py-name">sensorInputs</tt> </tt>
+<a name="L21"></a><tt class="py-lineno">21</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">paramType</tt> <tt class="py-op">==</tt> <tt class="py-string">'Recurse'</tt><tt class="py-op">:</tt> </tt>
+<a name="L22"></a><tt class="py-lineno">22</tt> <tt class="py-line"> <tt class="py-name">searchSet</tt> <tt class="py-op">=</tt> <tt class="py-name">recursiveInputs</tt> </tt>
+<a name="L23"></a><tt class="py-lineno">23</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
+<a name="L24"></a><tt class="py-lineno">24</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">Exception</tt><tt class="py-op">(</tt><tt class="py-string">'Unknown Param Type'</tt><tt class="py-op">)</tt> </tt>
+<a name="L25"></a><tt class="py-lineno">25</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">behaviorInput</tt> <tt class="py-keyword">in</tt> <tt class="py-name">searchSet</tt><tt class="py-op">:</tt> </tt>
+<a name="L26"></a><tt class="py-lineno">26</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">paramName</tt> <tt class="py-keyword">in</tt> <tt class="py-name">behaviorInput</tt><tt class="py-op">:</tt> <tt class="py-comment">#TODO: copy -&gt; modify instead of just</tt> </tt>
+<a name="L27"></a><tt class="py-lineno">27</tt> <tt class="py-line"> <tt class="py-comment">#copying</tt> </tt>
+<a name="L28"></a><tt class="py-lineno">28</tt> <tt class="py-line"> <tt class="py-name">paramOp</tt> <tt class="py-op">=</tt> <tt class="py-name">paramOp</tt><tt class="py-op">.</tt><tt class="py-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">'{val}'</tt><tt class="py-op">,</tt> <tt class="py-string">'behaviorInput[paramName]'</tt><tt class="py-op">)</tt> <tt class="py-comment">#convert the {val} marker to something we can execute</tt> </tt>
+<a name="L29"></a><tt class="py-lineno">29</tt> <tt class="py-line"> <tt class="py-comment">#TODO: move elsewhere</tt> </tt>
+<a name="L30"></a><tt class="py-lineno">30</tt> <tt class="py-line"> <tt class="py-name">paramOp</tt> <tt class="py-op">=</tt> <tt class="py-name">paramOp</tt><tt class="py-op">.</tt><tt class="py-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">'{y}'</tt><tt class="py-op">,</tt> <tt class="py-string">"behaviorInput['Location'][1]"</tt><tt class="py-op">)</tt> </tt>
+<a name="L31"></a><tt class="py-lineno">31</tt> <tt class="py-line"> <tt class="py-name">paramOp</tt> <tt class="py-op">=</tt> <tt class="py-name">paramOp</tt><tt class="py-op">.</tt><tt class="py-name">replace</tt><tt class="py-op">(</tt><tt class="py-string">'{x}'</tt><tt class="py-op">,</tt> <tt class="py-string">"behaviorInput['Location'][0]"</tt><tt class="py-op">)</tt> </tt>
+<a name="L32"></a><tt class="py-lineno">32</tt> <tt class="py-line"> <tt class="py-name">behaviorInput</tt><tt class="py-op">[</tt><tt class="py-name">paramName</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">eval</tt><tt class="py-op">(</tt><tt class="py-name">paramOp</tt><tt class="py-op">)</tt> </tt>
+<a name="L33"></a><tt class="py-lineno">33</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">paramType</tt> <tt class="py-op">==</tt> <tt class="py-string">'Sensor'</tt><tt class="py-op">:</tt> <tt class="py-comment">#return accordingly</tt> </tt>
+<a name="L34"></a><tt class="py-lineno">34</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">searchSet</tt><tt class="py-op">,</tt> <tt class="py-name">recursiveInputs</tt><tt class="py-op">)</tt> </tt>
+<a name="L35"></a><tt class="py-lineno">35</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">paramType</tt> <tt class="py-op">==</tt> <tt class="py-string">'Recurse'</tt><tt class="py-op">:</tt> </tt>
+<a name="L36"></a><tt class="py-lineno">36</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">sensorInputs</tt><tt class="py-op">,</tt> <tt class="py-name">searchSet</tt><tt class="py-op">)</tt> </tt>
+</div></div><a name="L37"></a><tt class="py-lineno">37</tt> <tt class="py-line"> </tt><script type="text/javascript">
+<!--
+expandto(location.href);
+// -->
+</script>
+</pre>
+<br />
+<!-- ==================== NAVIGATION BAR ==================== -->
+<table class="navbar" border="0" width="100%" cellpadding="0"
+ bgcolor="#a0c0ff" cellspacing="0">
+ <tr valign="middle">
+ <!-- Home link -->
+ <th>&nbsp;&nbsp;&nbsp;<a
+ href="SmootLight-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
+
+ <!-- Tree link -->
+ <th>&nbsp;&nbsp;&nbsp;<a
+ href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
+
+ <!-- Index link -->
+ <th>&nbsp;&nbsp;&nbsp;<a
+ href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
+
+ <!-- Help link -->
+ <th>&nbsp;&nbsp;&nbsp;<a
+ href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
+
+ <th class="navbar" width="100%"></th>
+ </tr>
+</table>
+<table border="0" cellpadding="0" cellspacing="0" width="100%%">
+ <tr>
+ <td align="left" class="footer">
+ Generated by Epydoc 3.0.1 on Fri Feb 18 16:55:27 2011
+ </td>
+ <td align="right" class="footer">
+ <a target="mainFrame" href="http://epydoc.sourceforge.net"
+ >http://epydoc.sourceforge.net</a>
+ </td>
+ </tr>
+</table>
+
+<script type="text/javascript">
+ <!--
+ // Private objects are initially displayed (because if
+ // javascript is turned off then we want them to be
+ // visible); but by default, we want to hide them. So hide
+ // them unless we have a cookie that says to show them.
+ checkCookie();
+ // -->
+</script>
+</body>
+</html>