org.minetti.astrodevice.common.object
Class ObservingSite

java.lang.Object
  org.minetti.astrodevice.common.coordinate.system.GeographicCoordinates
      org.minetti.astrodevice.common.object.ObservingSite

All Implemented Interfaces:

Serializable, Comparable<ObservingSite>

public class ObservingSite
extends GeographicCoordinates
implements Comparable<ObservingSite>

Object representing an observing site on Earth.

Author:

Jean-Philippe MINETTI

See Also:

Serialized Form

Constructor Summary

	ObservingSite() Constructor.
	ObservingSite(GeographicCoordinates geographicCoordinates) Constructor.
protected	ObservingSite(String name, Coordinate latitude, Coordinate longitude, short elevation, HorizonLimits horizonLimits) Constructor.

Method Summary

int	compareTo(ObservingSite other)
boolean	equals(Object obj)
short	getElevation() Returns the elevation above mean sea level of the geographic position.
HorizonLimits	getHorizonLimits() Returns the limits of horizon for the observing site (never NULL).
Long	getId() Returns the observing site identifier.
Coordinate	getLatitude() Returns the latitude φ of the geographic position.
Coordinate	getLongitude() Returns the longitude λ of the geographic position.
String	getName() Returns the name given to observing site.
int	hashCode()
void	setElevation(short elevation) Sets the elevation above mean sea level of the geographic position.
void	setLatitude(Coordinate latitude) Sets the latitude φ of the geographic position.
void	setLongitude(Coordinate longitude) Sets the longitude λ of the geographic position.
void	setName(String name) Sets the name given to observing site.
String	toString()

Methods inherited from class org.minetti.astrodevice.common.coordinate.system.GeographicCoordinates

getLocalSiderealTime, toEquatorialCoordinates, toHorizontalCoordinates

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ObservingSite

public ObservingSite()

Constructor.

ObservingSite

public ObservingSite(GeographicCoordinates geographicCoordinates)

Constructor.

Parameters:

geographicCoordinates - Geographic position in WGS84 system.

ObservingSite

protected ObservingSite(String name,
                        Coordinate latitude,
                        Coordinate longitude,
                        short elevation,
                        HorizonLimits horizonLimits)

Constructor.

Parameters:

name - Name given to observing site.

latitude - Latitude φ of the geographic position in degrees (°).

longitude - Longitude λ of the geographic position in degrees (°).

elevation - Elevation of the geographic position in meters (m).

horizonLimits - Limits of horizon for the observing site.

Method Detail

getId

public Long getId()

Returns the observing site identifier.

Returns:

Observing site identifier.

getName

public final String getName()

Returns the name given to observing site.

Returns:

Name given to observing site.

setName

public final void setName(String name)

Sets the name given to observing site.

Parameters:

name - New name given to observing site.

getLatitude

public final Coordinate getLatitude()

Description copied from class: GeographicCoordinates

Returns the latitude φ of the geographic position. The range of values is:

• 0 to +90° for north hemisphere,
• 0 to -90° for south hemisphere.

Specified by:

getLatitude in class GeographicCoordinates

Returns:

Latitude φ of the geographic position in degrees (°).

setLatitude

public final void setLatitude(Coordinate latitude)

Sets the latitude φ of the geographic position. The range of values is:

• 0 to +90° for north hemisphere,
• 0 to -90° for south hemisphere.

Parameters:

latitude - New latitude φ of the geographic position in degrees (°).

getLongitude

public final Coordinate getLongitude()

Description copied from class: GeographicCoordinates

Returns the longitude λ of the geographic position. The range of values is:

• 0 to +180° for east meridians,
• 0 to -180° for west meridians.

Specified by:

getLongitude in class GeographicCoordinates

Returns:

Longitude λ of the geographic position in degrees (°).

setLongitude

public final void setLongitude(Coordinate longitude)

Sets the longitude λ of the geographic position. The range of values is:

• 0 to +180° for east meridians,
• 0 to -180° for west meridians.

Parameters:

longitude - New longitude λ of the geographic position in degrees (°).

getElevation

public final short getElevation()

Description copied from class: GeographicCoordinates

Returns the elevation above mean sea level of the geographic position.

Specified by:

getElevation in class GeographicCoordinates

Returns:

Elevation of the geographic position in meters (m).

setElevation

public final void setElevation(short elevation)

Sets the elevation above mean sea level of the geographic position.

Parameters:

elevation - New elevation of the geographic position in meters (m).

getHorizonLimits

public final HorizonLimits getHorizonLimits()

Returns the limits of horizon for the observing site (never NULL).

Returns:

Limits of horizon for the observing site.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public final int compareTo(ObservingSite other)

Specified by:

compareTo in interface Comparable<ObservingSite>

toString

public final String toString()

Overrides:

toString in class GeographicCoordinates