us.gov.dod.standard.ssrf._3_1.assignment

Class StationLoc

java.lang.Object

us.gov.dod.standard.ssrf._3_1.assignment.StationLoc

public class StationLoc
extends Object

Station (US) defines one or more transmitters or receivers or a combination of transmitters and receivers, including the accessory

Element of Station

Example:

 <StationLoc>
   <LocationExcluded  cls="U">Yes</LocationExcluded >
   <LocationRadius  cls="U">458</LocationRadius >
   <LocSatRef cls="U">GBR::SA:123</LocSatRef>
   <ServiceVolumeHeight  cls="U">5000</ServiceVolumeHeight >
   <ServiceVolumeLocRef  cls="U">GBR::SA:123</ServiceVolumeLocRef >
   <ServiceVolumeRadius  cls="U">252.65</ServiceVolumeRadius >
 </StationLoc>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
StationLoc()

Method Summary

Modifier and Type	Method and Description
TString	getLocationExcluded() Get "Yes" to indicate that the LocSatRef is to be excluded from the location set for the current station.
DistSpace	getLocationRadius() Get the radius associated with the Location to produce a circle.
Common<?>	getLocSat() Get the serial of a Location or Satellite dataset.
Serial	getLocSatRef() Deprecated. SSRF references are managed automatically. Use getLocSat() instead.
Altitude	getServiceVolumeHeight() Get the altitude of aeronautical navigational aids, air traffic control assignments for radio frequencies above 30 MHz, and low-frequency beacons.
Serial	getServiceVolumeLocRef() Get the reference to a Location for an aeronautical coverage area.
DistEarth	getServiceVolumeRadius() Get the radius associated with the Location to produce a circle.
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetLocationExcluded() Determine if the LocationExcluded is configured.
boolean	isSetLocationRadius() Determine if the LocationRadius is configured.
boolean	isSetLocSat() Determine if the locSat field is configured.
boolean	isSetLocSatRef() Determine if the LocSatRef is configured.
boolean	isSetServiceVolumeHeight() Determine if the ServiceVolumeHeight is configured.
boolean	isSetServiceVolumeLocRef() Determine if the ServiceVolumeLocRef is configured.
boolean	isSetServiceVolumeRadius() Determine if the ServiceVolumeRadius is configured.
void	postLoad(SSRF root) Update the SSRF data type references in this StationLoc record after loading from XML.
void	prepare() Update the SSRF data type references in this StationLoc record.
void	setLocationExcluded(TString value) Set "Yes" to indicate that the LocSatRef is to be excluded from the location set for the current station.
void	setLocationRadius(DistSpace value) Set the radius associated with the Location to produce a circle.
void	setLocSatRef(Serial value) Deprecated. SSRF references are managed automatically. Use #setLocSat(Common) instead.
void	setServiceVolumeHeight(Altitude value) Set the altitude of aeronautical navigational aids, air traffic control assignments for radio frequencies above 30 MHz, and low-frequency beacons.
void	setServiceVolumeLocRef(Serial value) Set the reference to a Location for an aeronautical coverage area.
void	setServiceVolumeRadius(DistEarth value) Set the radius associated with the Location to produce a circle.
String	toString() Get a string representation of this StationLoc instance configuration.
StationLoc	withLocationExcluded(ListCBO value) Set "Yes" to indicate that the LocSatRef is to be excluded from the location set for the current station.
StationLoc	withLocationRadius(Double value) Set the radius associated with the Location to produce a circle.
StationLoc	withLocSat(Common<?> value) Set the serial of a Location or Satellite dataset.
StationLoc	withLocSatRef(Serial value) Deprecated. SSRF references are managed automatically. Use withLocSat(Common) instead.
StationLoc	withServiceVolumeHeight(Double value) Set the altitude of aeronautical navigational aids, air traffic control assignments for radio frequencies above 30 MHz, and low-frequency beacons.
StationLoc	withServiceVolumeLocRef(Serial value) Set the reference to a Location for an aeronautical coverage area.
StationLoc	withServiceVolumeRadius(Double value) Set the radius associated with the Location to produce a circle.

