AntGain (lib-openssrf-3.1.0 1.0.0 API)

java.lang.Object
- us.gov.dod.standard.ssrf._3_1.antenna.AntGain

```
public class AntGain
extends Object
```
AntGain indicates the antenna gain, in decibels with reference to an isotropic source (dBi), in the direction of maximum radiation.
Element of AntMode
Example: A basic gain, regardless of the frequency:
```
 <AntGain>
   <Gain cls="U">0</Gain>
 </AntGain>
 A complete entry:* <AntGain>
   <Gain cls="U">6.1</Gain>
   <Freq cls="U">230.525</Freq>
   <FrontToBackRatio cls="U">2</FrontToBackRatio>
 </AntGain>
 
```
Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors
Constructor and Description

AntGain()

Constructors
Constructor and Description
`AntGain()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TString`	`getCalculated()` Get Yes to indicate that the data was calculated, or "No" if the data is issued from measurement.
`FreqM`	`getFreq()` Get the frequency at which the gain is expressed..
`Unsigned_DB_5_2`	`getFrontToBackRatio()` Get the front-to-back ratio of the main beam to the back lobe..
`dBi`	`getGain()` Get the antenna gain (in dBi - dB with reference to an isotropic source) in the direction of maximum radiation.
`boolean`	`isSet()` Determine if the required fields in this SSRF data type instance are set.
`boolean`	`isSetCalculated()` Determine if the Calculated is configured.
`boolean`	`isSetFreq()` Determine if the Freq is configured.
`boolean`	`isSetFrontToBackRatio()` Determine if the FrontToBackRatio is configured.
`boolean`	`isSetGain()` Determine if the Gain is configured.
`void`	`setCalculated(TString value)` Set Yes to indicate that the data was calculated, or "No" if the data is issued from measurement.
`void`	`setFreq(FreqM value)` Set the frequency at which the gain is expressed..
`void`	`setFrontToBackRatio(Unsigned_DB_5_2 value)` Set the front-to-back ratio of the main beam to the back lobe..
`void`	`setGain(dBi value)` Set the antenna gain (in dBi - dB with reference to an isotropic source) in the direction of maximum radiation.
`String`	`toString()` Get a string representation of this AntGain instance configuration.
`AntGain`	`withCalculated(ListCBO value)` Set Yes to indicate that the data was calculated, or "No" if the data is issued from measurement.
`AntGain`	`withFreq(Double value)` Set the frequency at which the gain is expressed.
`AntGain`	`withFrontToBackRatio(Double value)` Set the front-to-back ratio of the main beam to the back lobe.
`AntGain`	`withGain(Double value)` Set the antenna gain (in dBi - dB with reference to an isotropic source) in the direction of maximum radiation.

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

- Constructor Detail
  - AntGain
```
public AntGain()
```
- Method Detail
  - getCalculated
```
public TString getCalculated()
```
    Get Yes to indicate that the data was calculated, or "No" if the data is issued from measurement. Leave blank if the origin of the data is not known..
    
    Returns:
    
    the Calculated value in a TString data type
    
    Since:
    
    3.1.0
  - setCalculated
```
public void setCalculated(TString value)
```
    Set Yes to indicate that the data was calculated, or "No" if the data is issued from measurement. Leave blank if the origin of the data is not known..
    
    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
  - getGain
```
public dBi getGain()
```
    Get the antenna gain (in dBi - dB with reference to an isotropic source) in the direction of maximum radiation. For a negative gain (earth and space stations only), enter a dash before the value of the gain..
    
    Returns:
    
    a dBi instance
    
    Since:
    
    3.1.0
  - setGain
```
public void setGain(dBi value)
```
    Set the antenna gain (in dBi - dB with reference to an isotropic source) in the direction of maximum radiation. For a negative gain (earth and space stations only), enter a dash before the value of the gain..
    
    Parameters:
    
    value - a dBi instance
    
    Since:
    
    3.1.0
  - isSetGain
```
public boolean isSetGain()
```
    Determine if the Gain is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getFreq
```
public FreqM getFreq()
```
    Get the frequency at which the gain is expressed..
    
    Returns:
    
    a FreqM instance
    
    Since:
    
    3.1.0
  - setFreq
```
public void setFreq(FreqM value)
```
    Set the frequency at which the gain is expressed..
    
    Parameters:
    
    value - a FreqM instance
    
    Since:
    
    3.1.0
  - isSetFreq
```
public boolean isSetFreq()
```
    Determine if the Freq is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getFrontToBackRatio
```
public Unsigned_DB_5_2 getFrontToBackRatio()
```
    Get the front-to-back ratio of the main beam to the back lobe..
    
    Returns:
    
    a Unsigned_DB_5_2 instance
    
    Since:
    
    3.1.0
  - setFrontToBackRatio
```
public void setFrontToBackRatio(Unsigned_DB_5_2 value)
```
    Set the front-to-back ratio of the main beam to the back lobe..
    
    Parameters:
    
    value - a Unsigned_DB_5_2 instance
    
    Since:
    
    3.1.0
  - isSetFrontToBackRatio
```
public boolean isSetFrontToBackRatio()
```
    Determine if the FrontToBackRatio is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - withCalculated
```
public AntGain withCalculated(ListCBO value)
```
    Set Yes to indicate that the data was calculated, or "No" if the data is issued from measurement. Leave blank if the origin of the data is not known.
    
    Parameters:
    
    value - An instances of type ListCBO.
    
    Returns:
    
    The current AntGain object instance.
    
    Since:
    
    3.1.0
  - withGain
```
public AntGain withGain(Double value)
```
    Set the antenna gain (in dBi - dB with reference to an isotropic source) in the direction of maximum radiation. For a negative gain (earth and space stations only), enter a dash before the value of the gain.
    
    Parameters:
    
    value - An instances of type Double.
    
    Returns:
    
    The current AntGain object instance.
    
    Since:
    
    3.1.0
  - withFreq
```
public AntGain withFreq(Double value)
```
    Set the frequency at which the gain is expressed.
    
    Parameters:
    
    value - An instances of type Double.
    
    Returns:
    
    The current AntGain object instance.
    
    Since:
    
    3.1.0
  - withFrontToBackRatio
```
public AntGain withFrontToBackRatio(Double value)
```
    Set the front-to-back ratio of the main beam to the back lobe.
    
    Parameters:
    
    value - An instances of type Double.
    
    Returns:
    
    The current AntGain object instance.
    
    Since:
    
    3.1.0
  - toString
```
public String toString()
```
    Get a string representation of this AntGain 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.
    AntGain requires Gain.
    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

Class AntGain

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AntGain

Method Detail

getCalculated

setCalculated

isSetCalculated

getGain

setGain

isSetGain

getFreq

setFreq

isSetFreq

getFrontToBackRatio

setFrontToBackRatio

isSetFrontToBackRatio

withCalculated

withGain

withFreq

withFrontToBackRatio

toString

isSet