Ellipse (lib-openssrf-3.1.0 1.0.0 API)

java.lang.Object
- us.gov.dod.standard.ssrf._3_1.location.Ellipse

public class Ellipse
extends Object

Ellipse on the horizontal plane, defined by its semi-major and semi-minor axis, and by the orientation (azimuth) of the semi-major axis. This element SHALL NOT be used to describe a satellite orbit.

Element of Location

Example:

 <Ellipse>
   <AltitudeMax  cls="U">20000</AltitudeMax >
   <AltitudeMin  cls="U">3896.45</AltitudeMin >
   <Azimuth  cls="U">357.8</Azimuth >
   <Excluded  cls="U">No</Excluded >
   <idx cls="U">23</idx>
   <Lat  cls="U">394217.12N</Lat >
   <Lon  cls="U">792823.5W</Lon >
   <SemiMajorAxis  cls="U">87.87</SemiMajorAxis >
   <SemiMinorAxis  cls="U">67.89</SemiMinorAxis >
 </Ellipse>

Version:: 3.1.0, 03/30/2015
Author:: Key Bridge LLC

Constructor Summary

Constructors
Constructor and Description

Ellipse()

Constructors
Constructor and Description
`Ellipse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Altitude`	`getAltitudeMax()` Get the minimum or nominal height of the point above the terrain (also known as "above ground level" AGL).
`Altitude`	`getAltitudeMin()` Get the minimum or nominal height of the point above the terrain (also known as "above ground level" AGL)..
`Az`	`getAzimuth()` Get the angle of the semi-major axis in the horizontal plane, measured from true North..
`TString`	`getExcluded()` Get "Yes" to indicate that the shape is to be excluded from the set.
`BigInteger`	`getIdx()` Get a unique integer index for the current ellipse within the geometric shape..
`Lat`	`getLat()` Get the geographical latitude (degrees, minutes, seconds and hemisphere N or S) of the Point or center of the Ellipse.
`Lon`	`getLon()` Get the geographical longitude (degrees, minutes, seconds, and hemisphere E or W) of the Point or center of the Ellipse.
`DistEarth`	`getSemiMajorAxis()` Get the length of the semi-major axis of the ellipse.
`DistEarth`	`getSemiMinorAxis()` Get the length of the semi-minor axis of the ellipse..
`boolean`	`isSet()` Determine if the required fields in this SSRF data type instance are set.
`boolean`	`isSetAltitudeMax()` Determine if the AltitudeMax is configured.
`boolean`	`isSetAltitudeMin()` Determine if the AltitudeMin is configured.
`boolean`	`isSetAzimuth()` Determine if the Azimuth is configured.
`boolean`	`isSetExcluded()` Determine if the Excluded is configured.
`boolean`	`isSetIdx()` Determine if the Idx is configured.
`boolean`	`isSetLat()` Determine if the Lat is configured.
`boolean`	`isSetLon()` Determine if the Lon is configured.
`boolean`	`isSetSemiMajorAxis()` Determine if the SemiMajorAxis is configured.
`boolean`	`isSetSemiMinorAxis()` Determine if the SemiMinorAxis is configured.
`void`	`setAltitudeMax(Altitude value)` Set the minimum or nominal height of the point above the terrain (also known as "above ground level" AGL).
`void`	`setAltitudeMin(Altitude value)` Set the minimum or nominal height of the point above the terrain (also known as "above ground level" AGL)..
`void`	`setAzimuth(Az value)` Set the angle of the semi-major axis in the horizontal plane, measured from true North..
`void`	`setExcluded(TString value)` Set "Yes" to indicate that the shape is to be excluded from the set.
`void`	`setIdx(BigInteger value)` Set a unique integer index for the current ellipse within the geometric shape..
`void`	`setLat(Lat value)` Set the geographical latitude (degrees, minutes, seconds and hemisphere N or S) of the Point or center of the Ellipse.
`void`	`setLon(Lon value)` Set the geographical longitude (degrees, minutes, seconds, and hemisphere E or W) of the Point or center of the Ellipse.
`void`	`setSemiMajorAxis(DistEarth value)` Set the length of the semi-major axis of the ellipse.
`void`	`setSemiMinorAxis(DistEarth value)` Set the length of the semi-minor axis of the ellipse..
`String`	`toString()` Get a string representation of this Ellipse instance configuration.
`Ellipse`	`withAltitudeMax(Double value)` Set the minimum or nominal height of the point above the terrain (also known as "above ground level" AGL).
`Ellipse`	`withAltitudeMin(Double value)` Set the minimum or nominal height of the point above the terrain (also known as "above ground level" AGL).
`Ellipse`	`withAzimuth(Double value)` Set the angle of the semi-major axis in the horizontal plane, measured from true North.
`Ellipse`	`withExcluded(ListCBO value)` Set "Yes" to indicate that the shape is to be excluded from the set.
`Ellipse`	`withIdx(BigInteger value)` Set a unique integer index for the current ellipse within the geometric shape.
`Ellipse`	`withLat(Double value)` Set the geographical latitude in decimal degrees.
`Ellipse`	`withLat(String value)` Set the geographical latitude (degrees, minutes, seconds and hemisphere N or S) of the Point or center of the Ellipse.
`Ellipse`	`withLon(Double value)` Set the geographical longitude in decimal degrees.
`Ellipse`	`withLon(String value)` Set the geographical longitude (degrees, minutes, seconds, and hemisphere E or W) of the Point or center of the Ellipse.
`Ellipse`	`withSemiMajorAxis(Double value)` Set the length of the semi-major axis of the ellipse.
`Ellipse`	`withSemiMinorAxis(Double value)` Set the length of the semi-minor axis of the ellipse.

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