Methods inherited from class java.lang.Object

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

Constructor Detail

StationLoc

public StationLoc()

Method Detail

getLocationExcluded

public TString getLocationExcluded()

Get "Yes" to indicate that the LocSatRef is to be excluded from the location set for the current station. If omitted, "No" is assumed, meaning that the location is included..

Returns:

the LocationExcluded value in a TString data type

Since:

3.1.0

setLocationExcluded

public void setLocationExcluded(TString value)

Set "Yes" to indicate that the LocSatRef is to be excluded from the location set for the current station. If omitted, "No" is assumed, meaning that the location is included..

Parameters:

value - the LocationExcluded value in a TString data type

Since:

3.1.0

isSetLocationExcluded

public boolean isSetLocationExcluded()

Determine if the LocationExcluded 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

getLocSatRef

@Deprecated
public Serial getLocSatRef()

Deprecated. SSRF references are managed automatically. Use getLocSat() instead.

Get the serial of a Location or Satellite dataset. If this location is a complex dataset (more than a single point), tthe assignment is mobile, inside the Station location..

Returns:

a Serial instance

Since:

3.1.0

setLocSatRef

@Deprecated
public void setLocSatRef(Serial value)

Deprecated. SSRF references are managed automatically. Use #setLocSat(Common) instead.

Set the serial of a Location or Satellite dataset. If this location is a complex dataset (more than a single point), tthe assignment is mobile, inside the Station location..

Parameters:

value - a Serial instance

Since:

3.1.0

isSetLocSatRef

public boolean isSetLocSatRef()

Determine if the LocSatRef is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

getLocationRadius

public DistSpace getLocationRadius()

Get the radius associated with the Location to produce a circle. Radius information only applies to points, and should be ignored in the case of polygons and ellipses..

Returns:

a DistSpace instance

Since:

3.1.0

setLocationRadius

public void setLocationRadius(DistSpace value)

Set the radius associated with the Location to produce a circle. Radius information only applies to points, and should be ignored in the case of polygons and ellipses..

Parameters:

value - a DistSpace instance

Since:

3.1.0

isSetLocationRadius

public boolean isSetLocationRadius()

Determine if the LocationRadius is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

getServiceVolumeLocRef

public Serial getServiceVolumeLocRef()

Get the reference to a Location for an aeronautical coverage area. The area can be modified by the fields ServiceVolumeRadius and ServiceValumeHeight. For example, ServiceVolumeLocRef can reference a point location that is extended with a radius and height to form a cylinder..

Returns:

a Serial instance

Since:

3.1.0

setServiceVolumeLocRef

public void setServiceVolumeLocRef(Serial value)

Set the reference to a Location for an aeronautical coverage area. The area can be modified by the fields ServiceVolumeRadius and ServiceValumeHeight. For example, ServiceVolumeLocRef can reference a point location that is extended with a radius and height to form a cylinder..

Parameters:

value - a Serial instance

Since:

3.1.0

isSetServiceVolumeLocRef

public boolean isSetServiceVolumeLocRef()

Determine if the ServiceVolumeLocRef is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

getServiceVolumeRadius

public DistEarth getServiceVolumeRadius()

Get the radius associated with the Location to produce a circle. Radius information only applies to points, and should be ignored in the case of polygons and ellipses..

Returns:

a DistEarth instance

Since:

3.1.0

setServiceVolumeRadius

public void setServiceVolumeRadius(DistEarth value)

Set the radius associated with the Location to produce a circle. Radius information only applies to points, and should be ignored in the case of polygons and ellipses..

Parameters:

value - a DistEarth instance

Since:

3.1.0

isSetServiceVolumeRadius

public boolean isSetServiceVolumeRadius()

Determine if the ServiceVolumeRadius is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

getServiceVolumeHeight

public Altitude getServiceVolumeHeight()

Get the altitude of aeronautical navigational aids, air traffic control assignments for radio frequencies above 30 MHz, and low-frequency beacons. The altitude is referenced to mean sea level (MSL)..

