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

Class Tuning

java.lang.Object

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

public class Tuning
extends Object

Tuning indicates the specific frequency or range of frequencies, tuning increment, and number of frequencies, required for an assignment.

Element of Link

Sub-Element is RequestedFreq

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
Tuning()

Method Summary

Modifier and Type	Method and Description
TString	getExclusive() Get Yes if the assigned frequency should not be reused within the area of exercise/operation..
FreqM	getFreqSep() Get the required minimum or exact frequency separation..
TString	getFreqSepType() Get if the stated frequency separation is an exact or minimum value..
UN4	getNumFreq() Get the number of frequencies required..
UN1	getPriority() Get a number from 0 to 9 that is used to influence the positioning of the Assignment in the ordering of the assignment process, where 9 represents the highest priority and 0 is the lowest priority..
Set<AsgnFreqBase>	getRequestedFreq() Get the RequestedFreq
FreqM	getTuningStep() Get the tuning increment expressed of the requested frequency range.
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetExclusive() Determine if the Exclusive is configured.
boolean	isSetFreqSep() Determine if the FreqSep is configured.
boolean	isSetFreqSepType() Determine if the FreqSepType is configured.
boolean	isSetNumFreq() Determine if the NumFreq is configured.
boolean	isSetPriority() Determine if the Priority is configured.
boolean	isSetRequestedFreq() Determine if the RequestedFreq is configured.
boolean	isSetTuningStep() Determine if the TuningStep is configured.
void	setExclusive(TString value) Set Yes if the assigned frequency should not be reused within the area of exercise/operation..
void	setFreqSep(FreqM value) Set the required minimum or exact frequency separation..
void	setFreqSepType(TString value) Set if the stated frequency separation is an exact or minimum value..
void	setNumFreq(UN4 value) Set the number of frequencies required..
void	setPriority(UN1 value) Set a number from 0 to 9 that is used to influence the positioning of the Assignment in the ordering of the assignment process, where 9 represents the highest priority and 0 is the lowest priority..
void	setTuningStep(FreqM value) Set the tuning increment expressed of the requested frequency range.
String	toString() Get a string representation of this Tuning instance configuration.
void	unsetRequestedFreq() Clear the RequestedFreq field.
Tuning	withExclusive(ListCBO value) Set Yes if the assigned frequency should not be reused within the area of exercise/operation.
Tuning	withFreqSep(Double value) Set the required minimum or exact frequency separation.
Tuning	withFreqSepType(ListCDS value) Set if the stated frequency separation is an exact or minimum value.
Tuning	withNumFreq(Integer value) Set the number of frequencies required.
Tuning	withPriority(Integer value) Set a number from 0 to 9 that is used to influence the positioning of the Assignment in the ordering of the assignment process, where 9 represents the highest priority and 0 is the lowest priority.
Tuning	withRequestedFreq(AsgnFreqBase... values) Set the Requested Freq: a single frequency or a range of frequencies.
Tuning	withRequestedFreq(Collection<AsgnFreqBase> values) Set the Requested Freq: a single frequency or a range of frequencies.
Tuning	withTuningStep(Double value) Set the tuning increment expressed of the requested frequency range.

Methods inherited from class java.lang.Object

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

Constructor Detail

Tuning

public Tuning()

Method Detail

getTuningStep

public FreqM getTuningStep()

Get the tuning increment expressed of the requested frequency range. This should be compatible with the tuning capability of the transmitters and/or receivers in the link..

Returns:

a FreqM instance

Since:

3.1.0

setTuningStep

public void setTuningStep(FreqM value)

Set the tuning increment expressed of the requested frequency range. This should be compatible with the tuning capability of the transmitters and/or receivers in the link..

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

getNumFreq

public UN4 getNumFreq()

Get the number of frequencies required..

Returns:

a UN4 instance

Since:

3.1.0

setNumFreq

public void setNumFreq(UN4 value)

Set the number of frequencies required..

Parameters:

value - a UN4 instance

Since:

3.1.0

isSetNumFreq

public boolean isSetNumFreq()

Determine if the NumFreq is configured.

Returns:

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

getPriority

public UN1 getPriority()

Get a number from 0 to 9 that is used to influence the positioning of the Assignment in the ordering of the assignment process, where 9 represents the highest priority and 0 is the lowest priority..

Returns:

a UN1 instance

