Earth (All javadoc for netcdf-java version 4.6.22-SNAPSHOT)

java.lang.Object
- ucar.unidata.geoloc.Earth

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

EarthEllipsoid
```
@Immutable
public class Earth
extends java.lang.Object
implements java.io.Serializable
```
Defines the shape of the earth ellipsoid.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Earth`	`DEFAULT`
`protected double`	`eccentricity`
`protected double`	`eccentricitySquared`
`protected double`	`equatorRadius`
`protected double`	`flattening`
`protected java.lang.String`	`name`
`protected double`	`poleRadius`

Constructor Summary

Constructors
Constructor and Description
`Earth()` Spherical earth with canonical radius.
`Earth(double radius)` Create a spherical earth.
`Earth(double equatorRadius, double poleRadius, double reciprocalFlattening)` Create an ellipsoidal earth.
`Earth(double equatorRadius, double poleRadius, double reciprocalFlattening, java.lang.String name)` Create an ellipsoidal earth with a name.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)`
`double`	`getEccentricity()` Get the Eccentricity property.
`double`	`getEccentricitySquared()` Get the EccentricitySquared property.
`double`	`getEquatorRadius()` Get the EquatorRadius property.
`double`	`getFlattening()` Get the Flattening property.
`double`	`getMajor()` Get the equatorial radius (semimajor axis) of the earth, in meters.
`double`	`getMinor()` Get the polar radius (semiminor axis) of the earth, in meters.
`java.lang.String`	`getName()` Get the Name property.
`double`	`getPoleRadius()` Get the PoleRadius property.
`static double`	`getRadius()` Get canonical radius of spherical earth, in meters
`int`	`hashCode()`
`boolean`	`isSpherical()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT
```
public static final Earth DEFAULT
```
  - eccentricity
```
protected final double eccentricity
```
  - eccentricitySquared
```
protected final double eccentricitySquared
```
  - equatorRadius
```
protected final double equatorRadius
```
  - poleRadius
```
protected final double poleRadius
```
  - flattening
```
protected final double flattening
```
  - name
```
protected final java.lang.String name
```
- Constructor Detail
  - Earth
```
public Earth()
```
    Spherical earth with canonical radius.
  - Earth
```
public Earth(double radius)
```
    Create a spherical earth.
    
    Parameters:
    
    radius - radius of spherical earth.
  - Earth
```
public Earth(double equatorRadius,
             double poleRadius,
             double reciprocalFlattening)
```
    Create an ellipsoidal earth. The reciprocalFlattening is used if not zero, else the poleRadius is used.
    
    Parameters:
    
    equatorRadius - equatorial radius (semimajor axis) in meters, must be specified
    
    poleRadius - polar radius (semiminor axis) in meters
    
    reciprocalFlattening - inverse flattening = 1/flattening = a / (a-b)
  - Earth
```
public Earth(double equatorRadius,
             double poleRadius,
             double reciprocalFlattening,
             java.lang.String name)
```
    Create an ellipsoidal earth with a name.
    
    Parameters:
    
    equatorRadius - equatorial radius (semimajor axis) in meters, must be specified
    
    poleRadius - polar radius (semiminor axis) in meters; if reciprocalFlattening != 0 then this is ignored
    
    reciprocalFlattening - inverse flattening = 1/flattening = a / (a-b); if 0 use the poleRadius to calculate
    
    name - name of the Earth
- Method Detail
  - getRadius
```
public static double getRadius()
```
    Get canonical radius of spherical earth, in meters
    
    Returns:
    
    canonical radius of spherical earth in meters
  - isSpherical
```
public boolean isSpherical()
```
  - getMajor
```
public double getMajor()
```
    Get the equatorial radius (semimajor axis) of the earth, in meters.
    
    Returns:
    
    equatorial radius (semimajor axis) in meters
  - getMinor
```
public double getMinor()
```
    Get the polar radius (semiminor axis) of the earth, in meters.
    
    Returns:
    
    polar radius (semiminor axis) in meters
  - getName
```
public java.lang.String getName()
```
    Get the Name property.
    
    Returns:
    
    The Name
  - getEccentricity
```
public double getEccentricity()
```
    Get the Eccentricity property.
    
    Returns:
    
    The Eccentricity
  - getEccentricitySquared
```
public double getEccentricitySquared()
```
    Get the EccentricitySquared property.
    
    Returns:
    
    The EccentricitySquared
  - getEquatorRadius
```
public double getEquatorRadius()
```
    Get the EquatorRadius property.
    
    Returns:
    
    The EquatorRadius
  - getPoleRadius
```
public double getPoleRadius()
```
    Get the PoleRadius property.
    
    Returns:
    
    The PoleRadius
  - getFlattening
```
public double getFlattening()
```
    Get the Flattening property.
    
    Returns:
    
    The Flattening
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Earth

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT

eccentricity

eccentricitySquared

equatorRadius

poleRadius

flattening

name

Constructor Detail

Earth

Earth

Earth

Earth

Method Detail

getRadius

isSpherical

getMajor

getMinor

getName

getEccentricity

getEccentricitySquared

getEquatorRadius

getPoleRadius

getFlattening

equals

hashCode

toString