us.gov.dod.standard.ssrf._3_1.satellite

Class EarthStation

java.lang.Object

us.gov.dod.standard.ssrf._3_1.satellite.EarthStation

public class EarthStation
extends Object

EarthStation contains the name and type of an earth station used in a satellite network.

Element of Satellite

Example:

 <EarthStation>
   <Name cls="U">Kessler</Name>
   <Type cls="U">Specific</Type>
 </EarthStation>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
EarthStation()

Method Summary

Modifier and Type	Method and Description
Location	getLocation() Get the serial of the referenced Location..
Serial	getLocationRef() Deprecated. SSRF references are managed automatically. Use getLocation() instead.
S50	getName() Get the name of an associated earth station..
TString	getType() Get if this is a specific or typical earth station..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetLocation() Determine if the location field is configured.
boolean	isSetLocationRef() Determine if the LocationRef is configured.
boolean	isSetName() Determine if the Name is configured.
boolean	isSetType() Determine if the Type is configured.
void	postLoad(SSRF root) Update the SSRF data type references in this EarthStation record after loading from XML.
void	prepare() Update the SSRF data type references in this EarthStation record.
void	setLocationRef(Serial value) Deprecated. SSRF references are managed automatically. Use #setLocation(Location) instead.
void	setName(S50 value) Set the name of an associated earth station..
void	setType(TString value) Set if this is a specific or typical earth station..
String	toString() Get a string representation of this EarthStation instance configuration.
EarthStation	withLocation(Location value) Set the serial of the referenced Location.
EarthStation	withLocationRef(Serial value) Deprecated. SSRF references are managed automatically. Use withLocation(Location) instead.
EarthStation	withName(String value) Set the name of an associated earth station.
EarthStation	withType(ListCEA value) Set if this is a specific or typical earth station.

Methods inherited from class java.lang.Object

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

Constructor Detail

EarthStation

public EarthStation()

Method Detail

getName

public S50 getName()

Get the name of an associated earth station..

Returns:

a S50 instance

Since:

3.1.0

setName

public void setName(S50 value)

Set the name of an associated earth station..

Parameters:

value - a S50 instance

Since:

3.1.0

isSetName

public boolean isSetName()

Determine if the Name is configured.

Returns:

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

getType

public TString getType()

Get if this is a specific or typical earth station..

Returns:

the Type value in a TString data type

Since:

3.1.0

setType

public void setType(TString value)

Set if this is a specific or typical earth station..

Parameters:

value - the Type value in a TString data type

Since:

3.1.0

isSetType

public boolean isSetType()

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

getLocationRef

@Deprecated
public Serial getLocationRef()

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

Get the serial of the referenced Location..

Returns:

a Serial instance

Since:

3.1.0

setLocationRef

@Deprecated
public void setLocationRef(Serial value)

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

Set the serial of the referenced Location..

Parameters:

value - a Serial instance

Since:

3.1.0

isSetLocationRef

public boolean isSetLocationRef()

Determine if the LocationRef is configured.

Returns:

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

withName

public EarthStation withName(String value)

Set the name of an associated earth station.

Parameters:

value - An instances of type String.

Returns:

The current EarthStation object instance.

Since:

3.1.0

withType

public EarthStation withType(ListCEA value)

Set if this is a specific or typical earth station.

Parameters:

value - An instances of type ListCEA.

Returns:

The current EarthStation object instance.

Since:

3.1.0

withLocationRef

@Deprecated
public EarthStation withLocationRef(Serial value)

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

Set the serial of the referenced Location.

Parameters:

value - An instances of type Serial.

Returns:

The current EarthStation object instance.

Since:

3.1.0

toString

public String toString()

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

EarthStation has no configuration requirements.

Returns:

TRUE

getLocation

public Location getLocation()

Get the serial of the referenced Location..

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 EarthStation withLocation(Location value)

Set the serial of the referenced Location.

Parameters:

value - An instances of type Location.

Returns:

The current EarthStation object instance.

Since:

3.1.0

prepare

public void prepare()

Update the SSRF data type references in this EarthStation record.

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

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

Since:

3.1.0