us.gov.dod.standard.ssrf._3_1.ssrequest

Class EndpointLocation

java.lang.Object

us.gov.dod.standard.ssrf._3_1.ssrequest.EndpointLocation

public class EndpointLocation
extends Object

EndpointLocation defines locations where the diagram endpoint is allowed or forbidden from use.

Element of DiagramEndpoint

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
EndpointLocation()

Method Summary

Modifier and Type	Method and Description
Altitude	getAntennaHeight() Get the antenna height above the ground level.
TString	getExcluded() Get whether the referenced Location is included or excluded at this diagram endpoint..
Common<?>	getLocSat() Get a reference to a geographic location or satellite associated with this diagram endpoint.
Serial	getLocSatRef() Deprecated. SSRF references are managed automatically. Use getLocSat() instead.
Az180	getMinPointAngle() Get the minimum vertical pointing angle for satellite ground station antennas..
Altitude	getSiteElevation() Get the site elevation of each base station and repeater in a trunking system..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetAntennaHeight() Determine if the AntennaHeight is configured.
boolean	isSetExcluded() Determine if the Excluded is configured.
boolean	isSetLocSat() Determine if the locSat field is configured.
boolean	isSetLocSatRef() Determine if the LocSatRef is configured.
boolean	isSetMinPointAngle() Determine if the MinPointAngle is configured.
boolean	isSetSiteElevation() Determine if the SiteElevation is configured.
void	postLoad(SSRF root) Update the SSRF data type references in this EndpointLocation record after loading from XML.
void	prepare() Update the SSRF data type references in this EndpointLocation record.
void	setAntennaHeight(Altitude value) Set the antenna height above the ground level.
void	setExcluded(TString value) Set whether the referenced Location is included or excluded at this diagram endpoint..
void	setLocSatRef(Serial value) Deprecated. SSRF references are managed automatically. Use #setLocSat(Common) instead.
void	setMinPointAngle(Az180 value) Set the minimum vertical pointing angle for satellite ground station antennas..
void	setSiteElevation(Altitude value) Set the site elevation of each base station and repeater in a trunking system..
String	toString() Get a string representation of this EndpointLocation instance configuration.
EndpointLocation	withAntennaHeight(Double value) Set the antenna height above the ground level.
EndpointLocation	withExcluded(ListCBO value) Set whether the referenced Location is included or excluded at this diagram endpoint.
EndpointLocation	withLocSat(Common<?> value) Set a reference to a geographic location or satellite associated with this diagram endpoint.
EndpointLocation	withLocSatRef(Serial value) Deprecated. SSRF references are managed automatically. Use withLocSat(Common) instead.
EndpointLocation	withMinPointAngle(Double value) Set the minimum vertical pointing angle for satellite ground station antennas.
EndpointLocation	withSiteElevation(Double value) Set the site elevation of each base station and repeater in a trunking system.

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointLocation

public EndpointLocation()

Method Detail

getAntennaHeight

public Altitude getAntennaHeight()

Get the antenna height above the ground level. .

Returns:

a Altitude instance

Since:

3.1.0

setAntennaHeight

public void setAntennaHeight(Altitude value)

Set the antenna height above the ground level. .

Parameters:

value - a Altitude instance

Since:

3.1.0

isSetAntennaHeight

public boolean isSetAntennaHeight()

Determine if the AntennaHeight is configured.

Returns:

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

getExcluded

public TString getExcluded()

Get whether the referenced Location is included or excluded at this diagram endpoint..

Returns:

the Excluded value in a TString data type

Since:

3.1.0

setExcluded

public void setExcluded(TString value)

Set whether the referenced Location is included or excluded at this diagram endpoint..

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

getLocSatRef

@Deprecated
public Serial getLocSatRef()

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