Since:

3.1.0

setPriority

public void setPriority(UN1 value)

Set a number from 0 to 9 that is used to influence the positioning of the Assignment in the ordering of the assignment process, where 9 represents the highest priority and 0 is the lowest priority..

Parameters:

value - a UN1 instance

Since:

3.1.0

isSetPriority

public boolean isSetPriority()

Determine if the Priority is configured.

Returns:

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

getExclusive

public TString getExclusive()

Get Yes if the assigned frequency should not be reused within the area of exercise/operation..

Returns:

the Exclusive value in a TString data type

Since:

3.1.0

setExclusive

public void setExclusive(TString value)

Set Yes if the assigned frequency should not be reused within the area of exercise/operation..

Parameters:

value - the Exclusive value in a TString data type

Since:

3.1.0

isSetExclusive

public boolean isSetExclusive()

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

getFreqSep

public FreqM getFreqSep()

Get the required minimum or exact frequency separation..

Returns:

a FreqM instance

Since:

3.1.0

setFreqSep

public void setFreqSep(FreqM value)

Set the required minimum or exact frequency separation..

Parameters:

value - a FreqM instance

Since:

3.1.0

isSetFreqSep

public boolean isSetFreqSep()

Determine if the FreqSep is configured.

Returns:

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

getFreqSepType

public TString getFreqSepType()

Get if the stated frequency separation is an exact or minimum value..

Returns:

the FreqSepType value in a TString data type

Since:

3.1.0

setFreqSepType

public void setFreqSepType(TString value)

Set if the stated frequency separation is an exact or minimum value..

Parameters:

value - the FreqSepType value in a TString data type

Since:

3.1.0

isSetFreqSepType

public boolean isSetFreqSepType()

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

getRequestedFreq

public Set<AsgnFreqBase> getRequestedFreq()

Get the RequestedFreq

Complex element RequestedFreq indicates a single frequency or a range of frequencies..

Returns:

a AsgnFreqBase instance

Since:

3.1.0

isSetRequestedFreq

public boolean isSetRequestedFreq()

Determine if the RequestedFreq is configured.

Returns:

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

unsetRequestedFreq

public void unsetRequestedFreq()

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

withTuningStep

public Tuning withTuningStep(Double value)

Set the tuning increment expressed of the requested frequency range. This should be compatible with the tuning capability of the transmitters and/or receivers in the link.

Parameters:

value - An instances of type Double.

Returns:

The current Tuning object instance.

Since:

3.1.0

withNumFreq

public Tuning withNumFreq(Integer value)

Set the number of frequencies required.

Parameters:

value - An instances of type Integer.

Returns:

The current Tuning object instance.

Since:

3.1.0

withPriority

public Tuning withPriority(Integer value)

Set a number from 0 to 9 that is used to influence the positioning of the Assignment in the ordering of the assignment process, where 9 represents the highest priority and 0 is the lowest priority.

Parameters:

value - An instances of type Integer.

Returns:

The current Tuning object instance.

Since:

3.1.0

withExclusive

public Tuning withExclusive(ListCBO value)

Set Yes if the assigned frequency should not be reused within the area of exercise/operation.

Parameters:

value - An instances of type ListCBO.

Returns:

The current Tuning object instance.

Since:

3.1.0

withFreqSep

public Tuning withFreqSep(Double value)

Set the required minimum or exact frequency separation.

Parameters:

value - An instances of type Double.

Returns:

The current Tuning object instance.

Since:

3.1.0

withFreqSepType

public Tuning withFreqSepType(ListCDS value)

Set if the stated frequency separation is an exact or minimum value.

Parameters:

value - An instances of type ListCDS.

Returns:

The current Tuning object instance.

Since:

3.1.0

withRequestedFreq

public Tuning withRequestedFreq(AsgnFreqBase... values)

Set the Requested Freq: a single frequency or a range of frequencies.

Parameters:

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

Returns:

The current Tuning object instance.

Since:

3.1.0

withRequestedFreq

public Tuning withRequestedFreq(Collection<AsgnFreqBase> values)

Set the Requested Freq: a single frequency or a range of frequencies.

Parameters:

values - A collection of AsgnFreqBase instances

Returns:

The current Tuning object instance.

Since:

3.1.0

toString

public String toString()

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

Tuning requires NumFreq, TuningStep.

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