scripts/java/FGClient/docs/javadoc/org/flightgear/fgfsclient/FGFSConnection.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
   2 <!--NewPage-->
   3 <HTML>
   4 <HEAD>
   5 <!-- Generated by javadoc on Sat Jun 08 09:45:47 EDT 2002 -->
   6 <TITLE>
   7 : Class  FGFSConnection
   8 </TITLE>
   9 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
  10 </HEAD>
  11 <BODY BGCOLOR="white">
  12
  13 <!-- ========== START OF NAVBAR ========== -->
  14 <A NAME="navbar_top"><!-- --></A>
  15 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  16 <TR>
  17 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  18 <A NAME="navbar_top_firstrow"><!-- --></A>
  19 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  20   <TR ALIGN="center" VALIGN="top">
  21   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  22   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  23   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FGFSConnection.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  24   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  25   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  26   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  27   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  28   </TR>
  29 </TABLE>
  30 </TD>
  31 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  32 </EM>
  33 </TD>
  34 </TR>
  35
  36 <TR>
  37 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  38 &nbsp;PREV CLASS&nbsp;
  39 &nbsp;NEXT CLASS</FONT></TD>
  40 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  41   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
  42 &nbsp;<A HREF="FGFSConnection.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  43 </TR>
  44 <TR>
  45 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  46   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  47 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  48 DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  49 </TR>
  50 </TABLE>
  51 <!-- =========== END OF NAVBAR =========== -->
  52
  53 <HR>
  54 <!-- ======== START OF CLASS DATA ======== -->
  55 <H2>
  56 <FONT SIZE="-1">
  57 org.flightgear.fgfsclient</FONT>
  58 <BR>
  59 Class  FGFSConnection</H2>
  60 <PRE>
  61 <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">java.lang.Object</A>
  62   |
  63   +--<B>org.flightgear.fgfsclient.FGFSConnection</B>
  64 </PRE>
  65 <HR>
  66 <DL>
  67 <DT>public class <B>FGFSConnection</B><DT>extends <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A></DL>
  68
  69 <P>
  70 A connection to a running instance of FlightGear.
  71
  72  <p>This class currently uses the FlightGear telnet interface,
  73  though it may be modified to use a different TCP/IP interface in
  74  the future.  Client applications can use this library to examine
  75  and modify internal FlightGear properties.</p>
  76
  77  <p>To start FlightGear with the telnet server activated, use a
  78  command like this (to listen on port 9000):</p>
  79
  80  <blockquote><pre>
  81  fgfs --telnet=9000
  82  </pre></blockquote>
  83
  84  <p>Then create a connection to FlightGear from your Java client
  85  application:</p>
  86
  87  <blockquote><pre>
  88  FGFSConnection fgfs = new FGFSConnection("localhost", 9000);
  89  </pre></blockquote>
  90
  91  <p>Now you can use the connection to get and set FlightGear
  92  properties:</p>
  93
  94  <blockquote><pre>
  95  double altitude = fgfs.getDouble("/position/altitude-ft");
  96  fgfs.setDouble("/orientation/heading", 270.0);
  97  </pre></blockquote>
  98
  99  <p>All methods that communicate directly with FlightGear are
 100  synchronized, since they must work over a single telnet
 101  connection.</p>
 102 <P>
 103 <HR>
 104
 105 <P>
 106 <!-- ======== INNER CLASS SUMMARY ======== -->
 107
 108
 109 <!-- =========== FIELD SUMMARY =========== -->
 110
 111
 112 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 113
 114 <A NAME="constructor_summary"><!-- --></A>
 115 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 116 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 117 <TD COLSPAN=2><FONT SIZE="+2">
 118 <B>Constructor Summary</B></FONT></TD>
 119 </TR>
 120 <TR BGCOLOR="white" CLASS="TableRowColor">
 121 <TD><CODE><B><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#FGFSConnection(java.lang.String, int)">FGFSConnection</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;host,
 122                int&nbsp;port)</CODE>
 123
 124 <BR>
 125 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor.</TD>
 126 </TR>
 127 </TABLE>
 128 &nbsp;
 129 <!-- ========== METHOD SUMMARY =========== -->
 130
 131 <A NAME="method_summary"><!-- --></A>
 132 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 133 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 134 <TD COLSPAN=2><FONT SIZE="+2">
 135 <B>Method Summary</B></FONT></TD>
 136 </TR>
 137 <TR BGCOLOR="white" CLASS="TableRowColor">
 138 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 139 <CODE>&nbsp;void</CODE></FONT></TD>
 140 <TD><CODE><B><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#close()">close</A></B>()</CODE>
 141
 142 <BR>
 143 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Close the connection to FlightGear.</TD>
 144 </TR>
 145 <TR BGCOLOR="white" CLASS="TableRowColor">
 146 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 147 <CODE>&nbsp;<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
 148 <TD><CODE><B><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#get(java.lang.String)">get</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
 149
 150 <BR>
 151 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the raw string value for a property.</TD>
 152 </TR>
 153 <TR BGCOLOR="white" CLASS="TableRowColor">
 154 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 155 <CODE>&nbsp;boolean</CODE></FONT></TD>
 156 <TD><CODE><B><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#getBoolean(java.lang.String)">getBoolean</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
 157
 158 <BR>
 159 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a property value as a boolean.</TD>
 160 </TR>
 161 <TR BGCOLOR="white" CLASS="TableRowColor">
 162 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 163 <CODE>&nbsp;double</CODE></FONT></TD>
 164 <TD><CODE><B><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#getDouble(java.lang.String)">getDouble</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
 165
 166 <BR>
 167 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a property value as a double.</TD>
 168 </TR>
 169 <TR BGCOLOR="white" CLASS="TableRowColor">
 170 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 171 <CODE>&nbsp;float</CODE></FONT></TD>
 172 <TD><CODE><B><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#getFloat(java.lang.String)">getFloat</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
 173
 174 <BR>
 175 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a property value as a float.</TD>
 176 </TR>
 177 <TR BGCOLOR="white" CLASS="TableRowColor">
 178 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 179 <CODE>&nbsp;int</CODE></FONT></TD>
 180 <TD><CODE><B><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#getInt(java.lang.String)">getInt</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
 181
 182 <BR>
 183 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a property value as an integer.</TD>
 184 </TR>
 185 <TR BGCOLOR="white" CLASS="TableRowColor">
 186 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 187 <CODE>&nbsp;long</CODE></FONT></TD>
 188 <TD><CODE><B><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#getLong(java.lang.String)">getLong</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)</CODE>
 189
 190 <BR>
 191 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a property value as a long.</TD>
 192 </TR>
 193 <TR BGCOLOR="white" CLASS="TableRowColor">
 194 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 195 <CODE>&nbsp;void</CODE></FONT></TD>
 196 <TD><CODE><B><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#set(java.lang.String, java.lang.String)">set</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name,
 197     <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;value)</CODE>
 198
 199 <BR>
 200 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the raw string value for a property.</TD>
 201 </TR>
 202 <TR BGCOLOR="white" CLASS="TableRowColor">
 203 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 204 <CODE>&nbsp;void</CODE></FONT></TD>
 205 <TD><CODE><B><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#setBoolean(java.lang.String, boolean)">setBoolean</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name,
 206            boolean&nbsp;value)</CODE>
 207
 208 <BR>
 209 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a property value from a boolean.</TD>
 210 </TR>
 211 <TR BGCOLOR="white" CLASS="TableRowColor">
 212 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 213 <CODE>&nbsp;void</CODE></FONT></TD>
 214 <TD><CODE><B><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#setDouble(java.lang.String, double)">setDouble</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name,
 215           double&nbsp;value)</CODE>
 216
 217 <BR>
 218 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a property value from a double.</TD>
 219 </TR>
 220 <TR BGCOLOR="white" CLASS="TableRowColor">
 221 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 222 <CODE>&nbsp;void</CODE></FONT></TD>
 223 <TD><CODE><B><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#setFloat(java.lang.String, float)">setFloat</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name,
 224          float&nbsp;value)</CODE>
 225
 226 <BR>
 227 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a property value from a float.</TD>
 228 </TR>
 229 <TR BGCOLOR="white" CLASS="TableRowColor">
 230 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 231 <CODE>&nbsp;void</CODE></FONT></TD>
 232 <TD><CODE><B><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#setInt(java.lang.String, int)">setInt</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name,
 233        int&nbsp;value)</CODE>
 234
 235 <BR>
 236 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a property value from an int.</TD>
 237 </TR>
 238 <TR BGCOLOR="white" CLASS="TableRowColor">
 239 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 240 <CODE>&nbsp;void</CODE></FONT></TD>
 241 <TD><CODE><B><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#setLong(java.lang.String, long)">setLong</A></B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name,
 242         long&nbsp;value)</CODE>
 243
 244 <BR>
 245 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a property value from a long.</TD>
 246 </TR>
 247 </TABLE>
 248 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 249 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 250 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 251 <TD><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">Object</A></B></TD>
 252 </TR>
 253 <TR BGCOLOR="white" CLASS="TableRowColor">
 254 <TD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#equals(java.lang.Object)">equals</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#getClass()">getClass</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#hashCode()">hashCode</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#notify()">notify</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#notifyAll()">notifyAll</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#toString()">toString</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#wait()">wait</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#wait(long)">wait</A>, <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html#wait(long, int)">wait</A></CODE></TD>
 255 </TR>
 256 </TABLE>
 257 &nbsp;
 258 <P>
 259
 260 <!-- ============ FIELD DETAIL =========== -->
 261
 262
 263 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 264
 265 <A NAME="constructor_detail"><!-- --></A>
 266 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 267 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 268 <TD COLSPAN=1><FONT SIZE="+2">
 269 <B>Constructor Detail</B></FONT></TD>
 270 </TR>
 271 </TABLE>
 272
 273 <A NAME="FGFSConnection(java.lang.String, int)"><!-- --></A><H3>
 274 FGFSConnection</H3>
 275 <PRE>
 276 public <B>FGFSConnection</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;host,
 277                       int&nbsp;port)
 278                throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
 279 <DL>
 280 <DD>Constructor.
 281
 282  <p>Create a new connection to a running FlightGear program.
 283  The program must have been started with the --telnet=&lt;port&gt;
 284  command-line option.</p><DD><DL>
 285 <DT><B>Parameters:</B><DD><CODE>host</CODE> - The host name or IP address to connect to.<DD><CODE>port</CODE> - The port number where FlightGear is listening.<DT><B>Throws:</B><DD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - If it is not possible to connect to
 286  a FlightGear process.</DL>
 287 </DD>
 288 </DL>
 289
 290 <!-- ============ METHOD DETAIL ========== -->
 291
 292 <A NAME="method_detail"><!-- --></A>
 293 <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
 294 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 295 <TD COLSPAN=1><FONT SIZE="+2">
 296 <B>Method Detail</B></FONT></TD>
 297 </TR>
 298 </TABLE>
 299
 300 <A NAME="close()"><!-- --></A><H3>
 301 close</H3>
 302 <PRE>
 303 public void <B>close</B>()
 304            throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
 305 <DL>
 306 <DD>Close the connection to FlightGear.
 307
 308  <p>The client application should always invoke this method when
 309  it has finished with a connection, to allow cleanup.</p><DD><DL>
 310 <DT><B>Throws:</B><DD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - If there is an error closing the
 311  connection.</DL>
 312 </DD>
 313 </DL>
 314 <HR>
 315
 316 <A NAME="get(java.lang.String)"><!-- --></A><H3>
 317 get</H3>
 318 <PRE>
 319 public <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> <B>get</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)
 320            throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
 321 <DL>
 322 <DD>Get the raw string value for a property.
 323
 324  <p>This is the primitive method for all property lookup;
 325  everything comes in as a string, and is only later converted by
 326  methods like <A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#getDouble(java.lang.String)"><CODE>getDouble(String)</CODE></A>.  As a result, if you
 327  need the value as a string anyway, it makes sense to use this
 328  method directly rather than forcing extra conversions.</p><DD><DL>
 329 <DT><B>Parameters:</B><DD><CODE>name</CODE> - The FlightGear property name to look up.<DT><B>Returns:</B><DD>The property value as a string (non-existant properties
 330  return the empty string).<DT><B>Throws:</B><DD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - If there is an error communicating with
 331  FlightGear or if the connection is lost.<DT><B>See Also: </B><DD><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#getBoolean(java.lang.String)"><CODE>getBoolean(String)</CODE></A>,
 332 <A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#getInt(java.lang.String)"><CODE>getInt(String)</CODE></A>,
 333 <A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#getLong(java.lang.String)"><CODE>getLong(String)</CODE></A>,
 334 <A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#getFloat(java.lang.String)"><CODE>getFloat(String)</CODE></A>,
 335 <A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#getDouble(java.lang.String)"><CODE>getDouble(String)</CODE></A></DL>
 336 </DD>
 337 </DL>
 338 <HR>
 339
 340 <A NAME="set(java.lang.String, java.lang.String)"><!-- --></A><H3>
 341 set</H3>
 342 <PRE>
 343 public void <B>set</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name,
 344                 <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;value)
 345          throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
 346 <DL>
 347 <DD>Set the raw string value for a property.
 348
 349  <p>This is the primitive method for all property modification;
 350  everything goes out as a string, after it has been converted by
 351  methods like <A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#setDouble(java.lang.String, double)"><CODE>setDouble(String,double)</CODE></A>.  As a result, if
 352  you have the value as a string already, it makes sense to use
 353  this method directly rather than forcing extra conversions.</p><DD><DL>
 354 <DT><B>Parameters:</B><DD><CODE>name</CODE> - The FlightGear property name to modify or create.<DD><CODE>value</CODE> - The new value for the property, as a string.<DT><B>Throws:</B><DD><CODE><A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></CODE> - If there is an error communicating with
 355  FlightGear or if the connection is lost.<DT><B>See Also: </B><DD><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#setBoolean(java.lang.String, boolean)"><CODE>setBoolean(String,boolean)</CODE></A>,
 356 <A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#setInt(java.lang.String, int)"><CODE>setInt(String,int)</CODE></A>,
 357 <A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#setLong(java.lang.String, long)"><CODE>setLong(String,long)</CODE></A>,
 358 <A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#setFloat(java.lang.String, float)"><CODE>setFloat(String,float)</CODE></A>,
 359 <A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#setDouble(java.lang.String, double)"><CODE>setDouble(String,double)</CODE></A></DL>
 360 </DD>
 361 </DL>
 362 <HR>
 363
 364 <A NAME="getBoolean(java.lang.String)"><!-- --></A><H3>
 365 getBoolean</H3>
 366 <PRE>
 367 public boolean <B>getBoolean</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)
 368                    throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
 369 <DL>
 370 <DD>Get a property value as a boolean.<DD><DL>
 371 <DT><B>Parameters:</B><DD><CODE>name</CODE> - The property name to look up.<DT><B>Returns:</B><DD>The property value as a boolean.<DT><B>See Also: </B><DD><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#get(java.lang.String)"><CODE>get(String)</CODE></A></DL>
 372 </DD>
 373 </DL>
 374 <HR>
 375
 376 <A NAME="getInt(java.lang.String)"><!-- --></A><H3>
 377 getInt</H3>
 378 <PRE>
 379 public int <B>getInt</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)
 380            throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
 381 <DL>
 382 <DD>Get a property value as an integer.<DD><DL>
 383 <DT><B>Parameters:</B><DD><CODE>name</CODE> - The property name to look up.<DT><B>Returns:</B><DD>The property value as an int.<DT><B>See Also: </B><DD><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#get(java.lang.String)"><CODE>get(String)</CODE></A></DL>
 384 </DD>
 385 </DL>
 386 <HR>
 387
 388 <A NAME="getLong(java.lang.String)"><!-- --></A><H3>
 389 getLong</H3>
 390 <PRE>
 391 public long <B>getLong</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)
 392              throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
 393 <DL>
 394 <DD>Get a property value as a long.<DD><DL>
 395 <DT><B>Parameters:</B><DD><CODE>name</CODE> - The property name to look up.<DT><B>Returns:</B><DD>The property value as a long.<DT><B>See Also: </B><DD><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#get(java.lang.String)"><CODE>get(String)</CODE></A></DL>
 396 </DD>
 397 </DL>
 398 <HR>
 399
 400 <A NAME="getFloat(java.lang.String)"><!-- --></A><H3>
 401 getFloat</H3>
 402 <PRE>
 403 public float <B>getFloat</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)
 404                throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
 405 <DL>
 406 <DD>Get a property value as a float.<DD><DL>
 407 <DT><B>Parameters:</B><DD><CODE>name</CODE> - The property name to look up.<DT><B>Returns:</B><DD>The property value as a float.<DT><B>See Also: </B><DD><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#get(java.lang.String)"><CODE>get(String)</CODE></A></DL>
 408 </DD>
 409 </DL>
 410 <HR>
 411
 412 <A NAME="getDouble(java.lang.String)"><!-- --></A><H3>
 413 getDouble</H3>
 414 <PRE>
 415 public double <B>getDouble</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name)
 416                  throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
 417 <DL>
 418 <DD>Get a property value as a double.<DD><DL>
 419 <DT><B>Parameters:</B><DD><CODE>name</CODE> - The property name to look up.<DT><B>Returns:</B><DD>The property value as a double.<DT><B>See Also: </B><DD><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#get(java.lang.String)"><CODE>get(String)</CODE></A></DL>
 420 </DD>
 421 </DL>
 422 <HR>
 423
 424 <A NAME="setBoolean(java.lang.String, boolean)"><!-- --></A><H3>
 425 setBoolean</H3>
 426 <PRE>
 427 public void <B>setBoolean</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name,
 428                        boolean&nbsp;value)
 429                 throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
 430 <DL>
 431 <DD>Set a property value from a boolean.<DD><DL>
 432 <DT><B>Parameters:</B><DD><CODE>name</CODE> - The property name to create or modify.<DD><CODE>value</CODE> - The new property value as a boolean.<DT><B>See Also: </B><DD><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#set(java.lang.String, java.lang.String)"><CODE>set(String,String)</CODE></A></DL>
 433 </DD>
 434 </DL>
 435 <HR>
 436
 437 <A NAME="setInt(java.lang.String, int)"><!-- --></A><H3>
 438 setInt</H3>
 439 <PRE>
 440 public void <B>setInt</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name,
 441                    int&nbsp;value)
 442             throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
 443 <DL>
 444 <DD>Set a property value from an int.<DD><DL>
 445 <DT><B>Parameters:</B><DD><CODE>name</CODE> - The property name to create or modify.<DD><CODE>value</CODE> - The new property value as an int.<DT><B>See Also: </B><DD><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#set(java.lang.String, java.lang.String)"><CODE>set(String,String)</CODE></A></DL>
 446 </DD>
 447 </DL>
 448 <HR>
 449
 450 <A NAME="setLong(java.lang.String, long)"><!-- --></A><H3>
 451 setLong</H3>
 452 <PRE>
 453 public void <B>setLong</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name,
 454                     long&nbsp;value)
 455              throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
 456 <DL>
 457 <DD>Set a property value from a long.<DD><DL>
 458 <DT><B>Parameters:</B><DD><CODE>name</CODE> - The property name to create or modify.<DD><CODE>value</CODE> - The new property value as a long.<DT><B>See Also: </B><DD><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#set(java.lang.String, java.lang.String)"><CODE>set(String,String)</CODE></A></DL>
 459 </DD>
 460 </DL>
 461 <HR>
 462
 463 <A NAME="setFloat(java.lang.String, float)"><!-- --></A><H3>
 464 setFloat</H3>
 465 <PRE>
 466 public void <B>setFloat</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name,
 467                      float&nbsp;value)
 468               throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
 469 <DL>
 470 <DD>Set a property value from a float.<DD><DL>
 471 <DT><B>Parameters:</B><DD><CODE>name</CODE> - The property name to create or modify.<DD><CODE>value</CODE> - The new property value as a float.<DT><B>See Also: </B><DD><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#set(java.lang.String, java.lang.String)"><CODE>set(String,String)</CODE></A></DL>
 472 </DD>
 473 </DL>
 474 <HR>
 475
 476 <A NAME="setDouble(java.lang.String, double)"><!-- --></A><H3>
 477 setDouble</H3>
 478 <PRE>
 479 public void <B>setDouble</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A>&nbsp;name,
 480                       double&nbsp;value)
 481                throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
 482 <DL>
 483 <DD>Set a property value from a double.<DD><DL>
 484 <DT><B>Parameters:</B><DD><CODE>name</CODE> - The property name to create or modify.<DD><CODE>value</CODE> - The new property value as a double.<DT><B>See Also: </B><DD><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#set(java.lang.String, java.lang.String)"><CODE>set(String,String)</CODE></A></DL>
 485 </DD>
 486 </DL>
 487 <!-- ========= END OF CLASS DATA ========= -->
 488 <HR>
 489
 490 <!-- ========== START OF NAVBAR ========== -->
 491 <A NAME="navbar_bottom"><!-- --></A>
 492 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
 493 <TR>
 494 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 495 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 496 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
 497   <TR ALIGN="center" VALIGN="top">
 498   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 499   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 500   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/FGFSConnection.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
 501   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 502   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 503   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 504   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 505   </TR>
 506 </TABLE>
 507 </TD>
 508 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 509 </EM>
 510 </TD>
 511 </TR>
 512
 513 <TR>
 514 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 515 &nbsp;PREV CLASS&nbsp;
 516 &nbsp;NEXT CLASS</FONT></TD>
 517 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 518   <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
 519 &nbsp;<A HREF="FGFSConnection.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
 520 </TR>
 521 <TR>
 522 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 523   SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 524 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 525 DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 526 </TR>
 527 </TABLE>
 528 <!-- =========== END OF NAVBAR =========== -->
 529
 530 <HR>
 531
 532 </BODY>
 533 </HTML>