diff options
Diffstat (limited to 'html/SmootLight.operationscore.Behavior.Behavior-class.html')
-rw-r--r-- | html/SmootLight.operationscore.Behavior.Behavior-class.html | 492 |
1 files changed, 492 insertions, 0 deletions
diff --git a/html/SmootLight.operationscore.Behavior.Behavior-class.html b/html/SmootLight.operationscore.Behavior.Behavior-class.html new file mode 100644 index 0000000..d020214 --- /dev/null +++ b/html/SmootLight.operationscore.Behavior.Behavior-class.html @@ -0,0 +1,492 @@ +<?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.operationscore.Behavior.Behavior</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> <a + href="SmootLight-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th> <a + href="help.html">Help</a> </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 SmootLight</a> :: + <a href="SmootLight.operationscore-module.html">Package operationscore</a> :: + <a href="SmootLight.operationscore.Behavior-module.html">Module Behavior</a> :: + Class Behavior + </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 private</a>]</span></td></tr> + <tr><td align="right"><span class="options" + >[<a href="frames.html" target="_top">frames</a + >] | <a href="SmootLight.operationscore.Behavior.Behavior-class.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== CLASS DESCRIPTION ==================== --> +<h1 class="epydoc">Class Behavior</h1><p class="nomargin-top"><span class="codelink"><a href="SmootLight.operationscore.Behavior-pysrc.html#Behavior">source code</a></span></p> +<pre class="base-tree"> + object --+ + | +operationscore.SmootCoreObject.SmootCoreObject --+ + | + <strong class="uidshort">Behavior</strong> +</pre> + +<hr /> +<p>Abstract class for a behavior. On every time step, the behavior is + passed the inputs from all sensors it is bound to as well as any + recursive inputs that it spawned during the last time step. Inheriting + classes MUST define processResponse. processResponse should return a + list of dictionaries which define the properties of the light response, + (outputs, recursions). They must give a location and color. They may + define a PixelEvent to more closely control the outgoing data, however, + this is normally handled by routing the event to a behavior specifically + designed to do this (like AddPixelEvent). timeStep is called on every + iteration of the LightInstallation addInput is called on each individual + input received, and the inputs queue</p> + +<!-- ==================== INSTANCE METHODS ==================== --> +<a name="section-InstanceMethods"></a> +<table class="summary" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Instance Methods</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-InstanceMethods" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="SmootLight.operationscore.Behavior.Behavior-class.html#init" class="summary-sig-name">init</a>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.operationscore.Behavior-pysrc.html#Behavior.init">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="behaviorInit"></a><span class="summary-sig-name">behaviorInit</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.operationscore.Behavior-pysrc.html#Behavior.behaviorInit">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="addMapper"></a><span class="summary-sig-name">addMapper</span>(<span class="summary-sig-arg">fn</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.operationscore.Behavior-pysrc.html#Behavior.addMapper">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="processResponse"></a><span class="summary-sig-name">processResponse</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">sensorInputs</span>, + <span class="summary-sig-arg">recursiveInputs</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.operationscore.Behavior-pysrc.html#Behavior.processResponse">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="addInput"></a><span class="summary-sig-name">addInput</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">sensorInput</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.operationscore.Behavior-pysrc.html#Behavior.addInput">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="immediateProcessInput"></a><span class="summary-sig-name">immediateProcessInput</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">sensorInputs</span>, + <span class="summary-sig-arg">recursiveInputs</span>=<span class="summary-sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.operationscore.Behavior-pysrc.html#Behavior.immediateProcessInput">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="addInputs"></a><span class="summary-sig-name">addInputs</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">sensorInputs</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.operationscore.Behavior-pysrc.html#Behavior.addInputs">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="getLastOutput"></a><span class="summary-sig-name">getLastOutput</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.operationscore.Behavior-pysrc.html#Behavior.getLastOutput">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="SmootLight.operationscore.Behavior.Behavior-class.html#setLastOutput" class="summary-sig-name">setLastOutput</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">output</span>)</span><br /> + Override to modify state.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.operationscore.Behavior-pysrc.html#Behavior.setLastOutput">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="addMapperToResponse"></a><span class="summary-sig-name">addMapperToResponse</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">responses</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.operationscore.Behavior-pysrc.html#Behavior.addMapperToResponse">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="timeStep"></a><span class="summary-sig-name">timeStep</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.operationscore.Behavior-pysrc.html#Behavior.timeStep">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code>operationscore.SmootCoreObject.SmootCoreObject</code></b>: + <code>__contains__</code>, + <code>__getitem__</code>, + <code>__getiter__</code>, + <code>__init__</code>, + <code>__setitem__</code>, + <code>acquireLock</code>, + <code>addDieListener</code>, + <code>className</code>, + <code>die</code>, + <code>releaseLock</code>, + <code>removeDieListener</code>, + <code>validateArgDict</code>, + <code>validateArgs</code> + </p> + <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: + <code>__delattr__</code>, + <code>__format__</code>, + <code>__getattribute__</code>, + <code>__hash__</code>, + <code>__new__</code>, + <code>__reduce__</code>, + <code>__reduce_ex__</code>, + <code>__repr__</code>, + <code>__setattr__</code>, + <code>__sizeof__</code>, + <code>__str__</code>, + <code>__subclasshook__</code> + </p> + </td> + </tr> +</table> +<!-- ==================== STATIC METHODS ==================== --> +<a name="section-StaticMethods"></a> +<table class="summary" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Static Methods</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-StaticMethods" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="deepCopyPacket"></a><span class="summary-sig-name">deepCopyPacket</span>(<span class="summary-sig-arg">datapacket</span>)</span><br /> + Returns a deep copy of a behavior data packet (a list of dicts) so + that modifying the returned packet will not modify the incoming + packet.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="SmootLight.operationscore.Behavior-pysrc.html#Behavior.deepCopyPacket">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +</table> +<!-- ==================== PROPERTIES ==================== --> +<a name="section-Properties"></a> +<table class="summary" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Properties</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-Properties" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: + <code>__class__</code> + </p> + </td> + </tr> +</table> +<!-- ==================== METHOD DETAILS ==================== --> +<a name="section-MethodDetails"></a> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Method Details</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-MethodDetails" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +</table> +<a name="init"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">init</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="SmootLight.operationscore.Behavior-pysrc.html#Behavior.init">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + <dt>Overrides: + operationscore.SmootCoreObject.SmootCoreObject.init + </dt> + </dl> +</td></tr></table> +</div> +<a name="setLastOutput"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">setLastOutput</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">output</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="SmootLight.operationscore.Behavior-pysrc.html#Behavior.setLastOutput">source code</a></span> + </td> + </tr></table> + + <p>Override to modify state. For example: if you are using a behavior + that does uses strings for location specification, you will want to + override this to point to a single location. Make sure you keep + lastState as a [] of {}. (List of dicts). Additonally, ensure that you + call Behavior.deepCopyPacket on the packet before hand to avoid + inadvertent down-stream modifications. Look at Square.py for an example + of this.</p> + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<br /> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + <!-- Home link --> + <th> <a + href="SmootLight-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th> <a + href="help.html">Help</a> </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:25 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> |