- Constructor Detail
  - Ellipse
```
public Ellipse()
```
- Method Detail
  - getExcluded
```
public TString getExcluded()
```
    Get "Yes" to indicate that the shape is to be excluded from the set. If omitted, a "No" SHOULD be assumed by processing applications, meaning that the shape is included by default..
    
    Returns:
    
    the Excluded value in a TString data type
    
    Since:
    
    3.1.0
  - setExcluded
```
public void setExcluded(TString value)
```
    Set "Yes" to indicate that the shape is to be excluded from the set. If omitted, a "No" SHOULD be assumed by processing applications, meaning that the shape is included by default..
    
    Parameters:
    
    value - the Excluded value in a TString data type
    
    Since:
    
    3.1.0
  - isSetExcluded
```
public boolean isSetExcluded()
```
    Determine if the Excluded is configured.
    If configured this method also inspects the TString wrapped value.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getLon
```
public Lon getLon()
```
    Get the geographical longitude (degrees, minutes, seconds, and hemisphere E or W) of the Point or center of the Ellipse. If the seconds are not known, use 00, except in the case of navigation aid systems, geostationary satellites, and microwave facilities where seconds are required. Use leading zeros as appropriate for degrees, minutes, or seconds. Degrees longitude require three digits. Seconds may have a decimal point followed by up to two decimals. enter E or W immediately following the seconds. The format is: dddmmss.hhH (where ".hh" is optional and H = E or W)..
    
    Returns:
    
    a Lon instance
    
    Since:
    
    3.1.0
  - setLon
```
public void setLon(Lon value)
```
    Set the geographical longitude (degrees, minutes, seconds, and hemisphere E or W) of the Point or center of the Ellipse. If the seconds are not known, use 00, except in the case of navigation aid systems, geostationary satellites, and microwave facilities where seconds are required. Use leading zeros as appropriate for degrees, minutes, or seconds. Degrees longitude require three digits. Seconds may have a decimal point followed by up to two decimals. enter E or W immediately following the seconds. The format is: dddmmss.hhH (where ".hh" is optional and H = E or W)..
    
    Parameters:
    
    value - a Lon instance
    
    Since:
    
    3.1.0
  - isSetLon
```
public boolean isSetLon()
```
    Determine if the Lon is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getLat
```
public Lat getLat()
```
    Get the geographical latitude (degrees, minutes, seconds and hemisphere N or S) of the Point or center of the Ellipse. Same remarks for seconds and leading zeros. enter N or S immediately following the seconds. The format is: ddmmss.hhH (where ".hh" is optional and H = N or S)..
    
    Returns:
    
    a Lat instance
    
    Since:
    
    3.1.0
  - setLat
```
public void setLat(Lat value)
```
    Set the geographical latitude (degrees, minutes, seconds and hemisphere N or S) of the Point or center of the Ellipse. Same remarks for seconds and leading zeros. enter N or S immediately following the seconds. The format is: ddmmss.hhH (where ".hh" is optional and H = N or S)..
    
    Parameters:
    
    value - a Lat instance
    
    Since:
    
    3.1.0
  - isSetLat
```
public boolean isSetLat()
```
    Determine if the Lat is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getSemiMajorAxis
```
public DistEarth getSemiMajorAxis()
```
    Get the length of the semi-major axis of the ellipse.
    [XSL ERR MINMAX] SemiMajorAxis it MUST be greater than or equal to SemiMinorAxis..
    
    Returns:
    
    a DistEarth instance
    
    Since:
    
    3.1.0
  - setSemiMajorAxis
