us.gov.dod.standard.ssrf._3_1.assignment

Class Freq

java.lang.Object

us.gov.dod.standard.ssrf._3_1.AsgnFreqBase

us.gov.dod.standard.ssrf._3_1.assignment.Freq

public class Freq
extends AsgnFreqBase

Freq indicates a single assigned frequency or an assigned range of frequencies.

Element of Assigned

Sub-Elements are NarrowBandPlanning, PairedFreq

Example:

 <Freq>
   <FreqMin cls="U">351.125</FreqMin>
   <LegacyNum cls="U">USAF11012345</LegacyNum>
 </Freq>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Field Summary

Fields inherited from class us.gov.dod.standard.ssrf._3_1.AsgnFreqBase

freqMax, freqMin, freqUse, refFreq

Constructor Summary

Constructors

Constructor and Description
Freq()

Method Summary

Modifier and Type	Method and Description
S20	getLegacyNum() Get a legacy reference number associated with the assigned frequency..
Set<NarrowBandPlanning>	getNarrowBandPlanning() Get the US:NarrowBandPlanning
Set<PairedFreq>	getPairedFreq() 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..
US5	getTAD() Get the TAD associated to the assigned frequency.
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetLegacyNum() Determine if the LegacyNum is configured.
boolean	isSetNarrowBandPlanning() Determine if the NarrowBandPlanning is configured.
boolean	isSetPairedFreq() Determine if the PairedFreq is configured.
boolean	isSetTAD() Determine if the TAD is configured.
void	setLegacyNum(S20 value) Set a legacy reference number associated with the assigned frequency..
void	setTAD(US5 value) Set the TAD associated to the assigned frequency.
String	toString() Get a string representation of this Freq instance configuration.
void	unsetNarrowBandPlanning() Clear the NarrowBandPlanning field.
void	unsetPairedFreq() Clear the PairedFreq field.
Freq	withLegacyNum(String value) Set a legacy reference number associated with the assigned frequency.
Freq	withNarrowBandPlanning(Collection<NarrowBandPlanning> values) Set the US:NarrowBandPlanning
Freq	withNarrowBandPlanning(NarrowBandPlanning... values) Set the US:NarrowBandPlanning
Freq	withPairedFreq(Collection<PairedFreq> values) 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.
Freq	withPairedFreq(PairedFreq... values) 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.
Freq	withTAD(String value) Set the TAD associated to the assigned frequency.

Methods inherited from class us.gov.dod.standard.ssrf._3_1.AsgnFreqBase

getFreqMax, getFreqMin, getFreqUse, getRefFreq, isSetFreqMax, isSetFreqMin, isSetFreqUse, isSetRefFreq, setFreqMax, setFreqMin, setFreqUse, setRefFreq, withFreqMax, withFreqMin, withFreqUse, withRefFreq

Methods inherited from class java.lang.Object

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

Constructor Detail

Freq

public Freq()

Method Detail

getTAD

public US5 getTAD()

Get the TAD associated to the assigned frequency. A Tactical Air Designator is a series of alphanumeric characters that can be used to identify air/ground/air or air/air frequency channels to prevent inadvertent disclosure of classified information..

Returns:

a US5 instance

Since:

3.1.0

setTAD

public void setTAD(US5 value)

Set the TAD associated to the assigned frequency. A Tactical Air Designator is a series of alphanumeric characters that can be used to identify air/ground/air or air/air frequency channels to prevent inadvertent disclosure of classified information..

Parameters:

value - a US5 instance

Since:

3.1.0

isSetTAD

public boolean isSetTAD()

Determine if the TAD is configured.

Returns:

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

getLegacyNum

public S20 getLegacyNum()

Get a legacy reference number associated with the assigned frequency..

Returns:

a S20 instance

Since:

3.1.0

setLegacyNum

public void setLegacyNum(S20 value)

Set a legacy reference number associated with the assigned frequency..

Parameters:

value - a S20 instance

Since:

3.1.0

isSetLegacyNum

public boolean isSetLegacyNum()

Determine if the LegacyNum is configured.

Returns:

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

getPairedFreq

public Set<PairedFreq> getPairedFreq()

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 PairedFreq instance

Since:

3.1.0

isSetPairedFreq

public boolean isSetPairedFreq()

Determine if the PairedFreq is configured.

Returns:

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

unsetPairedFreq

public void unsetPairedFreq()

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

getNarrowBandPlanning

public Set<NarrowBandPlanning> getNarrowBandPlanning()

Get the US:NarrowBandPlanning

Complex element NarrowBandPlanning (US) describes a reduced bandwidth assignment for a single frequency or a range of frequencies..

Returns:

a NarrowBandPlanning instance

Since:

3.1.0

isSetNarrowBandPlanning

public boolean isSetNarrowBandPlanning()

Determine if the NarrowBandPlanning is configured.

Returns:

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

unsetNarrowBandPlanning

public void unsetNarrowBandPlanning()

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

withTAD

public Freq withTAD(String value)

Set the TAD associated to the assigned frequency. A Tactical Air Designator is a series of alphanumeric characters that can be used to identify air/ground/air or air/air frequency channels to prevent inadvertent disclosure of classified information.

Parameters:

value - An instances of type String.

Returns:

The current Freq object instance.

Since:

3.1.0

withLegacyNum

public Freq withLegacyNum(String value)

Set a legacy reference number associated with the assigned frequency.

Parameters:

value - An instances of type String.

Returns:

The current Freq object instance.

Since:

3.1.0

withPairedFreq

public Freq withPairedFreq(PairedFreq... values)

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:

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

Returns:

The current Freq object instance.

Since:

3.1.0

withPairedFreq

public Freq withPairedFreq(Collection<PairedFreq> values)

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:

values - A collection of PairedFreq instances

Returns:

The current Freq object instance.

Since:

3.1.0

withNarrowBandPlanning

public Freq withNarrowBandPlanning(NarrowBandPlanning... values)

Set the US:NarrowBandPlanning

Complex element NarrowBandPlanning (US) describes a reduced bandwidth assignment for a single frequency or a range of frequencies.

Parameters:

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

Returns:

The current Freq object instance.

Since:

3.1.0

withNarrowBandPlanning

public Freq withNarrowBandPlanning(Collection<NarrowBandPlanning> values)

Set the US:NarrowBandPlanning

Complex element NarrowBandPlanning (US) describes a reduced bandwidth assignment for a single frequency or a range of frequencies.

Parameters:

values - A collection of NarrowBandPlanning instances

Returns:

The current Freq object instance.

Since:

3.1.0

toString

public String toString()

Get a string representation of this Freq instance configuration.

Overrides:

toString in class AsgnFreqBase

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.

Freq has no configuration requirements.

Overrides:

isSet in class AsgnFreqBase

Returns:

TRUE