Get a reference to a geographic location or satellite associated with this diagram endpoint. Note for the USA: When coordinating with NTIA, a location is required for base stations and repeaters of trunking systems and satellite ground stations, and satellite orbital characteristics are required for space systems..

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 a reference to a geographic location or satellite associated with this diagram endpoint. Note for the USA: When coordinating with NTIA, a location is required for base stations and repeaters of trunking systems and satellite ground stations, and satellite orbital characteristics are required for space systems..

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

getMinPointAngle

public Az180 getMinPointAngle()

Get the minimum vertical pointing angle for satellite ground station antennas..

Returns:

a Az180 instance

Since:

3.1.0

setMinPointAngle

public void setMinPointAngle(Az180 value)

Set the minimum vertical pointing angle for satellite ground station antennas..

Parameters:

value - a Az180 instance

Since:

3.1.0

isSetMinPointAngle

public boolean isSetMinPointAngle()

Determine if the MinPointAngle is configured.

Returns:

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

getSiteElevation

public Altitude getSiteElevation()

Get the site elevation of each base station and repeater in a trunking system..

Returns:

a Altitude instance

Since:

3.1.0

setSiteElevation

public void setSiteElevation(Altitude value)

Set the site elevation of each base station and repeater in a trunking system..

Parameters:

value - a Altitude instance

Since:

3.1.0

isSetSiteElevation

public boolean isSetSiteElevation()

Determine if the SiteElevation is configured.

Returns:

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

withAntennaHeight

public EndpointLocation withAntennaHeight(Double value)

Set the antenna height above the ground level.

Parameters:

value - An instances of type Double.

Returns:

The current EndpointLocation object instance.

Since:

3.1.0

withExcluded

public EndpointLocation withExcluded(ListCBO value)

Set whether the referenced Location is included or excluded at this diagram endpoint.

Parameters:

value - An instances of type ListCBO.

Returns:

The current EndpointLocation object instance.

Since:

3.1.0

withLocSatRef

@Deprecated
public EndpointLocation withLocSatRef(Serial value)

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

Set a reference to a geographic location or satellite associated with this diagram endpoint. Note for the USA: When coordinating with NTIA, a location is required for base stations and repeaters of trunking systems and satellite ground stations, and satellite orbital characteristics are required for space systems.

Parameters:

value - An instances of type Serial.

Returns:

The current EndpointLocation object instance.

Since:

3.1.0

withMinPointAngle

public EndpointLocation withMinPointAngle(Double value)

Set the minimum vertical pointing angle for satellite ground station antennas.

Parameters:

value - An instances of type Double.

Returns:

The current EndpointLocation object instance.

Since:

3.1.0

withSiteElevation

public EndpointLocation withSiteElevation(Double value)

Set the site elevation of each base station and repeater in a trunking system.

Parameters:

value - An instances of type Double.

Returns:

The current EndpointLocation object instance.

Since:

3.1.0

toString

public String toString()

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

EndpointLocation has no configuration requirements.

Returns:

TRUE

getLocSat

public Common<?> getLocSat()

Get a reference to a geographic location or satellite associated with this diagram endpoint. Note for the USA: When coordinating with NTIA, a location is required for base stations and repeaters of trunking systems and satellite ground stations, and satellite orbital characteristics are required for space systems..

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 EndpointLocation withLocSat(Common<?> value)

Set a reference to a geographic location or satellite associated with this diagram endpoint. Note for the USA: When coordinating with NTIA, a location is required for base stations and repeaters of trunking systems and satellite ground stations, and satellite orbital characteristics are required for space systems.

Parameters:

value - An instances of type Common.

Returns:

The current EndpointLocation object instance.

Since:

3.1.0

prepare

public void prepare()

Update the SSRF data type references in this EndpointLocation record.

This method builds the exported locSatRef field with values from the transient locSat field. This method should typically be called after the EndpointLocation 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 EndpointLocation 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 EndpointLocation is imported from XML. * @param root the SSRF root instance.

Since:

3.1.0