us.gov.dod.standard.ssrf._3_1.multiple

Class RxAntModeRef

java.lang.Object

us.gov.dod.standard.ssrf._3_1.multiple.RxAntModeRef

Direct Known Subclasses:

TxAntModeRef

public class RxAntModeRef
extends Object

RxAntModeRef contains references to the Antenna and its AntMode, used to construct a Receiver Configuration.

Element of RxRef

Example:

 <RxAntModeRef>
   <Serial cls="U">USA:NTIA:AN:123</Serial>
   <ModeID cls="U">TRACKING</ModeID>
 </RxAntModeRef>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
RxAntModeRef()

Method Summary

Modifier and Type	Method and Description
Antenna	getAntenna() Get the reference to an Antenna in this configuration.
dB	getCouplingLoss() Get the loss that occurs when energy is transferred between the transmitter/receiver and the antenna..
S20	getModeID() Get the unique name of an AntMode of the Antenna specified in the corresponding Serial field.
Serial	getSerial() Deprecated. SSRF references are managed automatically. Use getAntenna() instead.
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetAntenna() Determine if the antenna field is configured.
boolean	isSetCouplingLoss() Determine if the CouplingLoss is configured.
boolean	isSetModeID() Determine if the ModeID is configured.
boolean	isSetSerial() Determine if the Serial is configured.
void	postLoad(SSRF root) Update the SSRF data type references in this RxAntModeRef record after loading from XML.
void	prepare() Update the SSRF data type references in this RxAntModeRef record.
void	setCouplingLoss(dB value) Set the loss that occurs when energy is transferred between the transmitter/receiver and the antenna..
void	setModeID(S20 value) Set the unique name of an AntMode of the Antenna specified in the corresponding Serial field.
void	setSerial(Serial value) Deprecated. SSRF references are managed automatically. Use #setAntenna(Antenna) instead.
String	toString() Get a string representation of this RxAntModeRef instance configuration.
RxAntModeRef	withAntenna(Antenna value) Set the reference to an Antenna in this configuration.
RxAntModeRef	withCouplingLoss(Double value) Set the loss that occurs when energy is transferred between the transmitter/receiver and the antenna.
RxAntModeRef	withModeID(String value) Set the unique name of an AntMode of the Antenna specified in the corresponding Serial field.
RxAntModeRef	withSerial(Serial value) Deprecated. SSRF references are managed automatically. Use withAntenna(Antenna) instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

RxAntModeRef

public RxAntModeRef()

Method Detail

getSerial

@Deprecated
public Serial getSerial()

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

Get the reference to an Antenna in this configuration. This antenna is associated with the receiver specified in the Serial field of the parent RxRef element..

Returns:

a Serial instance

Since:

3.1.0

setSerial

@Deprecated
public void setSerial(Serial value)

Deprecated. SSRF references are managed automatically. Use #setAntenna(Antenna) instead.

Set the reference to an Antenna in this configuration. This antenna is associated with the receiver specified in the Serial field of the parent RxRef element..

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

getModeID

public S20 getModeID()

Get the unique name of an AntMode of the Antenna specified in the corresponding Serial field. This antenna mode is grouped with the receiver modes specified in RxModeRef..

Returns:

a S20 instance

Since:

3.1.0

setModeID

public void setModeID(S20 value)

Set the unique name of an AntMode of the Antenna specified in the corresponding Serial field. This antenna mode is grouped with the receiver modes specified in RxModeRef..

Parameters:

value - a S20 instance

Since:

3.1.0

isSetModeID

public boolean isSetModeID()

Determine if the ModeID is configured.

Returns:

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

getCouplingLoss

public dB getCouplingLoss()

Get the loss that occurs when energy is transferred between the transmitter/receiver and the antenna..

Returns:

a dB instance

Since:

3.1.0

setCouplingLoss

public void setCouplingLoss(dB value)

Set the loss that occurs when energy is transferred between the transmitter/receiver and the antenna..

Parameters:

value - a dB instance

Since:

3.1.0

isSetCouplingLoss

public boolean isSetCouplingLoss()

Determine if the CouplingLoss is configured.

Returns:

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

withSerial

@Deprecated
public RxAntModeRef withSerial(Serial value)

Deprecated. SSRF references are managed automatically. Use withAntenna(Antenna) instead.

Set the reference to an Antenna in this configuration. This antenna is associated with the receiver specified in the Serial field of the parent RxRef element.

Parameters:

value - An instances of type Serial.

Returns:

The current RxAntModeRef object instance.

Since:

3.1.0

withModeID

public RxAntModeRef withModeID(String value)

Set the unique name of an AntMode of the Antenna specified in the corresponding Serial field. This antenna mode is grouped with the receiver modes specified in RxModeRef.

Parameters:

value - An instances of type String.

Returns:

The current RxAntModeRef object instance.

Since:

3.1.0

withCouplingLoss

public RxAntModeRef withCouplingLoss(Double value)

Set the loss that occurs when energy is transferred between the transmitter/receiver and the antenna.

Parameters:

value - An instances of type Double.

Returns:

The current RxAntModeRef object instance.

Since:

3.1.0

toString

public String toString()

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

RxAntModeRef 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

getAntenna

public Antenna getAntenna()

Get the reference to an Antenna in this configuration. This antenna is associated with the receiver specified in the Serial field of the parent RxRef element..

Returns:

a Antenna instance

Since:

3.1.0

isSetAntenna

public boolean isSetAntenna()

Determine if the antenna field is configured.

Returns:

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

withAntenna

public RxAntModeRef withAntenna(Antenna value)

Set the reference to an Antenna in this configuration. This antenna is associated with the receiver specified in the Serial field of the parent RxRef element.

Parameters:

value - An instances of type Antenna.

Returns:

The current RxAntModeRef object instance.

Since:

3.1.0

prepare

public void prepare()

Update the SSRF data type references in this RxAntModeRef record.

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

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

Since:

3.1.0