us.gov.dod.standard.ssrf._3_1.jrfl

Class JRFLEntryLocation

java.lang.Object

us.gov.dod.standard.ssrf._3_1.jrfl.JRFLEntryLocation

public class JRFLEntryLocation
extends Object

JRFLEntryLocation defines the location where the use of a specific frequency or frequency range(s) is restricted in use.

Element of JRFLEntry

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
JRFLEntryLocation()

Method Summary

Modifier and Type	Method and Description
Height_UN4	getAntFeedpointHeight() Get the antenna feed point height above the terrain, in metres.
Location	getLocation() Get the serial of the referenced Location.
Serial	getSerial() Deprecated. SSRF references are managed automatically. Use getLocation() instead.
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetAntFeedpointHeight() Determine if the AntFeedpointHeight is configured.
boolean	isSetLocation() Determine if the location field is configured.
boolean	isSetSerial() Determine if the Serial is configured.
void	postLoad(SSRF root) Update the SSRF data type references in this JRFLEntryLocation record after loading from XML.
void	prepare() Update the SSRF data type references in this JRFLEntryLocation record.
void	setAntFeedpointHeight(Height_UN4 value) Set the antenna feed point height above the terrain, in metres.
void	setSerial(Serial value) Deprecated. SSRF references are managed automatically. Use #setLocation(Location) instead.
String	toString() Get a string representation of this JRFLEntryLocation instance configuration.
JRFLEntryLocation	withAntFeedpointHeight(Integer value) Set the antenna feed point height above the terrain, in metres.
JRFLEntryLocation	withLocation(Location value) Set the serial of the referenced Location.
JRFLEntryLocation	withSerial(Serial value) Deprecated. SSRF references are managed automatically. Use withLocation(Location) instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

JRFLEntryLocation

public JRFLEntryLocation()

Method Detail

getSerial

@Deprecated
public Serial getSerial()

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

Get the serial of the referenced Location.

[XSL ERR DSTYPE] Part 3 of the serial reference (dataset type) MUST be "LO". [XSD ERR REGEX] This data item MUST comply to the regular expression: "[A-Z0-9-]{1,5}:w{0,4}:[A-Z]{2}:S{1,15}".

Returns:

a Serial instance

Since:

3.1.0

setSerial

@Deprecated
public void setSerial(Serial value)

Deprecated. SSRF references are managed automatically. Use #setLocation(Location) instead.

Set the serial of the referenced Location.

[XSL ERR DSTYPE] Part 3 of the serial reference (dataset type) MUST be "LO". [XSD ERR REGEX] This data item MUST comply to the regular expression: "[A-Z0-9-]{1,5}:w{0,4}:[A-Z]{2}:S{1,15}".

Parameters:

value - a Serial instance

Since:

3.1.0

isSetSerial

public boolean isSetSerial()

Determine if the Serial is configured.

Returns:

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

getAntFeedpointHeight

public Height_UN4 getAntFeedpointHeight()

Get the antenna feed point height above the terrain, in metres. In the case where the antenna is mounted pointing vertically to a reflector on the same structure, enter the height of the reflector above ground. If the Station is a flying object, this data represents the maximum altitude of the object above ground..

Returns:

a Height_UN4 instance

Since:

3.1.0

setAntFeedpointHeight

public void setAntFeedpointHeight(Height_UN4 value)

Set the antenna feed point height above the terrain, in metres. In the case where the antenna is mounted pointing vertically to a reflector on the same structure, enter the height of the reflector above ground. If the Station is a flying object, this data represents the maximum altitude of the object above ground..

Parameters:

value - a Height_UN4 instance

Since:

3.1.0

isSetAntFeedpointHeight

public boolean isSetAntFeedpointHeight()

Determine if the AntFeedpointHeight is configured.

Returns:

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

withSerial

@Deprecated
public JRFLEntryLocation withSerial(Serial value)

Deprecated. SSRF references are managed automatically. Use withLocation(Location) instead.

Set the serial of the referenced Location.

[XSL ERR DSTYPE] Part 3 of the serial reference (dataset type) MUST be "LO". [XSD ERR REGEX] This data item MUST comply to the regular expression: "[A-Z0-9-]{1,5}:w{0,4}:[A-Z]{2}:S{1,15}"

Parameters:

value - An instances of type Serial.

Returns:

The current JRFLEntryLocation object instance.

Since:

3.1.0

withAntFeedpointHeight

public JRFLEntryLocation withAntFeedpointHeight(Integer value)

Set the antenna feed point height above the terrain, in metres. In the case where the antenna is mounted pointing vertically to a reflector on the same structure, enter the height of the reflector above ground. If the Station is a flying object, this data represents the maximum altitude of the object above ground.

Parameters:

value - An instances of type Integer.

Returns:

The current JRFLEntryLocation object instance.

Since:

3.1.0

toString

public String toString()

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

JRFLEntryLocation requires Serial.

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

getLocation

public Location getLocation()

Get the serial of the referenced Location.

[XSL ERR DSTYPE] Part 3 of the serial reference (dataset type) MUST be "LO". [XSD ERR REGEX] This data item MUST comply to the regular expression: "[A-Z0-9-]{1,5}:w{0,4}:[A-Z]{2}:S{1,15}".

Returns:

a Location instance

Since:

3.1.0

isSetLocation

public boolean isSetLocation()

Determine if the location field is configured.

Returns:

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

withLocation

public JRFLEntryLocation withLocation(Location value)

Set the serial of the referenced Location.

[XSL ERR DSTYPE] Part 3 of the serial reference (dataset type) MUST be "LO". [XSD ERR REGEX] This data item MUST comply to the regular expression: "[A-Z0-9-]{1,5}:w{0,4}:[A-Z]{2}:S{1,15}"

Parameters:

value - An instances of type Location.

Returns:

The current JRFLEntryLocation object instance.

Since:

3.1.0

prepare

public void prepare()

Update the SSRF data type references in this JRFLEntryLocation record.

This method builds the exported serial field with values from the transient location field. This method should typically be called after the JRFLEntryLocation 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 JRFLEntryLocation record after loading from XML.

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

Since:

3.1.0