latorlongitude.html

gps lpws0[1].6.0Javadoc.zip

<!-- ========= 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="LatOrLongitude()"><!-- --></A><H3>
LatOrLongitude</H3>
<PRE>
public <B>LatOrLongitude</B>()</PRE>
<DL>
</DL>
<HR>

<A NAME="LatOrLongitude(java.lang.String)"><!-- --></A><H3>
LatOrLongitude</H3>
<PRE>
public <B>LatOrLongitude</B>(java.lang.String&nbsp;input)
               throws java.lang.NumberFormatException,
                      java.lang.StringIndexOutOfBoundsException</PRE>
<DL>
<DD>This contstructor allows us to create an object from a String
 that may obtained from a NMEA sentence for example.
 It assumes that the format of the data is
 EDDMM.MM or WDDMM.MM or NDDMM.MM or SDDMM.MM or -DDMM.MM
 or DDMM.MM where + is assumed.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>input</CODE> - A string representation of the measurement</DL>
</DD>
</DL>
<HR>

<A NAME="LatOrLongitude(int, int, double)"><!-- --></A><H3>
LatOrLongitude</H3>
<PRE>
public <B>LatOrLongitude</B>(int&nbsp;degs,
                      int&nbsp;mins,
                      double&nbsp;secs)
               throws java.lang.NumberFormatException</PRE>
<DL>
<DD>This constructor allows us to create an object using three
 arguments; one for degrees, one for minutes and the last for
 seconds.  The final argument is a double so that we are not
 limited to just six figures for our position. This method is
 clearly similar to other constructors, but particularly aids
 those using the DDMMSS.SS format.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>degrees</CODE> - The degrees 'element' of the measurement<DD><CODE>mintues</CODE> - The minutes 'element' of the measurement<DD><CODE>seconds</CODE> - The seconds 'element' of the measurement</DL>
</DD>
</DL>
<HR>

<A NAME="LatOrLongitude(int, double)"><!-- --></A><H3>
LatOrLongitude</H3>
<PRE>
public <B>LatOrLongitude</B>(int&nbsp;degs,
                      double&nbsp;mins)
               throws java.lang.NumberFormatException</PRE>
<DL>
<DD>This constructor allows us to create an object using two
 arguments; one for degrees, one for minutes.  The final argument
 is a double so that we are not limited to just four figures for
 our position. This method is similar to other constructors,
 but aids those using the DDMM.MM format.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>degrees</CODE> - The degrees 'element' of the measurement<DD><CODE>mintues</CODE> - The minutes 'element' of the measurement</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="setLatDecimalDegrees(java.lang.String)"><!-- --></A><H3>
setLatDecimalDegrees</H3>
<PRE>
public void <B>setLatDecimalDegrees</B>(java.lang.String&nbsp;decDegsLat)</PRE>
<DL>
<DD>Set LatOrLongitude object based on a String<DD><DL>
<DT><B>Parameters:</B><DD><CODE>decDegsLat</CODE> - latitude expressed in format "NDD.dddd" or "SDD.dddd". N means North, S means South. dddd may be any number of decimals</DL>
</DD>
</DL>
<HR>

<A NAME="setLonDecimalDegrees(java.lang.String)"><!-- --></A><H3>
setLonDecimalDegrees</H3>
<PRE>
public void <B>setLonDecimalDegrees</B>(java.lang.String&nbsp;decDegsLon)</PRE>
<DL>
<DD>Set LatOrLongitude object based on a String<DD><DL>
<DT><B>Parameters:</B><DD><CODE>decDegsLon</CODE> - longitude expressed in format "EDD.dddd" or "WDD.dddd". E means East, W means West. dddd may be any number of decimals</DL>
</DD>
</DL>
<HR>

<A NAME="toStringDDMM()"><!-- --></A><H3>
toStringDDMM</H3>
<PRE>
public java.lang.String <B>toStringDDMM</B>()</PRE>
<DL>
<DD>This method outputs the measurement in the DDMM.MM format<DD><DL>
<DT><B>Returns:</B><DD>The measurement of latitude/longitude as a String</DL>
</DD>
</DL>
<HR>

<A NAME="toStringDDMMSS()"><!-- --></A><H3>
toStringDDMMSS</H3>
<PRE>
public java.lang.String <B>toStringDDMMSS</B>()</PRE>
<DL>
<DD>This method outputs the measurement in the DDMMSS.SS format<DD><DL>
<DT><B>Returns:</B><DD>The measurement of latitude/longitude as a String</DL>
</DD>
</DL>
<HR>

<A NAME="getDegrees()"><!-- --></A><H3>
getDegrees</H3>
<PRE>
public double <B>getDegrees</B>()</PRE>
<DL>
<DD>This method returns the number of degrees in this LatOrLongitude object.
 Note this is not an integer value because it includes the minutes and
 seconds values within the returned value.  Casting the value to an int
 will give only the number of degrees.<DD><DL>
<DT><B>Returns:</B><DD>The degrees in this object/measurement</DL>
</DD>
</DL>
<HR>

<A NAME="getMinutes()"><!-- --></A><H3>
getMinutes</H3>
<PRE>
public double <B>getMinutes</B>()</PRE>
<DL>
<DD>This method returns the number of minutes in this LatOrLongitude object.
 Note as I assume the DDMM.MM format this returns a double, not an int.  If
 you are using the DDMMSS.SS format simply cast the result of this method
 to an int, this will be the minutes 'element' you require.<DD><DL>
<DT><B>Returns:</B><DD>The minutes in this object/measurement</DL>
</DD>
</DL>
<HR>

<A NAME="getSeconds()"><!-- --></A><H3>
getSeconds</H3>
<PRE>
public double <B>getSeconds</B>()</PRE>
<DL>
<DD>This method returns the number of degrees in this LatOrLongitude object.
 It is provided for users of the DDMMSS.SS format.<DD><DL>
<DT><B>Returns:</B><DD>The seconds in this object/measurement</DL>
</DD>
</DL>
<HR>

<A NAME="equals(com.farcrown.lpws.lu.LatOrLongitude)"><!-- --></A><H3>
equals</H3>
<PRE>
public boolean <B>equals</B>(<A HREF="../../../../com/farcrown/lpws/lu/LatOrLongitude.html">LatOrLongitude</A>&nbsp;obj)</PRE>
<DL>
<DD>A method to test whether two LatOrLong objects are equal.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - The object which this will compared to.<DT><B>Returns:</B><DD>Whether the two objects are equal</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="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../com/farcrown/lpws/lu/LocationConverter.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="LatOrLongitude.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>

</BODY>
</HTML>