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

Class TxAntModeRef

java.lang.Object

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

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

public class TxAntModeRef
extends RxAntModeRef

TxAntModeRef contains references to the Antenna and its AntMode, used to construct a Transmitter Configuration.

Element of TxRef

Example:

 <TxAntModeRef>
   <Serial cls="U">USA:NTIA:AN:123</Serial>
   <ModeID cls="U">TRACKING</ModeID>
   <SpectralPowerDensity cls="U">15</SpectralPowerDensity>
 </TxAntModeRef>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
TxAntModeRef()

Method Summary

Modifier and Type	Method and Description
dBWHz	getSpectralPowerDensity() Get the maximum spectral power density supplied to the input of the antenna..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetSpectralPowerDensity() Determine if the SpectralPowerDensity is configured.
void	setSpectralPowerDensity(dBWHz value) Set the maximum spectral power density supplied to the input of the antenna..
String	toString() Get a string representation of this TxAntModeRef instance configuration.
TxAntModeRef	withCouplingLoss(Double value) Set the loss that occurs when energy is transferred between the transmitter/receiver and the antenna.
TxAntModeRef	withModeID(String value) Set the unique name of an AntMode of the Antenna specified in the corresponding Serial field.
TxAntModeRef	withSerial(Serial value) Set the reference to an Antenna in this configuration.
TxAntModeRef	withSpectralPowerDensity(Double value) Set the maximum spectral power density supplied to the input of the antenna.

Methods inherited from class us.gov.dod.standard.ssrf._3_1.multiple.RxAntModeRef

getAntenna, getCouplingLoss, getModeID, getSerial, isSetAntenna, isSetCouplingLoss, isSetModeID, isSetSerial, postLoad, prepare, setCouplingLoss, setModeID, setSerial, withAntenna

Methods inherited from class java.lang.Object

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

Constructor Detail

TxAntModeRef

public TxAntModeRef()

Method Detail

getSpectralPowerDensity

public dBWHz getSpectralPowerDensity()

Get the maximum spectral power density supplied to the input of the antenna..

Returns:

a dBWHz instance

Since:

3.1.0

setSpectralPowerDensity

public void setSpectralPowerDensity(dBWHz value)

Set the maximum spectral power density supplied to the input of the antenna..

Parameters:

value - a dBWHz instance

Since:

3.1.0

isSetSpectralPowerDensity

public boolean isSetSpectralPowerDensity()

Determine if the SpectralPowerDensity is configured.

Returns:

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

withSpectralPowerDensity

public TxAntModeRef withSpectralPowerDensity(Double value)

Set the maximum spectral power density supplied to the input of the antenna.

Parameters:

value - An instances of type Double.

Returns:

The current TxAntModeRef object instance.

Since:

3.1.0

withSerial

public TxAntModeRef withSerial(Serial value)

Description copied from class: RxAntModeRef

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.

Overrides:

withSerial in class RxAntModeRef

Parameters:

value - An instances of type Serial.

Returns:

The current RxAntModeRef object instance.

withModeID

public TxAntModeRef withModeID(String value)

Description copied from class: RxAntModeRef

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.

Overrides:

withModeID in class RxAntModeRef

Parameters:

value - An instances of type String.

Returns:

The current RxAntModeRef object instance.

withCouplingLoss

public TxAntModeRef withCouplingLoss(Double value)

Description copied from class: RxAntModeRef

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

Overrides:

withCouplingLoss in class RxAntModeRef

Parameters:

value - An instances of type Double.

Returns:

The current RxAntModeRef object instance.

toString

public String toString()

Get a string representation of this TxAntModeRef instance configuration.

Overrides:

toString in class RxAntModeRef

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.

TxAntModeRef has no configuration requirements.

Overrides:

isSet in class RxAntModeRef

Returns:

TRUE