us.gov.dod.standard.ssrf._3_1.receiver

Class RxSignalTuning

java.lang.Object

us.gov.dod.standard.ssrf._3_1.receiver.RxSignalTuning

public class RxSignalTuning
extends Object

RxSignalTuning indicates the tuning capabilities, the specific frequency or range of frequencies within which the equipment may tune, and the tuning increments of the equipment.

Element of RxMode

Example:

 <RxSignalTuning>
   <FreqMax  cls="U">3107.56</FreqMax >
   <FreqMin  cls="U">2999.753</FreqMin >
   <NumPresetChannels  cls="U">45</NumPresetChannels >
   <TuningStep  cls="U">0.025</TuningStep >
 </RxSignalTuning>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
RxSignalTuning()

Method Summary

Modifier and Type	Method and Description
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..
UN8	getNumPresetChannels() Get the number of preset channels available..
FreqM	getTuningStep() Get the tuning increment..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetFreqMax() Determine if the FreqMax is configured.
boolean	isSetFreqMin() Determine if the FreqMin is configured.
boolean	isSetNumPresetChannels() Determine if the NumPresetChannels is configured.
boolean	isSetTuningStep() Determine if the TuningStep is configured.
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	setNumPresetChannels(UN8 value) Set the number of preset channels available..
void	setTuningStep(FreqM value) Set the tuning increment..
String	toString() Get a string representation of this RxSignalTuning instance configuration.
RxSignalTuning	withFreqMax(Double value) Set the maximum value of the frequencies in the range.
RxSignalTuning	withFreqMin(Double value) Set the nominal frequency or minimum value of the frequency range.
RxSignalTuning	withNumPresetChannels(Integer value) Set the number of preset channels available.
RxSignalTuning	withTuningStep(Double value) Set the tuning increment.

Methods inherited from class java.lang.Object

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

Constructor Detail

RxSignalTuning

public RxSignalTuning()

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

getTuningStep

public FreqM getTuningStep()

Get the tuning increment..

Returns:

a FreqM instance

Since:

3.1.0

setTuningStep

public void setTuningStep(FreqM value)

Set the tuning increment..

Parameters:

value - a FreqM instance

Since:

3.1.0

isSetTuningStep

public boolean isSetTuningStep()

Determine if the TuningStep is configured.

Returns:

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

getNumPresetChannels

public UN8 getNumPresetChannels()

Get the number of preset channels available..

Returns:

a UN8 instance

Since:

3.1.0

setNumPresetChannels

public void setNumPresetChannels(UN8 value)

Set the number of preset channels available..

Parameters:

value - a UN8 instance

Since:

3.1.0

isSetNumPresetChannels

public boolean isSetNumPresetChannels()

Determine if the NumPresetChannels is configured.

Returns:

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

withFreqMin

public RxSignalTuning withFreqMin(Double value)

Set the nominal frequency or minimum value of the frequency range.

Parameters:

value - An instances of type Double.

Returns:

The current RxSignalTuning object instance.

Since:

3.1.0

withFreqMax

public RxSignalTuning 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 RxSignalTuning object instance.

Since:

3.1.0

withTuningStep

public RxSignalTuning withTuningStep(Double value)

Set the tuning increment.

Parameters:

value - An instances of type Double.

Returns:

The current RxSignalTuning object instance.

Since:

3.1.0

withNumPresetChannels

public RxSignalTuning withNumPresetChannels(Integer value)

Set the number of preset channels available.

Parameters:

value - An instances of type Integer.

Returns:

The current RxSignalTuning object instance.

Since:

3.1.0

toString

public String toString()

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

RxSignalTuning 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