|
|
|
|
@@ -0,0 +1,533 @@
|
|
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
|
|
|
|
<!--NewPage-->
|
|
|
|
|
<HTML>
|
|
|
|
|
<HEAD>
|
|
|
|
|
<!-- Generated by javadoc on Sat Jun 08 09:45:47 EDT 2002 -->
|
|
|
|
|
<TITLE>
|
|
|
|
|
: Class FGFSConnection
|
|
|
|
|
</TITLE>
|
|
|
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
|
|
|
|
|
</HEAD>
|
|
|
|
|
<BODY BGCOLOR="white">
|
|
|
|
|
|
|
|
|
|
<!-- ========== START OF NAVBAR ========== -->
|
|
|
|
|
<A NAME="navbar_top"><!-- --></A>
|
|
|
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
|
|
|
|
<TR>
|
|
|
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
|
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
|
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
|
|
|
|
<TR ALIGN="center" VALIGN="top">
|
|
|
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
|
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
|
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FGFSConnection.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
|
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
|
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
|
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
|
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
|
|
|
</TR>
|
|
|
|
|
</TABLE>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
|
|
|
</EM>
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
|
|
|
|
|
<TR>
|
|
|
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
|
|
PREV CLASS
|
|
|
|
|
NEXT CLASS</FONT></TD>
|
|
|
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
|
|
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
|
|
|
|
|
<A HREF="FGFSConnection.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
|
|
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
|
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
|
|
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
|
|
|
</TR>
|
|
|
|
|
</TABLE>
|
|
|
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
|
|
|
|
|
|
|
|
<HR>
|
|
|
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
|
|
|
<H2>
|
|
|
|
|
<FONT SIZE="-1">
|
|
|
|
|
org.flightgear.fgfsclient</FONT>
|
|
|
|
|
<BR>
|
|
|
|
|
Class FGFSConnection</H2>
|
|
|
|
|
<PRE>
|
|
|
|
|
<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/Object.html">java.lang.Object</A>
|
|
|
|
|
|
|
|
|
|
|
+--<B>org.flightgear.fgfsclient.FGFSConnection</B>
|
|
|
|
|
</PRE>
|
|
|
|
|
<HR>
|
|
|
|
|
<DL>
|
|
|
|
|
<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>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
A connection to a running instance of FlightGear.
|
|
|
|
|
|
|
|
|
|
<p>This class currently uses the FlightGear telnet interface,
|
|
|
|
|
though it may be modified to use a different TCP/IP interface in
|
|
|
|
|
the future. Client applications can use this library to examine
|
|
|
|
|
and modify internal FlightGear properties.</p>
|
|
|
|
|
|
|
|
|
|
<p>To start FlightGear with the telnet server activated, use a
|
|
|
|
|
command like this (to listen on port 9000):</p>
|
|
|
|
|
|
|
|
|
|
<blockquote><pre>
|
|
|
|
|
fgfs --telnet=9000
|
|
|
|
|
</pre></blockquote>
|
|
|
|
|
|
|
|
|
|
<p>Then create a connection to FlightGear from your Java client
|
|
|
|
|
application:</p>
|
|
|
|
|
|
|
|
|
|
<blockquote><pre>
|
|
|
|
|
FGFSConnection fgfs = new FGFSConnection("localhost", 9000);
|
|
|
|
|
</pre></blockquote>
|
|
|
|
|
|
|
|
|
|
<p>Now you can use the connection to get and set FlightGear
|
|
|
|
|
properties:</p>
|
|
|
|
|
|
|
|
|
|
<blockquote><pre>
|
|
|
|
|
double altitude = fgfs.getDouble("/position/altitude-ft");
|
|
|
|
|
fgfs.setDouble("/orientation/heading", 270.0);
|
|
|
|
|
</pre></blockquote>
|
|
|
|
|
|
|
|
|
|
<p>All methods that communicate directly with FlightGear are
|
|
|
|
|
synchronized, since they must work over a single telnet
|
|
|
|
|
connection.</p>
|
|
|
|
|
<P>
|
|
|
|
|
<HR>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
<!-- ======== INNER CLASS SUMMARY ======== -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
|
|
|
|
|
|
<A NAME="constructor_summary"><!-- --></A>
|
|
|
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
|
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
|
|
|
<B>Constructor Summary</B></FONT></TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
|
|
<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> host,
|
|
|
|
|
int port)</CODE>
|
|
|
|
|
|
|
|
|
|
<BR>
|
|
|
|
|
Constructor.</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
</TABLE>
|
|
|
|
|
|
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
|
|
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
|
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
|
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
|
|
|
<B>Method Summary</B></FONT></TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
|
|
<CODE> void</CODE></FONT></TD>
|
|
|
|
|
<TD><CODE><B><A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#close()">close</A></B>()</CODE>
|
|
|
|
|
|
|
|
|
|
<BR>
|
|
|
|
|
Close the connection to FlightGear.</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
|
|
<CODE> <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A></CODE></FONT></TD>
|
|
|
|
|
<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> name)</CODE>
|
|
|
|
|
|
|
|
|
|
<BR>
|
|
|
|
|
Get the raw string value for a property.</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
|
|
|
<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> name)</CODE>
|
|
|
|
|
|
|
|
|
|
<BR>
|
|
|
|
|
Get a property value as a boolean.</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
|
|
<CODE> double</CODE></FONT></TD>
|
|
|
|
|
<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> name)</CODE>
|
|
|
|
|
|
|
|
|
|
<BR>
|
|
|
|
|
Get a property value as a double.</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
|
|
<CODE> float</CODE></FONT></TD>
|
|
|
|
|
<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> name)</CODE>
|
|
|
|
|
|
|
|
|
|
<BR>
|
|
|
|
|
Get a property value as a float.</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
|
|
<CODE> int</CODE></FONT></TD>
|
|
|
|
|
<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> name)</CODE>
|
|
|
|
|
|
|
|
|
|
<BR>
|
|
|
|
|
Get a property value as an integer.</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
|
|
<CODE> long</CODE></FONT></TD>
|
|
|
|
|
<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> name)</CODE>
|
|
|
|
|
|
|
|
|
|
<BR>
|
|
|
|
|
Get a property value as a long.</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
|
|
<CODE> void</CODE></FONT></TD>
|
|
|
|
|
<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> name,
|
|
|
|
|
<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> value)</CODE>
|
|
|
|
|
|
|
|
|
|
<BR>
|
|
|
|
|
Set the raw string value for a property.</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
|
|
<CODE> void</CODE></FONT></TD>
|
|
|
|
|
<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> name,
|
|
|
|
|
boolean value)</CODE>
|
|
|
|
|
|
|
|
|
|
<BR>
|
|
|
|
|
Set a property value from a boolean.</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
|
|
<CODE> void</CODE></FONT></TD>
|
|
|
|
|
<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> name,
|
|
|
|
|
double value)</CODE>
|
|
|
|
|
|
|
|
|
|
<BR>
|
|
|
|
|
Set a property value from a double.</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
|
|
<CODE> void</CODE></FONT></TD>
|
|
|
|
|
<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> name,
|
|
|
|
|
float value)</CODE>
|
|
|
|
|
|
|
|
|
|
<BR>
|
|
|
|
|
Set a property value from a float.</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
|
|
<CODE> void</CODE></FONT></TD>
|
|
|
|
|
<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> name,
|
|
|
|
|
int value)</CODE>
|
|
|
|
|
|
|
|
|
|
<BR>
|
|
|
|
|
Set a property value from an int.</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
|
|
<CODE> void</CODE></FONT></TD>
|
|
|
|
|
<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> name,
|
|
|
|
|
long value)</CODE>
|
|
|
|
|
|
|
|
|
|
<BR>
|
|
|
|
|
Set a property value from a long.</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
</TABLE>
|
|
|
|
|
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
|
|
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
|
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
|
|
|
<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>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
|
|
<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>
|
|
|
|
|
</TR>
|
|
|
|
|
</TABLE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
|
|
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
|
|
|
|
|
|
|
<A NAME="constructor_detail"><!-- --></A>
|
|
|
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
|
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
|
|
<TD COLSPAN=1><FONT SIZE="+2">
|
|
|
|
|
<B>Constructor Detail</B></FONT></TD>
|
|
|
|
|
</TR>
|
|
|
|
|
</TABLE>
|
|
|
|
|
|
|
|
|
|
<A NAME="FGFSConnection(java.lang.String, int)"><!-- --></A><H3>
|
|
|
|
|
FGFSConnection</H3>
|
|
|
|
|
<PRE>
|
|
|
|
|
public <B>FGFSConnection</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> host,
|
|
|
|
|
int port)
|
|
|
|
|
throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
|
|
|
|
|
<DL>
|
|
|
|
|
<DD>Constructor.
|
|
|
|
|
|
|
|
|
|
<p>Create a new connection to a running FlightGear program.
|
|
|
|
|
The program must have been started with the --telnet=<port>
|
|
|
|
|
command-line option.</p><DD><DL>
|
|
|
|
|
<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
|
|
|
|
|
a FlightGear process.</DL>
|
|
|
|
|
</DD>
|
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
|
|
|
|
|
|
|
|
<A NAME="method_detail"><!-- --></A>
|
|
|
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
|
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
|
|
<TD COLSPAN=1><FONT SIZE="+2">
|
|
|
|
|
<B>Method Detail</B></FONT></TD>
|
|
|
|
|
</TR>
|
|
|
|
|
</TABLE>
|
|
|
|
|
|
|
|
|
|
<A NAME="close()"><!-- --></A><H3>
|
|
|
|
|
close</H3>
|
|
|
|
|
<PRE>
|
|
|
|
|
public void <B>close</B>()
|
|
|
|
|
throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
|
|
|
|
|
<DL>
|
|
|
|
|
<DD>Close the connection to FlightGear.
|
|
|
|
|
|
|
|
|
|
<p>The client application should always invoke this method when
|
|
|
|
|
it has finished with a connection, to allow cleanup.</p><DD><DL>
|
|
|
|
|
<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
|
|
|
|
|
connection.</DL>
|
|
|
|
|
</DD>
|
|
|
|
|
</DL>
|
|
|
|
|
<HR>
|
|
|
|
|
|
|
|
|
|
<A NAME="get(java.lang.String)"><!-- --></A><H3>
|
|
|
|
|
get</H3>
|
|
|
|
|
<PRE>
|
|
|
|
|
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> name)
|
|
|
|
|
throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
|
|
|
|
|
<DL>
|
|
|
|
|
<DD>Get the raw string value for a property.
|
|
|
|
|
|
|
|
|
|
<p>This is the primitive method for all property lookup;
|
|
|
|
|
everything comes in as a string, and is only later converted by
|
|
|
|
|
methods like <A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#getDouble(java.lang.String)"><CODE>getDouble(String)</CODE></A>. As a result, if you
|
|
|
|
|
need the value as a string anyway, it makes sense to use this
|
|
|
|
|
method directly rather than forcing extra conversions.</p><DD><DL>
|
|
|
|
|
<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
|
|
|
|
|
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
|
|
|
|
|
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>,
|
|
|
|
|
<A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#getInt(java.lang.String)"><CODE>getInt(String)</CODE></A>,
|
|
|
|
|
<A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#getLong(java.lang.String)"><CODE>getLong(String)</CODE></A>,
|
|
|
|
|
<A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#getFloat(java.lang.String)"><CODE>getFloat(String)</CODE></A>,
|
|
|
|
|
<A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#getDouble(java.lang.String)"><CODE>getDouble(String)</CODE></A></DL>
|
|
|
|
|
</DD>
|
|
|
|
|
</DL>
|
|
|
|
|
<HR>
|
|
|
|
|
|
|
|
|
|
<A NAME="set(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|
|
|
|
set</H3>
|
|
|
|
|
<PRE>
|
|
|
|
|
public void <B>set</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name,
|
|
|
|
|
<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> value)
|
|
|
|
|
throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
|
|
|
|
|
<DL>
|
|
|
|
|
<DD>Set the raw string value for a property.
|
|
|
|
|
|
|
|
|
|
<p>This is the primitive method for all property modification;
|
|
|
|
|
everything goes out as a string, after it has been converted by
|
|
|
|
|
methods like <A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#setDouble(java.lang.String, double)"><CODE>setDouble(String,double)</CODE></A>. As a result, if
|
|
|
|
|
you have the value as a string already, it makes sense to use
|
|
|
|
|
this method directly rather than forcing extra conversions.</p><DD><DL>
|
|
|
|
|
<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
|
|
|
|
|
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>,
|
|
|
|
|
<A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#setInt(java.lang.String, int)"><CODE>setInt(String,int)</CODE></A>,
|
|
|
|
|
<A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#setLong(java.lang.String, long)"><CODE>setLong(String,long)</CODE></A>,
|
|
|
|
|
<A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#setFloat(java.lang.String, float)"><CODE>setFloat(String,float)</CODE></A>,
|
|
|
|
|
<A HREF="../../../org/flightgear/fgfsclient/FGFSConnection.html#setDouble(java.lang.String, double)"><CODE>setDouble(String,double)</CODE></A></DL>
|
|
|
|
|
</DD>
|
|
|
|
|
</DL>
|
|
|
|
|
<HR>
|
|
|
|
|
|
|
|
|
|
<A NAME="getBoolean(java.lang.String)"><!-- --></A><H3>
|
|
|
|
|
getBoolean</H3>
|
|
|
|
|
<PRE>
|
|
|
|
|
public boolean <B>getBoolean</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name)
|
|
|
|
|
throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
|
|
|
|
|
<DL>
|
|
|
|
|
<DD>Get a property value as a boolean.<DD><DL>
|
|
|
|
|
<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>
|
|
|
|
|
</DD>
|
|
|
|
|
</DL>
|
|
|
|
|
<HR>
|
|
|
|
|
|
|
|
|
|
<A NAME="getInt(java.lang.String)"><!-- --></A><H3>
|
|
|
|
|
getInt</H3>
|
|
|
|
|
<PRE>
|
|
|
|
|
public int <B>getInt</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name)
|
|
|
|
|
throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
|
|
|
|
|
<DL>
|
|
|
|
|
<DD>Get a property value as an integer.<DD><DL>
|
|
|
|
|
<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>
|
|
|
|
|
</DD>
|
|
|
|
|
</DL>
|
|
|
|
|
<HR>
|
|
|
|
|
|
|
|
|
|
<A NAME="getLong(java.lang.String)"><!-- --></A><H3>
|
|
|
|
|
getLong</H3>
|
|
|
|
|
<PRE>
|
|
|
|
|
public long <B>getLong</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name)
|
|
|
|
|
throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
|
|
|
|
|
<DL>
|
|
|
|
|
<DD>Get a property value as a long.<DD><DL>
|
|
|
|
|
<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>
|
|
|
|
|
</DD>
|
|
|
|
|
</DL>
|
|
|
|
|
<HR>
|
|
|
|
|
|
|
|
|
|
<A NAME="getFloat(java.lang.String)"><!-- --></A><H3>
|
|
|
|
|
getFloat</H3>
|
|
|
|
|
<PRE>
|
|
|
|
|
public float <B>getFloat</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name)
|
|
|
|
|
throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
|
|
|
|
|
<DL>
|
|
|
|
|
<DD>Get a property value as a float.<DD><DL>
|
|
|
|
|
<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>
|
|
|
|
|
</DD>
|
|
|
|
|
</DL>
|
|
|
|
|
<HR>
|
|
|
|
|
|
|
|
|
|
<A NAME="getDouble(java.lang.String)"><!-- --></A><H3>
|
|
|
|
|
getDouble</H3>
|
|
|
|
|
<PRE>
|
|
|
|
|
public double <B>getDouble</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name)
|
|
|
|
|
throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
|
|
|
|
|
<DL>
|
|
|
|
|
<DD>Get a property value as a double.<DD><DL>
|
|
|
|
|
<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>
|
|
|
|
|
</DD>
|
|
|
|
|
</DL>
|
|
|
|
|
<HR>
|
|
|
|
|
|
|
|
|
|
<A NAME="setBoolean(java.lang.String, boolean)"><!-- --></A><H3>
|
|
|
|
|
setBoolean</H3>
|
|
|
|
|
<PRE>
|
|
|
|
|
public void <B>setBoolean</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name,
|
|
|
|
|
boolean value)
|
|
|
|
|
throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
|
|
|
|
|
<DL>
|
|
|
|
|
<DD>Set a property value from a boolean.<DD><DL>
|
|
|
|
|
<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>
|
|
|
|
|
</DD>
|
|
|
|
|
</DL>
|
|
|
|
|
<HR>
|
|
|
|
|
|
|
|
|
|
<A NAME="setInt(java.lang.String, int)"><!-- --></A><H3>
|
|
|
|
|
setInt</H3>
|
|
|
|
|
<PRE>
|
|
|
|
|
public void <B>setInt</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name,
|
|
|
|
|
int value)
|
|
|
|
|
throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
|
|
|
|
|
<DL>
|
|
|
|
|
<DD>Set a property value from an int.<DD><DL>
|
|
|
|
|
<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>
|
|
|
|
|
</DD>
|
|
|
|
|
</DL>
|
|
|
|
|
<HR>
|
|
|
|
|
|
|
|
|
|
<A NAME="setLong(java.lang.String, long)"><!-- --></A><H3>
|
|
|
|
|
setLong</H3>
|
|
|
|
|
<PRE>
|
|
|
|
|
public void <B>setLong</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name,
|
|
|
|
|
long value)
|
|
|
|
|
throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
|
|
|
|
|
<DL>
|
|
|
|
|
<DD>Set a property value from a long.<DD><DL>
|
|
|
|
|
<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>
|
|
|
|
|
</DD>
|
|
|
|
|
</DL>
|
|
|
|
|
<HR>
|
|
|
|
|
|
|
|
|
|
<A NAME="setFloat(java.lang.String, float)"><!-- --></A><H3>
|
|
|
|
|
setFloat</H3>
|
|
|
|
|
<PRE>
|
|
|
|
|
public void <B>setFloat</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name,
|
|
|
|
|
float value)
|
|
|
|
|
throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
|
|
|
|
|
<DL>
|
|
|
|
|
<DD>Set a property value from a float.<DD><DL>
|
|
|
|
|
<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>
|
|
|
|
|
</DD>
|
|
|
|
|
</DL>
|
|
|
|
|
<HR>
|
|
|
|
|
|
|
|
|
|
<A NAME="setDouble(java.lang.String, double)"><!-- --></A><H3>
|
|
|
|
|
setDouble</H3>
|
|
|
|
|
<PRE>
|
|
|
|
|
public void <B>setDouble</B>(<A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/lang/String.html">String</A> name,
|
|
|
|
|
double value)
|
|
|
|
|
throws <A HREF="http://java.sun.com/products/jdk/1.3/docs/api/java/io/IOException.html">IOException</A></PRE>
|
|
|
|
|
<DL>
|
|
|
|
|
<DD>Set a property value from a double.<DD><DL>
|
|
|
|
|
<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>
|
|
|
|
|
</DD>
|
|
|
|
|
</DL>
|
|
|
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
|
|
|
<HR>
|
|
|
|
|
|
|
|
|
|
<!-- ========== START OF NAVBAR ========== -->
|
|
|
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
|
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
|
|
|
|
<TR>
|
|
|
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
|
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
|
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
|
|
|
|
<TR ALIGN="center" VALIGN="top">
|
|
|
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
|
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
|
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/FGFSConnection.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
|
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
|
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
|
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
|
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
|
|
|
</TR>
|
|
|
|
|
</TABLE>
|
|
|
|
|
</TD>
|
|
|
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
|
|
|
</EM>
|
|
|
|
|
</TD>
|
|
|
|
|
</TR>
|
|
|
|
|
|
|
|
|
|
<TR>
|
|
|
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
|
|
PREV CLASS
|
|
|
|
|
NEXT CLASS</FONT></TD>
|
|
|
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
|
|
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
|
|
|
|
|
<A HREF="FGFSConnection.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
|
|
|
|
</TR>
|
|
|
|
|
<TR>
|
|
|
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
|
|
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
|
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
|
|
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
|
|
|
</TR>
|
|
|
|
|
</TABLE>
|
|
|
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
|
|
|
|
|
|
|
|
<HR>
|
|
|
|
|
|
|
|
|
|
</BODY>
|
|
|
|
|
</HTML>
|
Your Name