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

Class FreqConversion

java.lang.Object

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

public class FreqConversion
extends Object

FreqConversion contains the characteristics of a frequency conversion stage: intermediate frequency (IF) and local oscillator (LO) parameters.

Element of RxMode

Example:

 <FreqConversion>
   <StageNum cls="U">3</StageNum>
   <OscillatorTuning cls="U">LO below RF</OscillatorTuning>
   <LOFreqMin cls="U">20</LOFreqMin>
   <IFMin cls="U">21.4</IFMin>
   <IFMax cls="U">70</IFMax>
 </FreqConversion>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
FreqConversion()

Method Summary

Modifier and Type	Method and Description
FreqM	getIFMax() Get the maximum value of the intermediate frequencies.
FreqM	getIFMin() Get the nominal intermediate frequency or minimum value of the intermediate frequency range..
FreqM	getLOFreqMax() Get the maximum value of the LO frequencies.
FreqM	getLOFreqMin() Get the nominal LO frequency or minimum value of the LO frequency range..
TString	getOscillatorTuning() Get the relationship between the local oscillator frequency and the RF centre frequency..
IFNum	getStageNum() Get the position of the IF stage being described..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetIFMax() Determine if the IFMax is configured.
boolean	isSetIFMin() Determine if the IFMin is configured.
boolean	isSetLOFreqMax() Determine if the LOFreqMax is configured.
boolean	isSetLOFreqMin() Determine if the LOFreqMin is configured.
boolean	isSetOscillatorTuning() Determine if the OscillatorTuning is configured.
boolean	isSetStageNum() Determine if the StageNum is configured.
void	setIFMax(FreqM value) Set the maximum value of the intermediate frequencies.
void	setIFMin(FreqM value) Set the nominal intermediate frequency or minimum value of the intermediate frequency range..
void	setLOFreqMax(FreqM value) Set the maximum value of the LO frequencies.
void	setLOFreqMin(FreqM value) Set the nominal LO frequency or minimum value of the LO frequency range..
void	setOscillatorTuning(TString value) Set the relationship between the local oscillator frequency and the RF centre frequency..
void	setStageNum(IFNum value) Set the position of the IF stage being described..
String	toString() Get a string representation of this FreqConversion instance configuration.
FreqConversion	withIFMax(Double value) Set the maximum value of the intermediate frequencies.
FreqConversion	withIFMin(Double value) Set the nominal intermediate frequency or minimum value of the intermediate frequency range.
FreqConversion	withLOFreqMax(Double value) Set the maximum value of the LO frequencies.
FreqConversion	withLOFreqMin(Double value) Set the nominal LO frequency or minimum value of the LO frequency range.
FreqConversion	withOscillatorTuning(ListCLO value) Set the relationship between the local oscillator frequency and the RF centre frequency.
FreqConversion	withStageNum(Integer value) Set the position of the IF stage being described.

Methods inherited from class java.lang.Object

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

Constructor Detail

FreqConversion

public FreqConversion()

Method Detail

getStageNum

public IFNum getStageNum()

Get the position of the IF stage being described..

Returns:

a IFNum instance

Since:

3.1.0

setStageNum

public void setStageNum(IFNum value)

Set the position of the IF stage being described..

Parameters:

value - a IFNum instance

Since:

3.1.0

isSetStageNum

public boolean isSetStageNum()

Determine if the StageNum is configured.

Returns:

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

getOscillatorTuning

public TString getOscillatorTuning()

Get the relationship between the local oscillator frequency and the RF centre frequency..

Returns:

the OscillatorTuning value in a TString data type

Since:

3.1.0

setOscillatorTuning

public void setOscillatorTuning(TString value)

Set the relationship between the local oscillator frequency and the RF centre frequency..

Parameters:

value - the OscillatorTuning value in a TString data type

Since:

3.1.0

isSetOscillatorTuning

public boolean isSetOscillatorTuning()

Determine if the OscillatorTuning 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

getLOFreqMin

public FreqM getLOFreqMin()

Get the nominal LO frequency or minimum value of the LO frequency range..

Returns:

a FreqM instance

Since:

3.1.0

setLOFreqMin

public void setLOFreqMin(FreqM value)

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

Parameters:

value - a FreqM instance

Since:

3.1.0

isSetLOFreqMin

public boolean isSetLOFreqMin()

Determine if the LOFreqMin is configured.

Returns:

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

getLOFreqMax

public FreqM getLOFreqMax()

Get the maximum value of the LO frequencies.

[XSL ERR MINMAX] If LOFreqMax is used, it MUST be greater than LOFreqMin..

Returns:

a FreqM instance

Since:

3.1.0

setLOFreqMax

public void setLOFreqMax(FreqM value)

Set the maximum value of the LO frequencies.

[XSL ERR MINMAX] If LOFreqMax is used, it MUST be greater than LOFreqMin..

Parameters:

value - a FreqM instance

Since:

3.1.0

isSetLOFreqMax

public boolean isSetLOFreqMax()

Determine if the LOFreqMax is configured.

Returns:

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

getIFMin

public FreqM getIFMin()

Get the nominal intermediate frequency or minimum value of the intermediate frequency range..

Returns:

a FreqM instance

Since:

3.1.0

setIFMin

public void setIFMin(FreqM value)

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

Parameters:

value - a FreqM instance

Since:

3.1.0

isSetIFMin

public boolean isSetIFMin()

Determine if the IFMin is configured.

Returns:

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

getIFMax

public FreqM getIFMax()

Get the maximum value of the intermediate frequencies.

[XSL ERR MINMAX] If IFMax is used, it MUST be greater than IFMin..

Returns:

a FreqM instance

Since:

3.1.0

setIFMax

public void setIFMax(FreqM value)

Set the maximum value of the intermediate frequencies.

[XSL ERR MINMAX] If IFMax is used, it MUST be greater than IFMin..

Parameters:

value - a FreqM instance

Since:

3.1.0

isSetIFMax

public boolean isSetIFMax()

Determine if the IFMax is configured.

Returns:

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

withStageNum

public FreqConversion withStageNum(Integer value)

Set the position of the IF stage being described.

Parameters:

value - An instances of type Integer.

Returns:

The current FreqConversion object instance.

Since:

3.1.0

withOscillatorTuning

public FreqConversion withOscillatorTuning(ListCLO value)

Set the relationship between the local oscillator frequency and the RF centre frequency.

Parameters:

value - An instances of type ListCLO.

Returns:

The current FreqConversion object instance.

Since:

3.1.0

withLOFreqMin

public FreqConversion withLOFreqMin(Double value)

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

Parameters:

value - An instances of type Double.

Returns:

The current FreqConversion object instance.

Since:

3.1.0

withLOFreqMax

public FreqConversion withLOFreqMax(Double value)

Set the maximum value of the LO frequencies.

[XSL ERR MINMAX] If LOFreqMax is used, it MUST be greater than LOFreqMin.

Parameters:

value - An instances of type Double.

Returns:

The current FreqConversion object instance.

Since:

3.1.0

withIFMin

public FreqConversion withIFMin(Double value)

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

Parameters:

value - An instances of type Double.

Returns:

The current FreqConversion object instance.

Since:

3.1.0

withIFMax

public FreqConversion withIFMax(Double value)

Set the maximum value of the intermediate frequencies.

[XSL ERR MINMAX] If IFMax is used, it MUST be greater than IFMin.

Parameters:

value - An instances of type Double.

Returns:

The current FreqConversion object instance.

Since:

3.1.0

toString

public String toString()

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

FreqConversion has no configuration requirements.

Returns:

TRUE