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

Class Curve

java.lang.Object

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

public class Curve
extends Object

Curve defines the type of curve. It contains an indication as to whether the values were measured or calculated, the numeric factor to be applied to the carrier frequency to find the abscissa of the curve, a frequency to be added to the carrier frequency to obtain the origin of the curve, and the measurement bandwidth.

Element of Receiver, Transmitter

Sub-Element is CurvePoint

Example:

 <Curve idx="1">
   <Type cls="U">Tx RF Spectrum</Type>
   <Calculated cls="U">No</Calculated>
   <FreqFactor cls="U">1</FreqFactor>
   <FreqConst cls="U">0</FreqConst>
   <Bw cls="U">0.001</Bw>
   <CurvePoint>
     <Offset cls="U">0.025</Offset>
     <Level cls="U">-3</Level>
   </CurvePoint>
   <CurvePoint>
     <Offset cls="U">0.05</Offset>
     <Level cls="U">-20</Level>
   </CurvePoint>
   <CurvePoint>
     <Offset cls="U">0.1</Offset>
     <Level cls="U">-40</Level>
   </CurvePoint>
   <CurvePoint>
     <Offset cls="U">1</Offset>
     <Level cls="U">-60</Level>
   </CurvePoint>
 </Curve>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
Curve()

Method Summary

Modifier and Type	Method and Description
FreqM	getBw() Get the bandwidth measurement of the curve values..
TString	getCalculated() Get Yes to indicate that the data was calculated, or "No" if the data is issued from measurement.
Set<CurvePoint>	getCurvePoint() Get the CurvePoint
FreqOffset	getFreqConst() Get a frequency offset (positive or negative)..
UN3_1	getFreqFactor() Get a positive numeric multiplier of the carrier frequency.
FreqM	getFreqMax() Get the highest value of the curve frequency range.
FreqM	getFreqMin() Get the lowest value of the curve frequency range..
BigInteger	getIdx() Get a unique index for each Curve used by this Dataset.
TString	getType() Get a code defining the type of curve..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetBw() Determine if the Bw is configured.
boolean	isSetCalculated() Determine if the Calculated is configured.
boolean	isSetCurvePoint() Determine if the CurvePoint is configured.
boolean	isSetFreqConst() Determine if the FreqConst is configured.
boolean	isSetFreqFactor() Determine if the FreqFactor is configured.
boolean	isSetFreqMax() Determine if the FreqMax is configured.
boolean	isSetFreqMin() Determine if the FreqMin is configured.
boolean	isSetIdx() Determine if the Idx is configured.
boolean	isSetType() Determine if the Type is configured.
void	setBw(FreqM value) Set the bandwidth measurement of the curve values..
void	setCalculated(TString value) Set Yes to indicate that the data was calculated, or "No" if the data is issued from measurement.
void	setFreqConst(FreqOffset value) Set a frequency offset (positive or negative)..
void	setFreqFactor(UN3_1 value) Set a positive numeric multiplier of the carrier frequency.
void	setFreqMax(FreqM value) Set the highest value of the curve frequency range.
void	setFreqMin(FreqM value) Set the lowest value of the curve frequency range..
void	setIdx(BigInteger value) Set a unique index for each Curve used by this Dataset.
void	setType(TString value) Set a code defining the type of curve..
String	toString() Get a string representation of this Curve instance configuration.
void	unsetCurvePoint() Clear the CurvePoint field.
Curve	withBw(Double value) Set the bandwidth measurement of the curve values.
Curve	withCalculated(ListCBO value) Set Yes to indicate that the data was calculated, or "No" if the data is issued from measurement.
Curve	withCurvePoint(Collection<CurvePoint> values) Set the CurvePoint
Curve	withCurvePoint(CurvePoint... values) Set the CurvePoint
Curve	withFreqConst(Double value) Set a frequency offset (positive or negative).
Curve	withFreqFactor(Double value) Set a positive numeric multiplier of the carrier frequency.
Curve	withFreqMax(Double value) Set the highest value of the curve frequency range.
Curve	withFreqMin(Double value) Set the lowest value of the curve frequency range.
Curve	withIdx(BigInteger value) Set a unique index for each Curve used by this Dataset.
Curve	withType(ListCCT value) Set a code defining the type of curve.

Methods inherited from class java.lang.Object

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

Constructor Detail

Curve

public Curve()

Method Detail

getType

public TString getType()

Get a code defining the type of curve..

Returns:

the Type value in a TString data type

Since:

3.1.0

setType

public void setType(TString value)

Set a code defining the type of curve..

Parameters:

value - the Type value in a TString data type

Since:

3.1.0

isSetType

public boolean isSetType()

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

getFreqFactor

public UN3_1 getFreqFactor()

Get a positive numeric multiplier of the carrier frequency. For example, enter 0 to define a curve around the IF, or 1 to define a curve around the carrier frequency..

Returns:

a UN3_1 instance

Since:

3.1.0

setFreqFactor

public void setFreqFactor(UN3_1 value)

Set a positive numeric multiplier of the carrier frequency. For example, enter 0 to define a curve around the IF, or 1 to define a curve around the carrier frequency..

Parameters:

value - a UN3_1 instance

Since:

3.1.0

isSetFreqFactor

public boolean isSetFreqFactor()

Determine if the FreqFactor is configured.

Returns:

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

getFreqConst