```
public void setSemiMajorAxis(DistEarth value)
```
    Set the length of the semi-major axis of the ellipse.
    [XSL ERR MINMAX] SemiMajorAxis it MUST be greater than or equal to SemiMinorAxis..
    
    Parameters:
    
    value - a DistEarth instance
    
    Since:
    
    3.1.0
  - isSetSemiMajorAxis
```
public boolean isSetSemiMajorAxis()
```
    Determine if the SemiMajorAxis is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getSemiMinorAxis
```
public DistEarth getSemiMinorAxis()
```
    Get the length of the semi-minor axis of the ellipse..
    
    Returns:
    
    a DistEarth instance
    
    Since:
    
    3.1.0
  - setSemiMinorAxis
```
public void setSemiMinorAxis(DistEarth value)
```
    Set the length of the semi-minor axis of the ellipse..
    
    Parameters:
    
    value - a DistEarth instance
    
    Since:
    
    3.1.0
  - isSetSemiMinorAxis
```
public boolean isSetSemiMinorAxis()
```
    Determine if the SemiMinorAxis is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getAzimuth
```
public Az getAzimuth()
```
    Get the angle of the semi-major axis in the horizontal plane, measured from true North..
    
    Returns:
    
    a Az instance
    
    Since:
    
    3.1.0
  - setAzimuth
```
public void setAzimuth(Az value)
```
    Set the angle of the semi-major axis in the horizontal plane, measured from true North..
    
    Parameters:
    
    value - a Az instance
    
    Since:
    
    3.1.0
  - isSetAzimuth
```
public boolean isSetAzimuth()
```
    Determine if the Azimuth is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getAltitudeMin
```
public Altitude getAltitudeMin()
```
    Get the minimum or nominal height of the point above the terrain (also known as "above ground level" AGL)..
    
    Returns:
    
    a Altitude instance
    
    Since:
    
    3.1.0
  - setAltitudeMin
```
public void setAltitudeMin(Altitude value)
```
    Set the minimum or nominal height of the point above the terrain (also known as "above ground level" AGL)..
    
    Parameters:
    
    value - a Altitude instance
    
    Since:
    
    3.1.0
  - isSetAltitudeMin
```
public boolean isSetAltitudeMin()
```
    Determine if the AltitudeMin is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getAltitudeMax
```
public Altitude getAltitudeMax()
```
    Get the minimum or nominal height of the point above the terrain (also known as "above ground level" AGL).
    [XSL ERR MINMAX] If AltitudeMax is used, it MUST be greater than AltitudeMin..
    
    Returns:
    
    a Altitude instance
    
    Since:
    
    3.1.0
  - setAltitudeMax
```
public void setAltitudeMax(Altitude value)
```
    Set the minimum or nominal height of the point above the terrain (also known as "above ground level" AGL).
    [XSL ERR MINMAX] If AltitudeMax is used, it MUST be greater than AltitudeMin..
    
    Parameters:
    
    value - a Altitude instance
    
    Since:
    
    3.1.0
  - isSetAltitudeMax
```
public boolean isSetAltitudeMax()
```
    Determine if the AltitudeMax is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getIdx
```
public BigInteger getIdx()
```
    Get a unique integer index for the current ellipse within the geometric shape..
    
    Returns:
    
    a BigInteger instance
    
    Since:
    
    3.1.0
  - setIdx
```
public void setIdx(BigInteger value)
```
    Set a unique integer index for the current ellipse within the geometric shape..
    
    Parameters:
    
    value - a BigInteger instance
    
    Since:
    
    3.1.0
  - isSetIdx
```
public boolean isSetIdx()
```
    Determine if the Idx is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - withExcluded
```
public Ellipse withExcluded(ListCBO value)
```
    Set "Yes" to indicate that the shape is to be excluded from the set. If omitted, a "No" SHOULD be assumed by processing applications, meaning that the shape is included by default.
    
    Parameters:
    
    value - An instances of type ListCBO.
    
    Returns:
    
    The current Ellipse object instance.
    
    Since:
    
    3.1.0
  - withLon
```
public Ellipse withLon(String value)
                throws Exception
```
    Set the geographical longitude (degrees, minutes, seconds, and hemisphere E or W) of the Point or center of the Ellipse. If the seconds are not known, use 00, except in the case of navigation aid systems, geostationary satellites, and microwave facilities where seconds are required. Use leading zeros as appropriate for degrees, minutes, or seconds. Degrees longitude require three digits. Seconds may have a decimal point followed by up to two decimals. enter E or W immediately following the seconds. The format is: dddmmss.hhH (where ".hh" is optional and H = E or W).
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current Ellipse object instance.
    
    Throws:
    
    Exception
    
    Since:
    
    3.1.0
  - withLon
