us.gov.dod.standard.ssrf._3_1.allotment

Class AllotFreq

java.lang.Object

us.gov.dod.standard.ssrf._3_1.allotment.AllotFreq

public class AllotFreq
extends Object

AllotFreq defines a frequency or range of frequencies belonging to the Allotment.

Element of Allotment

Sub-Element is

Example: See Allotment.

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
AllotFreq()

Method Summary

Modifier and Type	Method and Description
S6	getAllotChannel() Get a TACAN channel or net number.
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..
Set<Location>	getLocationRestriction() Get .
Set<Serial>	getLocationRestrictionRef() Get the LocationRestriction
FreqM	getPairedFreqMin() Get the nominal frequency or minimum value of the frequency range, for the paired frequency or frequency range when the allotment is for a duplex system..
FreqM	getTuningStep() Get the tuning increment..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetAllotChannel() Determine if the AllotChannel is configured.
boolean	isSetFreqMax() Determine if the FreqMax is configured.
boolean	isSetFreqMin() Determine if the FreqMin is configured.
boolean	isSetLocationRestriction() Determine if the locationRestriction field is configured.
boolean	isSetLocationRestrictionRef() Determine if the LocationRestriction is configured.
boolean	isSetPairedFreqMin() Determine if the PairedFreqMin is configured.
boolean	isSetTuningStep() Determine if the TuningStep is configured.
void	postLoad(SSRF root) Update the SSRF data type references in this AllotFreq record after loading from XML.
void	prepare() Update the SSRF data type references in this AllotFreq record.
void	setAllotChannel(S6 value) Set a TACAN channel or net number.
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	setPairedFreqMin(FreqM value) Set the nominal frequency or minimum value of the frequency range, for the paired frequency or frequency range when the allotment is for a duplex system..
void	setTuningStep(FreqM value) Set the tuning increment..
String	toString() Get a string representation of this AllotFreq instance configuration.
void	unsetLocationRestrictionRef() Clear the LocationRestriction field.
AllotFreq	withAllotChannel(String value) Set a TACAN channel or net number
AllotFreq	withFreqMax(Double value) Set the maximum value of the frequencies in the range.
AllotFreq	withFreqMin(Double value) Set the nominal frequency or minimum value of the frequency range.
AllotFreq	withLocationRestriction(Collection<Location> values) Set
AllotFreq	withLocationRestriction(Location... values) Set
AllotFreq	withLocationRestrictionRef(Collection<Serial> values) Set the LocationRestriction
AllotFreq	withLocationRestrictionRef(Serial... values) Set the LocationRestriction
AllotFreq	withPairedFreqMin(Double value) Set the nominal frequency or minimum value of the frequency range, for the paired frequency or frequency range when the allotment is for a duplex system.
AllotFreq	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

AllotFreq

public AllotFreq()

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

getPairedFreqMin

public FreqM getPairedFreqMin()

Get the nominal frequency or minimum value of the frequency range, for the paired frequency or frequency range when the allotment is for a duplex system..

Returns:

a FreqM instance

Since:

3.1.0

setPairedFreqMin

public void setPairedFreqMin(FreqM value)

Set the nominal frequency or minimum value of the frequency range, for the paired frequency or frequency range when the allotment is for a duplex system..

Parameters:

value - a FreqM instance

Since:

3.1.0

isSetPairedFreqMin

public boolean isSetPairedFreqMin()

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

getAllotChannel

public S6 getAllotChannel()

Get a TACAN channel or net number.

Returns:

a S6 instance

Since:

3.1.0

setAllotChannel

public void setAllotChannel(S6 value)

Set a TACAN channel or net number.

Parameters:

value - a S6 instance

Since:

3.1.0

isSetAllotChannel

public boolean isSetAllotChannel()

Determine if the AllotChannel is configured.

Returns:

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

getLocationRestrictionRef

public Set<Serial> getLocationRestrictionRef()

Get the LocationRestriction

Complex element LocationRestriction indicates a Location where the Allotment usage is forbidden..

Returns:

a Serial instance

Since:

3.1.0

isSetLocationRestrictionRef

public boolean isSetLocationRestrictionRef()

Determine if the LocationRestriction is configured.

Returns:

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

unsetLocationRestrictionRef

public void unsetLocationRestrictionRef()

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

withFreqMin

public AllotFreq withFreqMin(Double value)

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

Parameters:

value - An instances of type Double.

Returns:

The current AllotFreq object instance.

Since:

3.1.0

withFreqMax

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

Since:

3.1.0

withPairedFreqMin

public AllotFreq withPairedFreqMin(Double value)

Set the nominal frequency or minimum value of the frequency range, for the paired frequency or frequency range when the allotment is for a duplex system.

Parameters:

value - An instances of type Double.

Returns:

The current AllotFreq object instance.

Since:

3.1.0

withTuningStep

public AllotFreq withTuningStep(Double value)

Set the tuning increment.

Parameters:

value - An instances of type Double.

Returns:

The current AllotFreq object instance.

Since:

3.1.0

withAllotChannel

public AllotFreq withAllotChannel(String value)

Set a TACAN channel or net number

Parameters:

value - An instances of type String.

Returns:

The current AllotFreq object instance.

Since:

3.1.0

withLocationRestrictionRef

public AllotFreq withLocationRestrictionRef(Serial... values)

Set the LocationRestriction

Complex element LocationRestriction indicates a Location where the Allotment usage is forbidden.

Parameters:

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

Returns:

The current AllotFreq object instance.

Since:

3.1.0

withLocationRestrictionRef

public AllotFreq withLocationRestrictionRef(Collection<Serial> values)

Set the LocationRestriction

Complex element LocationRestriction indicates a Location where the Allotment usage is forbidden.

Parameters:

values - A collection of Serial instances

Returns:

The current AllotFreq object instance.

Since:

3.1.0

toString

public String toString()

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

AllotFreq 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

getLocationRestriction

public Set<Location> getLocationRestriction()

Get .

Returns:

a Location instance

Since:

3.1.0

isSetLocationRestriction

public boolean isSetLocationRestriction()

Determine if the locationRestriction field is configured.

Returns:

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

withLocationRestriction

public AllotFreq withLocationRestriction(Location... values)

Set

Parameters:

values - An instances of type Location.

Returns:

The current AllotFreq object instance.

Since:

3.1.0

withLocationRestriction

public AllotFreq withLocationRestriction(Collection<Location> values)

Set

Parameters:

values - An instances of type Location.

Returns:

The current AllotFreq object instance.

Since:

3.1.0

prepare

public void prepare()

Update the SSRF data type references in this AllotFreq record.

This method builds the exported locationRestrictionRef field with values from the transient locationRestriction field. This method should typically be called after the AllotFreq is configured and (optionally) before exporting an SSRF message.

Since:

3.1.0

postLoad

public void postLoad(SSRF root)

Update the SSRF data type references in this AllotFreq record after loading from XML.

This method builds the transient locationRestriction with values from the imported locationRestrictionRef field. This method should typically be called after the AllotFreq is imported from XML.

Parameters:

root - the SSRF root instance.

Since:

3.1.0