<!-- 

     This document is part of the Geodetic Data Manipulation System
     distribution, and is covered by the GNU GPL, a copy of which is in the
     file named COPYING inside the distribution.

     This program and it's documentation are distributed in the hope that 
     they will be useful,but WITHOUT ANY WARRANTY; without even the implied 
     warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
-->

<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN">

<refentry id="cepInterpShowRate">
<refmeta>
<refentrytitle>cepInterpShowRate</refentrytitle>
<manvolnum>3</manvolnum>
</refmeta>

<refnamediv>
<refname>cepInterpShowRate</refname>
<refpurpose>Displays the "Specify Sample Rate" dialog box for the Interpolation user interface</refpurpose>
</refnamediv>

<refsynopsisdiv>
<synopsis>
 The follwing is an example of how to create this object.
 
 cepInterpShowRate sr(val, units);
 
 &lt;para&gt;&lt;itemizedlist&gt;
 &lt;listitem&gt;&lt;para&gt;val:- the default sample rate&lt;/para&gt;&lt;/listitem&gt;
 &lt;listitem&gt;&lt;para&gt;units:- the units, must be one of 1 (years), 12 (months) or 365.25 (days)&lt;/para&gt;&lt;/listitem&gt;
 &lt;/itemizedlist&gt;&lt;/para&gt;
 

</synopsis>
</refsynopsisdiv>

<refsect1>
<title>DESCRIPTION</title>
<para> 
 An implementation of the &lt;command&gt;cepInterpShowRate&lt;/command&gt; class
 which displays a custom wxWindows dialog box.
 &lt;/para&gt;
 
 &lt;para&gt;
 &lt;command&gt;double getSample()&lt;/command&gt;
 Returns the specified sample rate. If a value of -1 is returned this operation
 has been canceled.
 &lt;/para&gt;
 
 &lt;para&gt;units getSampleUnits()&lt;/command&gt;
 Returns the units selected. Units can be one of:-
 &lt;para&gt;&lt;itemizedlist&gt;
 &lt;listitem&gt;&lt;para&gt;1 (years)&lt;/para&gt;&lt;/listitem&gt;
 &lt;listitem&gt;&lt;para&gt;12 (months)&lt;/para&gt;&lt;/listitem&gt;
 &lt;listitem&gt;&lt;para&gt;365.25 (days)&lt;/para&gt;&lt;/listitem&gt;
 &lt;/itemizedlist&gt;&lt;/para&gt;
 
</para>
</refsect1>


<refsect1>
    <title>VERSION</title>
    <para>
This documentation was generated for the <command>Geodetic Data Manipulation System</command> 0.1 by <command>autodocbook</command> (http://www.stillhq.com).
    </para>
</refsect1>

<refsect1>
    <title>AUTHOR</title>
    <para>
The <command>Geodetic Data Manipulation System</command> is under development by Michael Still (mikal@stillhq.com), Daniel Fernandez, Kristy Van Der Vlist, Blake Swadling, and Nick Wheatstone. All code is Copyright 2002 Michael Still, Daniel Fernandez, Kristy Van Der Vlist, Blake Swadling and Nick Wheatstone,  and is released under the GNU GPL. Code submissions are welcomed. Contact Michael at the address above if you have something you would like to contribute.
</para>
</refsect1>

<refsect1>
    <title>BUGS</title>
    <para>
There  are no known bugs in the <command>Geodetic Data Manipulation System</command>. If you find one, please contact mikal@stillhq.com and let me know.
</para>
</refsect1>
</refentry>
