001: /*
002: * GeoTools - OpenSource mapping toolkit
003: * http://geotools.org
004: * (C) 2005-2006, GeoTools Project Managment Committee (PMC)
005: *
006: * This library is free software; you can redistribute it and/or
007: * modify it under the terms of the GNU Lesser General Public
008: * License as published by the Free Software Foundation;
009: * version 2.1 of the License.
010: *
011: * This library is distributed in the hope that it will be useful,
012: * but WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * Lesser General Public License for more details.
015: */
016: package org.geotools.openoffice;
017:
018: // OpenOffice dependencies
019: import com.sun.star.uno.XInterface;
020: import com.sun.star.beans.XPropertySet;
021:
022: /**
023: * Services from the {@link org.geotools.nature} package to be exported to
024: * <A HREF="http://www.openoffice.org">OpenOffice</A>.
025: *
026: * This interface is derived from the {@code XNature.idl} file using the {@code javamaker}
027: * tool provided in OpenOffice SDK, and disassembling the output using the {@code javap} tool
028: * provided in Java SDK. This source file exists mostly for javadoc purpose and in order to keep
029: * IDE happy. The {@code .class} file compiled from this source file <strong>MUST</strong> be
030: * overwritten by the {@code .class} file generated by {@code javamaker}.
031: *
032: * @since 2.2
033: * @source $URL: http://svn.geotools.org/geotools/tags/2.4.1/modules/extension/openoffice/src/main/java/org/geotools/openoffice/XNature.java $
034: * @version $Id: XNature.java 20771 2006-07-31 12:52:44Z jgarnett $
035: * @author Martin Desruisseaux
036: */
037: public interface XNature extends XInterface {
038: /**
039: * Returns the noon time (in GMT) when the Sun reach its highest point.
040: *
041: * @param xOptions Provided by OpenOffice.
042: * @param latitude The latitude of observation point, in degrees.
043: * @param longitude The longitude of observation point, in degrees.
044: * @param time The observation date.
045: */
046: double getNoonTime(XPropertySet xOptions, double latitude,
047: double longitude, double time);
048:
049: /**
050: * Returns the Sun's elevation angle in degrees.
051: *
052: * @param xOptions Provided by OpenOffice.
053: * @param latitude The latitude of observation point, in degrees.
054: * @param longitude The longitude of observation point, in degrees.
055: * @param time The observation date and time, in GMT.
056: */
057: double getElevation(XPropertySet xOptions, double latitude,
058: double longitude, double time);
059:
060: /**
061: * Returns the Sun's azimuth in degrees.
062: *
063: * @param xOptions Provided by OpenOffice.
064: * @param latitude The latitude of observation point, in degrees.
065: * @param longitude The longitude of observation point, in degrees.
066: * @param time The observation date and time, in GMT.
067: */
068: double getAzimuth(XPropertySet xOptions, double latitude,
069: double longitude, double time);
070:
071: /**
072: * Returns the tropical year length in days.
073: *
074: * @param xOptions Provided by OpenOffice.
075: * @param time A date that contains the year.
076: */
077: double getTropicalYearLength(XPropertySet xOptions, double time);
078:
079: /**
080: * Returns the synodic month length in days.
081: *
082: * @param xOptions Provided by OpenOffice.
083: * @param time A date that contains the month.
084: */
085: double getSynodicMonthLength(XPropertySet xOptions, double time);
086:
087: /**
088: * Computes sea water density as a function of salinity, temperature and pressure.
089: *
090: * @param salinity Salinity PSS-78 (0 to 42).
091: * @param temperature Temperature ITS-68 (-2 to 40°C).
092: * @param pressure Pressure in decibars (0 to 10<sup>5</sup> dbar),
093: * not including atmospheric pressure.
094: * @return Density (kg/m³).
095: */
096: double getSeaWaterDensity(XPropertySet xOptions, double salinity,
097: double temperature, double pressure);
098:
099: /**
100: * Computes the fusion temperature (melting point) as a function of salinity and pressure.
101: *
102: * @param salinity Salinity PSS-78.
103: * @param pressure Pressure in decibars, not including atmospheric pressure.
104: */
105: double getSeaWaterMeltingPoint(XPropertySet xOptions,
106: double salinity, double pressure);
107:
108: /**
109: * Computes the sound velocity in sea water as a function of salinity, temperature and pressure.
110: *
111: * @param salinity Salinity PSS-78.
112: * @param temperature Temperature ITS-68.
113: * @param pressure Pressure in decibars, not including atmospheric pressure.
114: */
115: double getSeaWaterSoundVelocity(XPropertySet xOptions,
116: double salinity, double temperature, double pressure);
117:
118: /**
119: * Computes the saturation in disolved oxygen (µmol/kg) as a function of salinity and
120: * temperature.
121: *
122: * @param salinity Salinity PSS-78.
123: * @param temperature Temperature ITS-68.
124: */
125: double getSeaWaterSaturationO2(XPropertySet xOptions,
126: double salinity, double temperature);
127: }
|