nxtOSEK/lejos_nxj/docs/apidocs/lejos/subsumption/Arbitrator.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!--NewPage-->
   3 <HTML>
   4 <HEAD>
   5 <!-- Generated by javadoc (build 1.5.0_09) on Sun Sep 02 23:07:08 BST 2007 -->
   6 <TITLE>
   7 Arbitrator (leJOS NXT API documentation)
   8 </TITLE>
   9
  10 <META NAME="keywords" CONTENT="lejos.subsumption.Arbitrator class">
  11
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
  13
  14 <SCRIPT type="text/javascript">
  15 function windowTitle()
  16 {
  17     parent.document.title="Arbitrator (leJOS NXT API documentation)";
  18 }
  19 </SCRIPT>
  20 <NOSCRIPT>
  21 </NOSCRIPT>
  22
  23 </HEAD>
  24
  25 <BODY BGCOLOR="white" onload="windowTitle();">
  26
  27
  28 <!-- ========= START OF TOP NAVBAR ======= -->
  29 <A NAME="navbar_top"><!-- --></A>
  30 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  31 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  32 <TR>
  33 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  34 <A NAME="navbar_top_firstrow"><!-- --></A>
  35 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  36   <TR ALIGN="center" VALIGN="top">
  37   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  39   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  44   </TR>
  45 </TABLE>
  46 </TD>
  47 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  48 </EM>
  49 </TD>
  50 </TR>
  51
  52 <TR>
  53 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  54 &nbsp;<A HREF="../../lejos/subsumption/ActivityBase.html" title="class in lejos.subsumption"><B>PREV CLASS</B></A>&nbsp;
  55 &nbsp;<A HREF="../../lejos/subsumption/Behavior.html" title="interface in lejos.subsumption"><B>NEXT CLASS</B></A></FONT></TD>
  56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  57   <A HREF="../../index.html?lejos/subsumption/Arbitrator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  58 &nbsp;<A HREF="Arbitrator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  59 &nbsp;<SCRIPT type="text/javascript">
  60   <!--
  61   if(window==top) {
  62     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
  63   }
  64   //-->
  65 </SCRIPT>
  66 <NOSCRIPT>
  67   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
  68 </NOSCRIPT>
  69
  70
  71 </FONT></TD>
  72 </TR>
  73 <TR>
  74 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  75   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  77 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  78 </TR>
  79 </TABLE>
  80 <A NAME="skip-navbar_top"></A>
  81 <!-- ========= END OF TOP NAVBAR ========= -->
  82
  83 <HR>
  84 <!-- ======== START OF CLASS DATA ======== -->
  85 <H2>
  86 <FONT SIZE="-1">
  87 lejos.subsumption</FONT>
  88 <BR>
  89 Class Arbitrator</H2>
  90 <PRE>
  91 <A HREF="../../java/lang/Object.html" title="class in java.lang">java.lang.Object</A>
  92   <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>lejos.subsumption.Arbitrator</B>
  93 </PRE>
  94 <HR>
  95 <DL>
  96 <DT><PRE>public class <B>Arbitrator</B><DT>extends <A HREF="../../java/lang/Object.html" title="class in java.lang">Object</A></DL>
  97 </PRE>
  98
  99 <P>
 100 Arbitrator controls which behavior should currently be active in
 101  a behavior control system. Make sure to call start() after the
 102  Arbitrator is instantiated.
 103 <P>
 104
 105 <P>
 106 <DL>
 107 <DT><B>Version:</B></DT>
 108   <DD>0.1  27-July-2001</DD>
 109 <DT><B>Author:</B></DT>
 110   <DD><a href="mailto:bbagnall@escape.ca">Brian Bagnall</a></DD>
 111 <DT><B>See Also:</B><DD><A HREF="../../lejos/subsumption/Behavior.html" title="interface in lejos.subsumption"><CODE>Behavior</CODE></A></DL>
 112 <HR>
 113
 114 <P>
 115
 116 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 117
 118 <A NAME="constructor_summary"><!-- --></A>
 119 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 120 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 121 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 122 <B>Constructor Summary</B></FONT></TH>
 123 </TR>
 124 <TR BGCOLOR="white" CLASS="TableRowColor">
 125 <TD><CODE><B><A HREF="../../lejos/subsumption/Arbitrator.html#Arbitrator(lejos.subsumption.Behavior[])">Arbitrator</A></B>(<A HREF="../../lejos/subsumption/Behavior.html" title="interface in lejos.subsumption">Behavior</A>[]&nbsp;behaviors)</CODE>
 126
 127 <BR>
 128 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Allocates an Arbitrator object and initializes it with an array of
 129  Behavior objects.</TD>
 130 </TR>
 131 </TABLE>
 132 &nbsp;
 133 <!-- ========== METHOD SUMMARY =========== -->
 134
 135 <A NAME="method_summary"><!-- --></A>
 136 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 137 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 138 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 139 <B>Method Summary</B></FONT></TH>
 140 </TR>
 141 <TR BGCOLOR="white" CLASS="TableRowColor">
 142 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 143 <CODE>&nbsp;void</CODE></FONT></TD>
 144 <TD><CODE><B><A HREF="../../lejos/subsumption/Arbitrator.html#start()">start</A></B>()</CODE>
 145
 146 <BR>
 147 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method starts the arbitration of Behaviors.</TD>
 148 </TR>
 149 </TABLE>
 150 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 151 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 152 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 153 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="../../java/lang/Object.html" title="class in java.lang">Object</A></B></TH>
 154 </TR>
 155 <TR BGCOLOR="white" CLASS="TableRowColor">
 156 <TD><CODE><A HREF="../../java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="../../java/lang/Object.html#getClass()">getClass</A>, <A HREF="../../java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="../../java/lang/Object.html#notify()">notify</A>, <A HREF="../../java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="../../java/lang/Object.html#toString()">toString</A>, <A HREF="../../java/lang/Object.html#wait()">wait</A>, <A HREF="../../java/lang/Object.html#wait(long)">wait</A></CODE></TD>
 157 </TR>
 158 </TABLE>
 159 &nbsp;
 160 <P>
 161
 162 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 163
 164 <A NAME="constructor_detail"><!-- --></A>
 165 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 166 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 167 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 168 <B>Constructor Detail</B></FONT></TH>
 169 </TR>
 170 </TABLE>
 171
 172 <A NAME="Arbitrator(lejos.subsumption.Behavior[])"><!-- --></A><H3>
 173 Arbitrator</H3>
 174 <PRE>
 175 public <B>Arbitrator</B>(<A HREF="../../lejos/subsumption/Behavior.html" title="interface in lejos.subsumption">Behavior</A>[]&nbsp;behaviors)</PRE>
 176 <DL>
 177 <DD>Allocates an Arbitrator object and initializes it with an array of
 178  Behavior objects. The highest index in the Behavior array will have the
 179  highest order behavior level, and hence will suppress all lower level
 180  behaviors if it becomes active. The Behaviors in an Arbitrator can not
 181  be changed once the arbitrator is initialized.<BR>
 182  <B>NOTE:</B> Once the Arbitrator is initialized, the method start() must be
 183  called to begin the arbitration.
 184 <P>
 185 <DL>
 186 <DT><B>Parameters:</B><DD><CODE>behaviors</CODE> - An array of Behavior objects.</DL>
 187 </DL>
 188
 189 <!-- ============ METHOD DETAIL ========== -->
 190
 191 <A NAME="method_detail"><!-- --></A>
 192 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 193 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 194 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 195 <B>Method Detail</B></FONT></TH>
 196 </TR>
 197 </TABLE>
 198
 199 <A NAME="start()"><!-- --></A><H3>
 200 start</H3>
 201 <PRE>
 202 public void <B>start</B>()</PRE>
 203 <DL>
 204 <DD>This method starts the arbitration of Behaviors.
 205  Modifying the start() method is not recomended. <BR>
 206  Note: Arbitrator does not run in a seperate thread, and hence the start()
 207  method will never return.
 208 <P>
 209 <DD><DL>
 210 </DL>
 211 </DD>
 212 </DL>
 213 <!-- ========= END OF CLASS DATA ========= -->
 214 <HR>
 215
 216
 217 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 218 <A NAME="navbar_bottom"><!-- --></A>
 219 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 220 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 221 <TR>
 222 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 223 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 224 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 225   <TR ALIGN="center" VALIGN="top">
 226   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 227   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 228   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 229   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 230   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 231   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 232   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 233   </TR>
 234 </TABLE>
 235 </TD>
 236 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 237 </EM>
 238 </TD>
 239 </TR>
 240
 241 <TR>
 242 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 243 &nbsp;<A HREF="../../lejos/subsumption/ActivityBase.html" title="class in lejos.subsumption"><B>PREV CLASS</B></A>&nbsp;
 244 &nbsp;<A HREF="../../lejos/subsumption/Behavior.html" title="interface in lejos.subsumption"><B>NEXT CLASS</B></A></FONT></TD>
 245 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 246   <A HREF="../../index.html?lejos/subsumption/Arbitrator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 247 &nbsp;<A HREF="Arbitrator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 248 &nbsp;<SCRIPT type="text/javascript">
 249   <!--
 250   if(window==top) {
 251     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
 252   }
 253   //-->
 254 </SCRIPT>
 255 <NOSCRIPT>
 256   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
 257 </NOSCRIPT>
 258
 259
 260 </FONT></TD>
 261 </TR>
 262 <TR>
 263 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 264   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 265 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 266 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 267 </TR>
 268 </TABLE>
 269 <A NAME="skip-navbar_bottom"></A>
 270 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 271
 272 <HR>
 273
 274 </BODY>
 275 </HTML>