Power (lib-openssrf-3.1.0 1.0.0 API)

java.lang.Object
- us.gov.dod.standard.ssrf._3_1.transmitter.Power

public class Power
extends Object

Power identifies the transmitter RF power at the transmitter antenna port.

Element of TxMode

Example:

 <Power>
   <PowerMin cls="U">-3</PowerMin>
   <PowerMax cls="U">31.8</PowerMax>
   <PowerType cls="U">PEP</PowerType>
   <Calculated cls="U">No</Calculated>
 </Power>

Version:: 3.1.0, 03/30/2015
Author:: Key Bridge LLC

Constructor Summary

Constructors
Constructor and Description

Power()

Constructors
Constructor and Description
`Power()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TString`	`getCalculated()` Get "Yes" if the power value(s) have been calculated, or "No" if they have been measured..
`dBW`	`getPowerMax()` Get the maximum transmitter power.
`dBW`	`getPowerMin()` Get the nominal transmitter power, or the minimum power in case of a range of values..
`TString`	`getPowerType()` Get the power type code for carrier, mean, or peak envelope power emitted.
`boolean`	`isSet()` Determine if the required fields in this SSRF data type instance are set.
`boolean`	`isSetCalculated()` Determine if the Calculated is configured.
`boolean`	`isSetPowerMax()` Determine if the PowerMax is configured.
`boolean`	`isSetPowerMin()` Determine if the PowerMin is configured.
`boolean`	`isSetPowerType()` Determine if the PowerType is configured.
`void`	`setCalculated(TString value)` Set "Yes" if the power value(s) have been calculated, or "No" if they have been measured..
`void`	`setPowerMax(dBW value)` Set the maximum transmitter power.
`void`	`setPowerMin(dBW value)` Set the nominal transmitter power, or the minimum power in case of a range of values..
`void`	`setPowerType(TString value)` Set the power type code for carrier, mean, or peak envelope power emitted.
`String`	`toString()` Get a string representation of this Power instance configuration.
`Power`	`withCalculated(ListCBO value)` Set "Yes" if the power value(s) have been calculated, or "No" if they have been measured.
`Power`	`withPowerMax(Double value)` Set the maximum transmitter power.
`Power`	`withPowerMin(Double value)` Set the nominal transmitter power, or the minimum power in case of a range of values.
`Power`	`withPowerType(ListCPT value)` Set the power type code for carrier, mean, or peak envelope power emitted.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Power
```
public Power()
```
- Method Detail
  - getPowerMin
```
public dBW getPowerMin()
```
    Get the nominal transmitter power, or the minimum power in case of a range of values..
    
    Returns:
    
    a dBW instance
    
    Since:
    
    3.1.0
  - setPowerMin
```
public void setPowerMin(dBW value)
```
    Set the nominal transmitter power, or the minimum power in case of a range of values..
    
    Parameters:
    
    value - a dBW instance
    
    Since:
    
    3.1.0
  - isSetPowerMin
```
public boolean isSetPowerMin()
```
    Determine if the PowerMin is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getPowerMax
```
public dBW getPowerMax()
```
    Get the maximum transmitter power.
    [XSL ERR MINMAX] If PowerMax is used, it MUST be greater than PowerMin..
    
    Returns:
    
    a dBW instance
    
    Since:
    
    3.1.0
  - setPowerMax
```
public void setPowerMax(dBW value)
```
    Set the maximum transmitter power.
    [XSL ERR MINMAX] If PowerMax is used, it MUST be greater than PowerMin..
    
    Parameters:
    
    value - a dBW instance
    
    Since:
    
    3.1.0
  - isSetPowerMax
```
public boolean isSetPowerMax()
```
    Determine if the PowerMax is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getPowerType
```
public TString getPowerType()
```
    Get the power type code for carrier, mean, or peak envelope power emitted. The power type code will depend on the type of emission of the transmitter equipment..
    
    Returns:
    
    the PowerType value in a TString data type
    
    Since:
    
    3.1.0
  - setPowerType
```
public void setPowerType(TString value)
```
    Set the power type code for carrier, mean, or peak envelope power emitted. The power type code will depend on the type of emission of the transmitter equipment..
    
    Parameters:
    
    value - the PowerType value in a TString data type
    
    Since:
    
    3.1.0
  - isSetPowerType
```
public boolean isSetPowerType()
```
    Determine if the PowerType 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
  - getCalculated
```
public TString getCalculated()
```
    Get "Yes" if the power value(s) have been calculated, or "No" if they have been measured..
    
    Returns:
    
    the Calculated value in a TString data type
    
    Since:
    
    3.1.0
  - setCalculated
```
public void setCalculated(TString value)
```
    Set "Yes" if the power value(s) have been calculated, or "No" if they have been measured..
    
    Parameters:
    
    value - the Calculated value in a TString data type
    
    Since:
    
    3.1.0
  - isSetCalculated
```
public boolean isSetCalculated()
```
    Determine if the Calculated 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
  - withPowerMin
```
public Power withPowerMin(Double value)
```
    Set the nominal transmitter power, or the minimum power in case of a range of values.
    
    Parameters:
    
    value - An instances of type Double.
    
    Returns:
    
    The current Power object instance.
    
    Since:
    
    3.1.0
  - withPowerMax
```
public Power withPowerMax(Double value)
```
    Set the maximum transmitter power.
    [XSL ERR MINMAX] If PowerMax is used, it MUST be greater than PowerMin.
    
    Parameters:
    
    value - An instances of type Double.
    
    Returns:
    
    The current Power object instance.
    
    Since:
    
    3.1.0
  - withPowerType
```
public Power withPowerType(ListCPT value)
```
    Set the power type code for carrier, mean, or peak envelope power emitted. The power type code will depend on the type of emission of the transmitter equipment.
    
    Parameters:
    
    value - An instances of type ListCPT.
    
    Returns:
    
    The current Power object instance.
    
    Since:
    
    3.1.0
  - withCalculated
```
public Power withCalculated(ListCBO value)
```
    Set "Yes" if the power value(s) have been calculated, or "No" if they have been measured.
    
    Parameters:
    
    value - An instances of type ListCBO.
    
    Returns:
    
    The current Power object instance.
    
    Since:
    
    3.1.0
  - toString
```
public String toString()
```
    Get a string representation of this Power 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.
    Power has no configuration requirements.
    
    Returns:
    
    TRUE

Class Power

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Power

Method Detail

getPowerMin

setPowerMin

isSetPowerMin

getPowerMax

setPowerMax

isSetPowerMax

getPowerType

setPowerType

isSetPowerType

getCalculated

setCalculated

isSetCalculated

withPowerMin

withPowerMax

withPowerType

withCalculated

toString

isSet