aboutsummaryrefslogtreecommitdiff
path: root/html/SmootLight.util.BehaviorQuerySystem-pysrc.html
blob: 103bec1e544235547dc1c6c4fafbd49d5932712a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
<?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.util.BehaviorQuerySystem</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.util-module.html">Package&nbsp;util</a> ::
        Module&nbsp;BehaviorQuerySystem
      </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.util.BehaviorQuerySystem-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="SmootLight.util.BehaviorQuerySystem-module.html">Module SmootLight.util.BehaviorQuerySystem</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">types</tt>  </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt>  <tt class="py-line"><tt class="py-string">"""The behavior query system is a module that allows querying behaviors based on lambda-function</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt>  <tt class="py-line"><tt class="py-string">predicates."""</tt> </tt>
<a name="initBQS"></a><div id="initBQS-def"><a name="L4"></a><tt class="py-lineno"> 4</tt> <a class="py-toggle" href="#" id="initBQS-toggle" onclick="return toggle('initBQS');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="SmootLight.util.BehaviorQuerySystem-module.html#initBQS">initBQS</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="initBQS-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="initBQS-expanded"><a name="L5"></a><tt class="py-lineno"> 5</tt>  <tt class="py-line">    <tt class="py-keyword">global</tt> <tt id="link-0" class="py-name" targets="Variable SmootLight.util.BehaviorQuerySystem.behaviorList=SmootLight.util.BehaviorQuerySystem-module.html#behaviorList"><a title="SmootLight.util.BehaviorQuerySystem.behaviorList" class="py-name" href="#" onclick="return doclink('link-0', 'behaviorList', 'link-0');">behaviorList</a></tt><tt class="py-op">,</tt> <tt id="link-1" class="py-name" targets="Variable SmootLight.util.BehaviorQuerySystem.initialized=SmootLight.util.BehaviorQuerySystem-module.html#initialized"><a title="SmootLight.util.BehaviorQuerySystem.initialized" class="py-name" href="#" onclick="return doclink('link-1', 'initialized', 'link-1');">initialized</a></tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt>  <tt class="py-line">    <tt id="link-2" class="py-name"><a title="SmootLight.util.BehaviorQuerySystem.behaviorList" class="py-name" href="#" onclick="return doclink('link-2', 'behaviorList', 'link-0');">behaviorList</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt>  </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt>  <tt class="py-line">    <tt id="link-3" class="py-name"><a title="SmootLight.util.BehaviorQuerySystem.initialized" class="py-name" href="#" onclick="return doclink('link-3', 'initialized', 'link-1');">initialized</a></tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
</div><a name="L8"></a><tt class="py-lineno"> 8</tt>  <tt class="py-line"> </tt>
<a name="addBehavior"></a><div id="addBehavior-def"><a name="L9"></a><tt class="py-lineno"> 9</tt> <a class="py-toggle" href="#" id="addBehavior-toggle" onclick="return toggle('addBehavior');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="SmootLight.util.BehaviorQuerySystem-module.html#addBehavior">addBehavior</a><tt class="py-op">(</tt><tt class="py-param">behavior</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="addBehavior-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="addBehavior-expanded"><a name="L10"></a><tt class="py-lineno">10</tt>  <tt class="py-line">    <tt class="py-docstring">"""Add a behavior to the behavior registry."""</tt> </tt>
<a name="L11"></a><tt class="py-lineno">11</tt>  <tt class="py-line">    <tt id="link-4" class="py-name"><a title="SmootLight.util.BehaviorQuerySystem.behaviorList" class="py-name" href="#" onclick="return doclink('link-4', 'behaviorList', 'link-0');">behaviorList</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">behavior</tt><tt class="py-op">)</tt> </tt>
</div><a name="L12"></a><tt class="py-lineno">12</tt>  <tt class="py-line"> </tt>
<a name="query"></a><div id="query-def"><a name="L13"></a><tt class="py-lineno">13</tt> <a class="py-toggle" href="#" id="query-toggle" onclick="return toggle('query');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="SmootLight.util.BehaviorQuerySystem-module.html#query">query</a><tt class="py-op">(</tt><tt class="py-param">predicateList</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="query-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="query-expanded"><a name="L14"></a><tt class="py-lineno">14</tt>  <tt class="py-line">    <tt class="py-docstring">"""BehaviorQuerySystem.query takes a list of predicates (functions with signature:</tt> </tt>
<a name="L15"></a><tt class="py-lineno">15</tt>  <tt class="py-line"><tt class="py-docstring">        (behavior,output)), and</tt> </tt>
<a name="L16"></a><tt class="py-lineno">16</tt>  <tt class="py-line"><tt class="py-docstring">    optionally a behavior to be compared to."""</tt> </tt>
<a name="L17"></a><tt class="py-lineno">17</tt>  <tt class="py-line">    <tt class="py-comment">#want to do queries wrt: behavior itself, the behavior packet, the querying behavior</tt> </tt>
<a name="L18"></a><tt class="py-lineno">18</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">predicateList</tt><tt class="py-op">,</tt> <tt class="py-name">types</tt><tt class="py-op">.</tt><tt class="py-name">FunctionType</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-name">predicateList</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-name">predicateList</tt><tt class="py-op">]</tt> </tt>
<a name="L20"></a><tt class="py-lineno">20</tt>  <tt class="py-line">    <tt class="py-keyword">elif</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">predicateList</tt><tt class="py-op">,</tt> <tt class="py-name">list</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L21"></a><tt class="py-lineno">21</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">'Predicate list must be a function or list of functions'</tt><tt class="py-op">)</tt> </tt>
<a name="L22"></a><tt class="py-lineno">22</tt>  <tt class="py-line">    <tt class="py-keyword">global</tt> <tt id="link-5" class="py-name"><a title="SmootLight.util.BehaviorQuerySystem.behaviorList" class="py-name" href="#" onclick="return doclink('link-5', 'behaviorList', 'link-0');">behaviorList</a></tt><tt class="py-op">,</tt> <tt id="link-6" class="py-name"><a title="SmootLight.util.BehaviorQuerySystem.initialized" class="py-name" href="#" onclick="return doclink('link-6', 'initialized', 'link-1');">initialized</a></tt> </tt>
<a name="L23"></a><tt class="py-lineno">23</tt>  <tt class="py-line">    <tt class="py-name">ret</tt> <tt class="py-op">=</tt> <tt class="py-op">[</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">if</tt> <tt class="py-keyword">not</tt> <tt id="link-7" class="py-name"><a title="SmootLight.util.BehaviorQuerySystem.initialized" class="py-name" href="#" onclick="return doclink('link-7', 'initialized', 'link-1');">initialized</a></tt><tt class="py-op">:</tt> </tt>
<a name="L25"></a><tt class="py-lineno">25</tt>  <tt class="py-line">        <tt id="link-8" class="py-name" targets="Function SmootLight.util.BehaviorQuerySystem.initBQS()=SmootLight.util.BehaviorQuerySystem-module.html#initBQS"><a title="SmootLight.util.BehaviorQuerySystem.initBQS" class="py-name" href="#" onclick="return doclink('link-8', 'initBQS', 'link-8');">initBQS</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L26"></a><tt class="py-lineno">26</tt>  <tt class="py-line">     </tt>
<a name="L27"></a><tt class="py-lineno">27</tt>  <tt class="py-line">    <tt class="py-keyword">for</tt> <tt class="py-name">behavior</tt> <tt class="py-keyword">in</tt> <tt id="link-9" class="py-name"><a title="SmootLight.util.BehaviorQuerySystem.behaviorList" class="py-name" href="#" onclick="return doclink('link-9', 'behaviorList', 'link-0');">behaviorList</a></tt><tt class="py-op">:</tt> <tt class="py-comment">#Consider every behavior</tt> </tt>
<a name="L28"></a><tt class="py-lineno">28</tt>  <tt class="py-line">        <tt class="py-name">lastOutput</tt> <tt class="py-op">=</tt> <tt class="py-name">behavior</tt><tt class="py-op">.</tt><tt id="link-10" class="py-name" targets="Method SmootLight.operationscore.Behavior.Behavior.getLastOutput()=SmootLight.operationscore.Behavior.Behavior-class.html#getLastOutput"><a title="SmootLight.operationscore.Behavior.Behavior.getLastOutput" class="py-name" href="#" onclick="return doclink('link-10', 'getLastOutput', 'link-10');">getLastOutput</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L29"></a><tt class="py-lineno">29</tt>  <tt class="py-line">        <tt class="py-keyword">for</tt> <tt class="py-name">output</tt> <tt class="py-keyword">in</tt> <tt class="py-name">lastOutput</tt><tt class="py-op">:</tt> <tt class="py-comment">#Look at every element it has output</tt> </tt>
<a name="L30"></a><tt class="py-lineno">30</tt>  <tt class="py-line">            <tt class="py-name">validOutput</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L31"></a><tt class="py-lineno">31</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">pred</tt> <tt class="py-keyword">in</tt> <tt class="py-name">predicateList</tt><tt class="py-op">:</tt> <tt class="py-comment">#Evaluate every predicate.  A predicate is a lambda function that</tt> </tt>
<a name="L32"></a><tt class="py-lineno">32</tt>  <tt class="py-line">            <tt class="py-comment">#takes a dict and returns a bool.</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-keyword">not</tt> <tt class="py-name">pred</tt><tt class="py-op">(</tt><tt class="py-name">output</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L34"></a><tt class="py-lineno">34</tt>  <tt class="py-line">                    <tt class="py-name">validOutput</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L35"></a><tt class="py-lineno">35</tt>  <tt class="py-line">                    <tt class="py-keyword">break</tt> </tt>
<a name="L36"></a><tt class="py-lineno">36</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">validOutput</tt><tt class="py-op">:</tt> </tt>
<a name="L37"></a><tt class="py-lineno">37</tt>  <tt class="py-line">                <tt class="py-name">ret</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">output</tt><tt class="py-op">)</tt> </tt>
<a name="L38"></a><tt class="py-lineno">38</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">ret</tt>  </tt>
</div><a name="L39"></a><tt class="py-lineno">39</tt>  <tt class="py-line"> </tt>
<a name="getDistLambda"></a><div id="getDistLambda-def"><a name="L40"></a><tt class="py-lineno">40</tt> <a class="py-toggle" href="#" id="getDistLambda-toggle" onclick="return toggle('getDistLambda');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="SmootLight.util.BehaviorQuerySystem-module.html#getDistLambda">getDistLambda</a><tt class="py-op">(</tt><tt class="py-param">loc</tt><tt class="py-op">,</tt> <tt class="py-param">maxDist</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="getDistLambda-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="getDistLambda-expanded"><a name="L41"></a><tt class="py-lineno">41</tt>  <tt class="py-line">    <tt class="py-docstring">"""Returns a lambda function that checks if for behaviors within maxDist of loc.  Can be passed</tt> </tt>
<a name="L42"></a><tt class="py-lineno">42</tt>  <tt class="py-line"><tt class="py-docstring">    in as an arg to query."""</tt> </tt>
<a name="L43"></a><tt class="py-lineno">43</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-keyword">lambda</tt> <tt class="py-name">args</tt><tt class="py-op">:</tt><tt class="py-name">geo</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name" targets="Function SmootLight.util.Geo.dist()=SmootLight.util.Geo-module.html#dist"><a title="SmootLight.util.Geo.dist" class="py-name" href="#" onclick="return doclink('link-11', 'dist', 'link-11');">dist</a></tt><tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">[</tt><tt class="py-string">'Location'</tt><tt class="py-op">]</tt><tt class="py-op">,</tt> <tt class="py-name">loc</tt><tt class="py-op">)</tt> <tt class="py-op">&lt;=</tt> <tt class="py-name">maxDist</tt> </tt>
</div><a name="L44"></a><tt class="py-lineno">44</tt>  <tt class="py-line"> </tt>
<a name="getBehaviorsNear"></a><div id="getBehaviorsNear-def"><a name="L45"></a><tt class="py-lineno">45</tt> <a class="py-toggle" href="#" id="getBehaviorsNear-toggle" onclick="return toggle('getBehaviorsNear');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="SmootLight.util.BehaviorQuerySystem-module.html#getBehaviorsNear">getBehaviorsNear</a><tt class="py-op">(</tt><tt class="py-param">loc</tt><tt class="py-op">,</tt> <tt class="py-param">maxdist</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="getBehaviorsNear-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="getBehaviorsNear-expanded"><a name="L46"></a><tt class="py-lineno">46</tt>  <tt class="py-line">    <tt class="py-docstring">"""A premade method to do the common task of finding behavior near a location."""</tt> </tt>
<a name="L47"></a><tt class="py-lineno">47</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt id="link-12" class="py-name" targets="Function SmootLight.util.BehaviorQuerySystem.query()=SmootLight.util.BehaviorQuerySystem-module.html#query"><a title="SmootLight.util.BehaviorQuerySystem.query" class="py-name" href="#" onclick="return doclink('link-12', 'query', 'link-12');">query</a></tt><tt class="py-op">(</tt><tt id="link-13" class="py-name" targets="Function SmootLight.util.BehaviorQuerySystem.getDistLambda()=SmootLight.util.BehaviorQuerySystem-module.html#getDistLambda"><a title="SmootLight.util.BehaviorQuerySystem.getDistLambda" class="py-name" href="#" onclick="return doclink('link-13', 'getDistLambda', 'link-13');">getDistLambda</a></tt><tt class="py-op">(</tt><tt class="py-name">loc</tt><tt class="py-op">,</tt> <tt class="py-name">maxDist</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L48"></a><tt class="py-lineno">48</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>