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

Class TxModeRef

java.lang.Object

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

public class TxModeRef
extends Object

TxModeRef contains references to the Transmitter and its modes, used to construct a Configuration.

Element of TxRef

Example:

 <TxModeRef>
   <Serial cls="U">USA:NTIA:TX:123</Serial>
   <ModeID cls="U">CLEAR VOICE H. POWER</ModeID>
 </TxModeRef>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
TxModeRef()

Method Summary

Modifier and Type	Method and Description
S20	getModeID() Get the unique identifier of a TxMode of the transmitter in this configuration.
dBW	getPowerLimit() Get the power limit of this transmitter mode when in this configuration..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetModeID() Determine if the ModeID is configured.
boolean	isSetPowerLimit() Determine if the PowerLimit is configured.
void	setModeID(S20 value) Set the unique identifier of a TxMode of the transmitter in this configuration.
void	setPowerLimit(dBW value) Set the power limit of this transmitter mode when in this configuration..
String	toString() Get a string representation of this TxModeRef instance configuration.
TxModeRef	withModeID(String value) Set the unique identifier of a TxMode of the transmitter in this configuration.
TxModeRef	withPowerLimit(Double value) Set the power limit of this transmitter mode when in this configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

TxModeRef

public TxModeRef()

Method Detail

getModeID

public S20 getModeID()

Get the unique identifier of a TxMode of the transmitter in this configuration. This mode is from the transmitter specified in the Serial field of the parent TxRef element..

Returns:

a S20 instance

Since:

3.1.0

setModeID

public void setModeID(S20 value)

Set the unique identifier of a TxMode of the transmitter in this configuration. This mode is from the transmitter specified in the Serial field of the parent TxRef element..

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

getPowerLimit

public dBW getPowerLimit()

Get the power limit of this transmitter mode when in this configuration..

Returns:

a dBW instance

Since:

3.1.0

setPowerLimit

public void setPowerLimit(dBW value)

Set the power limit of this transmitter mode when in this configuration..

Parameters:

value - a dBW instance

Since:

3.1.0

isSetPowerLimit

public boolean isSetPowerLimit()

Determine if the PowerLimit is configured.

Returns:

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

withModeID

public TxModeRef withModeID(String value)

Set the unique identifier of a TxMode of the transmitter in this configuration. This mode is from the transmitter specified in the Serial field of the parent TxRef element.

Parameters:

value - An instances of type String.

Returns:

The current TxModeRef object instance.

Since:

3.1.0

withPowerLimit

public TxModeRef withPowerLimit(Double value)

Set the power limit of this transmitter mode when in this configuration.

Parameters:

value - An instances of type Double.

Returns:

The current TxModeRef object instance.

Since:

3.1.0

toString

public String toString()

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

TxModeRef requires ModeID.

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