Returns:

a Altitude instance

Since:

3.1.0

setServiceVolumeHeight

public void setServiceVolumeHeight(Altitude value)

Set the altitude of aeronautical navigational aids, air traffic control assignments for radio frequencies above 30 MHz, and low-frequency beacons. The altitude is referenced to mean sea level (MSL)..

Parameters:

value - a Altitude instance

Since:

3.1.0

isSetServiceVolumeHeight

public boolean isSetServiceVolumeHeight()

Determine if the ServiceVolumeHeight is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

withLocationExcluded

public StationLoc withLocationExcluded(ListCBO value)

Set "Yes" to indicate that the LocSatRef is to be excluded from the location set for the current station. If omitted, "No" is assumed, meaning that the location is included.

Parameters:

value - An instances of type ListCBO.

Returns:

The current StationLoc object instance.

Since:

3.1.0

withLocSatRef

@Deprecated
public StationLoc withLocSatRef(Serial value)

Deprecated. SSRF references are managed automatically. Use withLocSat(Common) instead.

Set the serial of a Location or Satellite dataset. If this location is a complex dataset (more than a single point), tthe assignment is mobile, inside the Station location.

Parameters:

value - An instances of type Serial.

Returns:

The current StationLoc object instance.

Since:

3.1.0

withLocationRadius

public StationLoc withLocationRadius(Double value)

Set the radius associated with the Location to produce a circle. Radius information only applies to points, and should be ignored in the case of polygons and ellipses.

Parameters:

value - An instances of type Double.

Returns:

The current StationLoc object instance.

Since:

3.1.0

withServiceVolumeLocRef

public StationLoc withServiceVolumeLocRef(Serial value)

Set the reference to a Location for an aeronautical coverage area. The area can be modified by the fields ServiceVolumeRadius and ServiceValumeHeight. For example, ServiceVolumeLocRef can reference a point location that is extended with a radius and height to form a cylinder.

Parameters:

value - An instances of type Serial.

Returns:

The current StationLoc object instance.

Since:

3.1.0

withServiceVolumeRadius

public StationLoc withServiceVolumeRadius(Double value)

Set the radius associated with the Location to produce a circle. Radius information only applies to points, and should be ignored in the case of polygons and ellipses.

Parameters:

value - An instances of type Double.

Returns:

The current StationLoc object instance.

Since:

3.1.0

withServiceVolumeHeight

public StationLoc withServiceVolumeHeight(Double value)

Set the altitude of aeronautical navigational aids, air traffic control assignments for radio frequencies above 30 MHz, and low-frequency beacons. The altitude is referenced to mean sea level (MSL).

Parameters:

value - An instances of type Double.

Returns:

The current StationLoc object instance.

Since:

3.1.0

toString

public String toString()

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

StationLoc has no configuration requirements.

Returns:

TRUE

getLocSat

public Common<?> getLocSat()

Get the serial of a Location or Satellite dataset. If this location is a complex dataset (more than a single point), tthe assignment is mobile, inside the Station location..

Returns:

a Common instance

Since:

3.1.0

isSetLocSat

public boolean isSetLocSat()

Determine if the locSat field is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

withLocSat

public StationLoc withLocSat(Common<?> value)

Set the serial of a Location or Satellite dataset. If this location is a complex dataset (more than a single point), tthe assignment is mobile, inside the Station location.

Parameters:

value - An instances of type Common.

Returns:

The current StationLoc object instance.

Since:

3.1.0

prepare

public void prepare()

Update the SSRF data type references in this StationLoc record.

This method builds the exported locSatRef field with values from the transient locSat field. This method should typically be called after the StationLoc is configured and (optionally) before exporting an SSRF message.

Since:

3.1.0

postLoad

public void postLoad(SSRF root)

Update the SSRF data type references in this StationLoc record after loading from XML.

This method builds the transient locSat with values from the imported locSatRef field. This method should typically be called after the StationLoc is imported from XML. * @param root the SSRF root instance.

Since:

3.1.0