public FreqOffset getFreqConst()

Get a frequency offset (positive or negative)..

Returns:

a FreqOffset instance

Since:

3.1.0

setFreqConst

public void setFreqConst(FreqOffset value)

Set a frequency offset (positive or negative)..

Parameters:

value - a FreqOffset instance

Since:

3.1.0

isSetFreqConst

public boolean isSetFreqConst()

Determine if the FreqConst is configured.

Returns:

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

getBw

public FreqM getBw()

Get the bandwidth measurement of the curve values..

Returns:

a FreqM instance

Since:

3.1.0

setBw

public void setBw(FreqM value)

Set the bandwidth measurement of the curve values..

Parameters:

value - a FreqM instance

Since:

3.1.0

isSetBw

public boolean isSetBw()

Determine if the Bw is configured.

Returns:

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

getFreqMin

public FreqM getFreqMin()

Get the lowest value of the curve frequency range..

Returns:

a FreqM instance

Since:

3.1.0

setFreqMin

public void setFreqMin(FreqM value)

Set the lowest value of the curve 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 highest value of the curve frequency 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 highest value of the curve frequency 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

getCurvePoint

public Set<CurvePoint> getCurvePoint()

Get the CurvePoint

Complex element CurvePoint contains the relative frequency to add to the curve origin to obtain the absolute frequency point on the curve, and the value in dB (relative to the carrier for a Tx characteristic, or relative to sensitivity for a Rx characteristic)..

Returns:

a CurvePoint instance

Since:

3.1.0

isSetCurvePoint

public boolean isSetCurvePoint()

Determine if the CurvePoint is configured.

Returns:

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

unsetCurvePoint

public void unsetCurvePoint()

Clear the CurvePoint field. This sets the field to null.

getIdx

public BigInteger getIdx()

Get a unique index for each Curve used by this Dataset. Once an idx is used it SHOULD NOT be modified during the lifetime of the Dataset; e.g., an element with idx=2 will keep idx=2 even if the first occurrence (idx=1) is deleted. .

Returns:

a BigInteger instance

Since:

3.1.0

setIdx

public void setIdx(BigInteger value)

Set a unique index for each Curve used by this Dataset. Once an idx is used it SHOULD NOT be modified during the lifetime of the Dataset; e.g., an element with idx=2 will keep idx=2 even if the first occurrence (idx=1) is deleted. .

Parameters:

value - a BigInteger instance

Since:

3.1.0

isSetIdx

public boolean isSetIdx()

Determine if the Idx is configured.

Returns:

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

withType

public Curve withType(ListCCT value)

Set a code defining the type of curve.

Parameters:

value - An instances of type ListCCT.

Returns:

The current Curve object instance.

Since:

3.1.0

withCalculated

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

Since:

3.1.0

withFreqFactor

public Curve withFreqFactor(Double value)

Set a positive numeric multiplier of the carrier frequency. For example, enter 0 to define a curve around the IF, or 1 to define a curve around the carrier frequency.

Parameters:

value - An instances of type Double.

Returns:

The current Curve object instance.

Since:

3.1.0

withFreqConst

public Curve withFreqConst(Double value)

Set a frequency offset (positive or negative).

Parameters:

value - An instances of type Double.

Returns:

The current Curve object instance.

Since:

3.1.0

withBw

public Curve withBw(Double value)

Set the bandwidth measurement of the curve values.

Parameters:

value - An instances of type Double.

Returns:

The current Curve object instance.

Since:

3.1.0

withFreqMin

public Curve withFreqMin(Double value)

Set the lowest value of the curve frequency range.

Parameters:

value - An instances of type Double.

Returns:

The current Curve object instance.

Since:

3.1.0

withFreqMax

public Curve withFreqMax(Double value)

Set the highest value of the curve frequency range.

[XSL ERR MINMAX] If FreqMax is used, it MUST be greater than FreqMin.

Parameters:

value - An instances of type Double.

Returns:

The current Curve object instance.

Since:

3.1.0

withCurvePoint

public Curve withCurvePoint(CurvePoint... values)

Set the CurvePoint

Complex element CurvePoint contains the relative frequency to add to the curve origin to obtain the absolute frequency point on the curve, and the value in dB (relative to the carrier for a Tx characteristic, or relative to sensitivity for a Rx characteristic).

Parameters:

values - One or more instances of type CurvePoint....

Returns:

The current Curve object instance.

Since:

3.1.0

withCurvePoint

public Curve withCurvePoint(Collection<CurvePoint> values)

Set the CurvePoint

Complex element CurvePoint contains the relative frequency to add to the curve origin to obtain the absolute frequency point on the curve, and the value in dB (relative to the carrier for a Tx characteristic, or relative to sensitivity for a Rx characteristic).

Parameters:

values - A collection of CurvePoint instances

Returns:

The current Curve object instance.

Since:

3.1.0

withIdx

public Curve withIdx(BigInteger value)

Set a unique index for each Curve used by this Dataset. Once an idx is used it SHOULD NOT be modified during the lifetime of the Dataset; e.g., an element with idx=2 will keep idx=2 even if the first occurrence (idx=1) is deleted.

Parameters:

value - An instances of type BigInteger.

Returns:

The current Curve object instance.

Since:

3.1.0

toString

public String toString()

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

Curve requires CurvePoint, FreqConst, FreqFactor, Type, idx.

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