/*
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *  
 *  Copyright (C) 2000 - 2005 Liam Girdwood  
 */

#ifndef _LN_MERCURY_H
#define _LN_MERCURY_H

#include <libnova/ln_types.h>

#ifdef __cplusplus
extern "C" {
#endif

/*! \defgroup mercury Mercury
*
* Functions relating to the planet Mercury.
*
* All angles are expressed in degrees.
*/

/*! \fn double ln_get_mercury_sdiam(double JD)
* \brief Calculate the semidiameter of Mercury in arc seconds.
* \ingroup mercury
*/
double LIBNOVA_EXPORT ln_get_mercury_sdiam(double JD);

/*! \fn double ln_get_mercury_rst(double JD, struct ln_lnlat_posn *observer, struct ln_rst_time *rst);
* \brief Calculate the time of rise, set and transit for Mercury.
* \ingroup mercury
*/
int LIBNOVA_EXPORT ln_get_mercury_rst(double JD,
	struct ln_lnlat_posn *observer, struct ln_rst_time *rst);

/*! \fn void ln_get_mercury_helio_coords(double JD, struct ln_helio_posn *position);
* \brief Calculate Mercury's heliocentric coordinates
* \ingroup mercury
*/ 
/* Chapter 31 Pg 206-207 Equ 31.1 31.2 , 31.3 using VSOP 87 */
void LIBNOVA_EXPORT ln_get_mercury_helio_coords(double JD,
	struct ln_helio_posn *position);

/*! \fn void ln_get_mercury_equ_coords(double JD, struct ln_equ_posn *position);
* \brief Calculate Mercury's equatorial coordinates
* \ingroup mercury
*/ 
/* Chapter 31 Pg 206-207 Equ 31.1 31.2 , 31.3 using VSOP 87 */
void LIBNOVA_EXPORT ln_get_mercury_equ_coords(double JD,
	struct ln_equ_posn *position);

/*! \fn double ln_get_mercury_earth_dist(double JD);
* \brief Calculate the distance between Mercury and the Earth.
* \ingroup mercury
* \return Distance in AU
*/ 
/* Chapter ?? */
double LIBNOVA_EXPORT ln_get_mercury_earth_dist(double JD);
	
/*! \fn double ln_get_mercury_solar_dist(double JD);
* \brief Calculate the distance between Mercury and the Sun in AU
* \ingroup mercury
* \return Distance in AU
*/ 
/* Chapter ?? */
double LIBNOVA_EXPORT ln_get_mercury_solar_dist(double JD);
	
/*! \fn double ln_get_mercury_magnitude(double JD);
* \brief Calculate the visible magnitude of Mercury
* \ingroup mercury
* \return Visible magnitude of Mercury
*/ 
/* Chapter ?? */
double LIBNOVA_EXPORT ln_get_mercury_magnitude(double JD);	
	
/*! \fn double ln_get_mercury_disk(double JD);
* \brief Calculate the illuminated fraction of Mercury's disk
* \ingroup mercury
* \return Illuminated fraction of mercurys disk
*/ 
/* Chapter 41 */
double LIBNOVA_EXPORT ln_get_mercury_disk(double JD);

/*! \fn double ln_get_mercury_phase(double JD);
* \brief Calculate the phase angle of Mercury (Sun - Mercury - Earth)
* \ingroup mercury
* \return Phase angle of Mercury (degrees)
*/ 
/* Chapter 41 */
double LIBNOVA_EXPORT ln_get_mercury_phase(double JD);


/*! \fn void ln_get_mercury_rect_helio(double JD, struct ln_rect_posn *position)
* \ingroup mercury
* \brief Calculate Mercurys rectangular heliocentric coordinates.
*/
void LIBNOVA_EXPORT ln_get_mercury_rect_helio(double JD,
	struct ln_rect_posn *position);

#ifdef __cplusplus
};
#endif

#endif
