AntFreqs (lib-openssrf-3.1.0 1.0.0 API)

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

public class AntFreqs
extends Object

AntFreqs contains the antenna's designed tuning range, or the discrete operating frequency.

Element of AntMode

Example: Both examples reflect the same operating range:

 <AntFreqs>
   <FreqMin cls="U">30</FreqMin>
   <FreqMax cls="U">90</FreqMax>
 </AntFreqs>
 A bandwidth of 60 MHz is +/-30 MHz around FreqMin:* <AntFreqs>
   <FreqMin cls="U">60</FreqMin>
   <Bandwidth cls="U">60</Bandwidth>
 </AntFreqs>

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

Constructor Summary

Constructors
Constructor and Description

AntFreqs()

Constructors
Constructor and Description
`AntFreqs()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FreqM`	`getBandwidth()` Get In Data Item Bandwidth, as an alternative to FreqMin/FreqMax, enter the total operating bandwidth of the Antenna centered around FreqMin..
`FreqM`	`getFreqMax()` Get the maximum value of the frequencies in the range.
`FreqM`	`getFreqMin()` Get the nominal frequency or minimum value of the frequency range..
`TString`	`getFreqUse()` Get if the frequency range is used for transmit, receive, or both transmit and receive..
`boolean`	`isSet()` Determine if the required fields in this SSRF data type instance are set.
`boolean`	`isSetBandwidth()` Determine if the Bandwidth is configured.
`boolean`	`isSetFreqMax()` Determine if the FreqMax is configured.
`boolean`	`isSetFreqMin()` Determine if the FreqMin is configured.
`boolean`	`isSetFreqUse()` Determine if the FreqUse is configured.
`void`	`setBandwidth(FreqM value)` Set In Data Item Bandwidth, as an alternative to FreqMin/FreqMax, enter the total operating bandwidth of the Antenna centered around FreqMin..
`void`	`setFreqMax(FreqM value)` Set the maximum value of the frequencies in the range.
`void`	`setFreqMin(FreqM value)` Set the nominal frequency or minimum value of the frequency range..
`void`	`setFreqUse(TString value)` Set if the frequency range is used for transmit, receive, or both transmit and receive..
`String`	`toString()` Get a string representation of this AntFreqs instance configuration.
`AntFreqs`	`withBandwidth(Double value)` Set In Data Item Bandwidth, as an alternative to FreqMin/FreqMax, enter the total operating bandwidth of the Antenna centered around FreqMin.
`AntFreqs`	`withFreqMax(Double value)` Set the maximum value of the frequencies in the range.
`AntFreqs`	`withFreqMin(Double value)` Set the nominal frequency or minimum value of the frequency range.
`AntFreqs`	`withFreqUse(ListCAU value)` Set if the frequency range is used for transmit, receive, or both transmit and receive.

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

- Constructor Detail
  - AntFreqs
```
public AntFreqs()
```
- Method Detail
  - getFreqMin
```
public FreqM getFreqMin()
```
    Get the nominal frequency or minimum value of the frequency range..
    
    Returns:
    
    a FreqM instance
    
    Since:
    
    3.1.0
  - setFreqMin
```
public void setFreqMin(FreqM value)
```
    Set the nominal frequency or minimum value of the frequency range..
    
    Parameters:
    
    value - a FreqM instance
    
    Since:
    
    3.1.0
  - isSetFreqMin
```
public boolean isSetFreqMin()
```
    Determine if the FreqMin is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getFreqMax
```
public FreqM getFreqMax()
```
    Get the maximum value of the frequencies in the range.
    [XSL ERR MINMAX] If FreqMax is used, it MUST be greater than FreqMin..
    
    Returns:
    
    a FreqM instance
    
    Since:
    
    3.1.0
  - setFreqMax
```
public void setFreqMax(FreqM value)
```
    Set the maximum value of the frequencies in the range.
    [XSL ERR MINMAX] If FreqMax is used, it MUST be greater than FreqMin..
    
    Parameters:
    
    value - a FreqM instance
    
    Since:
    
    3.1.0
  - isSetFreqMax
```
public boolean isSetFreqMax()
```
    Determine if the FreqMax is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getBandwidth
```
public FreqM getBandwidth()
```
    Get In Data Item Bandwidth, as an alternative to FreqMin/FreqMax, enter the total operating bandwidth of the Antenna centered around FreqMin..
    
    Returns:
    
    a FreqM instance
    
    Since:
    
    3.1.0
  - setBandwidth
```
public void setBandwidth(FreqM value)
```
    Set In Data Item Bandwidth, as an alternative to FreqMin/FreqMax, enter the total operating bandwidth of the Antenna centered around FreqMin..
    
    Parameters:
    
    value - a FreqM instance
    
    Since:
    
    3.1.0
  - isSetBandwidth
```
public boolean isSetBandwidth()
```
    Determine if the Bandwidth is configured.
    
    Returns:
    
    TRUE if the field is set, FALSE if the field is null
  - getFreqUse
```
public TString getFreqUse()
```
    Get if the frequency range is used for transmit, receive, or both transmit and receive..
    
    Returns:
    
    the FreqUse value in a TString data type
    
    Since:
    
    3.1.0
  - setFreqUse
```
public void setFreqUse(TString value)
```
    Set if the frequency range is used for transmit, receive, or both transmit and receive..
    
    Parameters:
    
    value - the FreqUse value in a TString data type
    
    Since:
    
    3.1.0
  - isSetFreqUse
```
public boolean isSetFreqUse()
```
    Determine if the FreqUse 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
  - withFreqMin
```
public AntFreqs withFreqMin(Double value)
```
    Set the nominal frequency or minimum value of the frequency range.
    
    Parameters:
    
    value - An instances of type Double.
    
    Returns:
    
    The current AntFreqs object instance.
    
    Since:
    
    3.1.0
  - withFreqMax
```
public AntFreqs withFreqMax(Double value)
```
    Set the maximum value of the frequencies in the range.
    [XSL ERR MINMAX] If FreqMax is used, it MUST be greater than FreqMin.
    
    Parameters:
    
    value - An instances of type Double.
    
    Returns:
    
    The current AntFreqs object instance.
    
    Since:
    
    3.1.0
  - withBandwidth
```
public AntFreqs withBandwidth(Double value)
```
    Set In Data Item Bandwidth, as an alternative to FreqMin/FreqMax, enter the total operating bandwidth of the Antenna centered around FreqMin.
    
    Parameters:
    
    value - An instances of type Double.
    
    Returns:
    
    The current AntFreqs object instance.
    
    Since:
    
    3.1.0
  - withFreqUse
```
public AntFreqs withFreqUse(ListCAU value)
```
    Set if the frequency range is used for transmit, receive, or both transmit and receive.
    
    Parameters:
    
    value - An instances of type ListCAU.
    
    Returns:
    
    The current AntFreqs object instance.
    
    Since:
    
    3.1.0
  - toString
```
public String toString()
```
    Get a string representation of this AntFreqs 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.
    AntFreqs requires FreqMin.
    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 AntFreqs

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AntFreqs

Method Detail

getFreqMin

setFreqMin

isSetFreqMin

getFreqMax

setFreqMax

isSetFreqMax

getBandwidth

setBandwidth

isSetBandwidth

getFreqUse

setFreqUse

isSetFreqUse

withFreqMin

withFreqMax

withBandwidth

withFreqUse

toString

isSet