us.gov.dod.standard.ssrf._3_1.location

Class Point

java.lang.Object

us.gov.dod.standard.ssrf._3_1.location.Point

public class Point
extends Object

Point contains the coordinates (WGS 84) of point(s) that represent a fixed site. It contains also the terrain elevation, in metres above mean sea level (MSL) of this point. If the antenna installed at this point is located on a structure such as a tower or a building, the site elevation is specified as the ground elevation at the base of the structure.

Element of Location

Example:

 <Point idx="1">
   <Lon cls="U">0792823.5W</Lon>
   <Lat cls="U">394217.12N</Lat>
 </Point>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
Point()

Method Summary

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)..
TString	getExcluded() Get "Yes" to indicate that the shape is to be excluded from the set.
BigInteger	getIdx() Get the sequential index of a Point within the referenced Location.
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.
Altitude	getTerrainElevation() Get the elevation of the base of the transmitting antenna structure above Mean Sea Level (MSL)..
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	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	isSetTerrainElevation() Determine if the TerrainElevation 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	setExcluded(TString value) Set "Yes" to indicate that the shape is to be excluded from the set.
void	setIdx(BigInteger value) Set the sequential index of a Point within the referenced Location.
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	setTerrainElevation(Altitude value) Set the elevation of the base of the transmitting antenna structure above Mean Sea Level (MSL)..
String	toString() Get a string representation of this Point instance configuration.
Point	withAltitudeMax(Double value) Set the minimum or nominal height of the point above the terrain (also known as "above ground level" AGL).
Point	withAltitudeMin(Double value) Set the minimum or nominal height of the point above the terrain (also known as "above ground level" AGL).
Point	withExcluded(ListCBO value) Set "Yes" to indicate that the shape is to be excluded from the set.
Point	withIdx(BigInteger value) Set the sequential index of a Point within the referenced Location.
Point	withLat(Double value) Set the geographical latitude in decimal degrees.
Point	withLat(String value) Set the geographical latitude (degrees, minutes, seconds and hemisphere N or S) of the Point or center of the Ellipse.
Point	withLon(Double value) Set the geographical longitude in decimal degrees.
Point	withLon(String value) Set the geographical longitude (degrees, minutes, seconds, and hemisphere E or W) of the Point or center of the Ellipse.
Point	withTerrainElevation(Double value) Set the elevation of the base of the transmitting antenna structure above Mean Sea Level (MSL).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Point

public Point()

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

getTerrainElevation

public Altitude getTerrainElevation()

Get the elevation of the base of the transmitting antenna structure above Mean Sea Level (MSL)..

Returns:

a Altitude instance

Since:

3.1.0

setTerrainElevation

public void setTerrainElevation(Altitude value)

Set the elevation of the base of the transmitting antenna structure above Mean Sea Level (MSL)..

Parameters:

value - a Altitude instance

Since:

3.1.0

isSetTerrainElevation

public boolean isSetTerrainElevation()

Determine if the TerrainElevation 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 the sequential index of a Point within the referenced Location. Some points of the Location may be omitted, and are not necessarily visited in the order they are defined in the Location. For example a Location might have 10 Points; however, a Force Element may use a route passing successively by points 3, 1, 10, and 7..

Returns:

a BigInteger instance

Since:

3.1.0

setIdx

public void setIdx(BigInteger value)

Set the sequential index of a Point within the referenced Location. Some points of the Location may be omitted, and are not necessarily visited in the order they are defined in the Location. For example a Location might have 10 Points; however, a Force Element may use a route passing successively by points 3, 1, 10, and 7..

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 Point 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 Point object instance.

Since:

3.1.0

withLon

public Point 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 Point object instance.

Throws:

Exception

Since:

3.1.0

withLon

public Point withLon(Double value)

Set the geographical longitude in decimal degrees.

Parameters:

value - The coordinate value in decimal degrees

Returns:

The current Point object instance.

Since:

3.1.0

withLat

public Point 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 Point object instance.

Throws:

Exception

Since:

3.1.0

withLat

public Point withLat(Double value)

Set the geographical latitude in decimal degrees.

Parameters:

value - The coordinate value in decimal degrees

Returns:

The current Point object instance.

Since:

3.1.0

withTerrainElevation

public Point withTerrainElevation(Double value)

Set the elevation of the base of the transmitting antenna structure above Mean Sea Level (MSL).

Parameters:

value - An instances of type Double.

Returns:

The current Point object instance.

Since:

3.1.0

withAltitudeMin

public Point 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 Point object instance.

Since:

3.1.0

withAltitudeMax

public Point 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 Point object instance.

Since:

3.1.0

withIdx

public Point withIdx(BigInteger value)

Set the sequential index of a Point within the referenced Location. Some points of the Location may be omitted, and are not necessarily visited in the order they are defined in the Location. For example a Location might have 10 Points; however, a Force Element may use a route passing successively by points 3, 1, 10, and 7.

Parameters:

value - An instances of type BigInteger.

Returns:

The current Point object instance.

Since:

3.1.0

toString

public String toString()

Get a string representation of this Point 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.

Point requires Lat, Lon, 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