```
public Ellipse withLon(Double value)
```
    Set the geographical longitude in decimal degrees.
    
    Parameters:
    
    value - The coordinate value in decimal degrees
    
    Returns:
    
    The current Ellipse object instance.
    
    Since:
    
    3.1.0
  - withLat
```
public Ellipse withLat(String value)
                throws Exception
```
    Set the geographical latitude (degrees, minutes, seconds and hemisphere N or S) of the Point or center of the Ellipse. Same remarks for seconds and leading zeros. enter N or S immediately following the seconds. The format is: ddmmss.hhH (where ".hh" is optional and H = N or S).
    
    Parameters:
    
    value - An instances of type String.
    
    Returns:
    
    The current Ellipse object instance.
    
    Throws:
    
    Exception
    
    Since:
    
    3.1.0
  - withLat
```
public Ellipse withLat(Double value)
```
    Set the geographical latitude in decimal degrees.
    
    Parameters:
    
    value - The coordinate value in decimal degrees
    
    Returns:
    
    The current Ellipse object instance.
    
    Since:
    
    3.1.0
  - withSemiMajorAxis
```
public Ellipse withSemiMajorAxis(Double value)
```
    Set the length of the semi-major axis of the ellipse.
    [XSL ERR MINMAX] SemiMajorAxis it MUST be greater than or equal to SemiMinorAxis.
    
    Parameters:
    
    value - An instances of type Double.
    
    Returns:
    
    The current Ellipse object instance.
    
    Since:
    
    3.1.0
  - withSemiMinorAxis
```
public Ellipse withSemiMinorAxis(Double value)
```
    Set the length of the semi-minor axis of the ellipse.
    
    Parameters:
    
    value - An instances of type Double.
    
    Returns:
    
    The current Ellipse object instance.
    
    Since:
    
    3.1.0
  - withAzimuth
```
public Ellipse withAzimuth(Double value)
```
    Set the angle of the semi-major axis in the horizontal plane, measured from true North.
    
    Parameters:
    
    value - An instances of type Double.
    
    Returns:
    
    The current Ellipse object instance.
    
    Since:
    
    3.1.0
  - withAltitudeMin
```
public Ellipse withAltitudeMin(Double value)
```
    Set the minimum or nominal height of the point above the terrain (also known as "above ground level" AGL).
    
    Parameters:
    
    value - An instances of type Double.
    
    Returns:
    
    The current Ellipse object instance.
    
    Since:
    
    3.1.0
  - withAltitudeMax
```
public Ellipse withAltitudeMax(Double value)
```
    Set the minimum or nominal height of the point above the terrain (also known as "above ground level" AGL).
    [XSL ERR MINMAX] If AltitudeMax is used, it MUST be greater than AltitudeMin.
    
    Parameters:
    
    value - An instances of type Double.
    
    Returns:
    
    The current Ellipse object instance.
    
    Since:
    
    3.1.0
  - withIdx
```
public Ellipse withIdx(BigInteger value)
```
    Set a unique integer index for the current ellipse within the geometric shape.
    
    Parameters:
    
    value - An instances of type BigInteger.
    
    Returns:
    
    The current Ellipse object instance.
    
    Since:
    
    3.1.0
  - toString
```
public String toString()
```
    Get a string representation of this Ellipse instance configuration.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    The current object instance configuration as a non-null String
  - isSet
```
public boolean isSet()
```
    Determine if the required fields in this SSRF data type instance are set.
    Ellipse requires Azimuth, Lat, Lon, SemiMajorAxis, SemiMinorAxis, idx.
    Note that this method only checks for the presence of required information; this method does not validate the information format.
    
    Returns:
    
    TRUE if required fields are set, otherwise FALSE

Class Ellipse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Ellipse

Method Detail

getExcluded

setExcluded

isSetExcluded

getLon

setLon

isSetLon

getLat

setLat

isSetLat

getSemiMajorAxis

setSemiMajorAxis

isSetSemiMajorAxis

getSemiMinorAxis

setSemiMinorAxis

isSetSemiMinorAxis

getAzimuth

setAzimuth

isSetAzimuth

getAltitudeMin

setAltitudeMin

isSetAltitudeMin

getAltitudeMax

setAltitudeMax

isSetAltitudeMax

getIdx

setIdx

isSetIdx

withExcluded

withLon

withLon

withLat

withLat

withSemiMajorAxis

withSemiMinorAxis

withAzimuth

withAltitudeMin

withAltitudeMax

withIdx

toString

isSet