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

Class Link

java.lang.Object

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

public class Link
extends Object

Link identifies each link in a system of assignments. This is the top element of each Link. The exact definition of a link is very flexible and depends on the degree of accuracy needed for the assignment. A link can be very generic (one or several base stations serving an area or a volume with non-defined mobiles) to very accurate (such as one link for each radio-relay hop).

Element of Assignment

Sub-Elements are Assigned, DCSTrunk, DetailedFunctionID, StationConfig, Tuning

Example:

 <Link>
   <LinkID cls="U">LINK1</LinkID>
   <StationConfig>
     <Type cls="U">Transmit-Receive</Type>
     <ConfigID cls="U">CONFIG1</ConfigID>
     <StationID cls="U">STATION1</StationID>
   </StationConfig>
   <Assigned>
     <Freq>
       <FreqMin cls="U">256.275</FreqMin>
     </Freq>
   </Assigned>
 </Link>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
Link()

Method Summary

Modifier and Type	Method and Description
Set<Assigned>	getAssigned() Get the Assigned
Set<DCSTrunk>	getDCSTrunk() Get the US:DCSTrunk
Set<DetailedFunction>	getDetailedFunction() Get .
TString	getFunction() Get Data item Function is not used by US except when exchanging with NATO.
TString	getIntermediateFunction() Get .
S100	getLinkID() Get a unique identifier for the link.
S25	getLinkName() Get a human readable name of the link..
TString	getMajorFunction() Get the major (or primary) function of the frequency assignment..
Set<StationConfig>	getStationConfig() Get the StationConfig
Set<Tuning>	getTuning() Get the Tuning
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetAssigned() Determine if the Assigned is configured.
boolean	isSetDCSTrunk() Determine if the DCSTrunk is configured.
boolean	isSetDetailedFunction() Determine if the DetailedFunction is configured.
boolean	isSetFunction() Determine if the Function is configured.
boolean	isSetIntermediateFunction() Determine if the IntermediateFunction is configured.
boolean	isSetLinkID() Determine if the LinkID is configured.
boolean	isSetLinkName() Determine if the LinkName is configured.
boolean	isSetMajorFunction() Determine if the MajorFunction is configured.
boolean	isSetStationConfig() Determine if the StationConfig is configured.
boolean	isSetTuning() Determine if the Tuning is configured.
void	setFunction(TString value) Set Data item Function is not used by US except when exchanging with NATO.
void	setIntermediateFunction(TString value) Set .
void	setLinkID(S100 value) Set a unique identifier for the link.
void	setLinkName(S25 value) Set a human readable name of the link..
void	setMajorFunction(TString value) Set the major (or primary) function of the frequency assignment..
String	toString() Get a string representation of this Link instance configuration.
void	unsetAssigned() Clear the Assigned field.
void	unsetDCSTrunk() Clear the DCSTrunk field.
void	unsetDetailedFunction() Clear the DetailedFunction field.
void	unsetStationConfig() Clear the StationConfig field.
void	unsetTuning() Clear the Tuning field.
Link	withAssigned(Assigned... values) Set the Assigned
Link	withAssigned(Collection<Assigned> values) Set the Assigned
Link	withDCSTrunk(Collection<DCSTrunk> values) Set the US:DCSTrunk
Link	withDCSTrunk(DCSTrunk... values) Set the US:DCSTrunk
Link	withDetailedFunction(Collection<DetailedFunction> values) Set
Link	withDetailedFunction(DetailedFunction... values) Set
Link	withFunction(ListCFN value) Set Data item Function is not used by US except when exchanging with NATO.
Link	withIntermediateFunction(ListUFN value) Set
Link	withLinkID(String value) Set a unique identifier for the link.
Link	withLinkName(String value) Set a human readable name of the link.
Link	withMajorFunction(ListUFN value) Set the major (or primary) function of the frequency assignment.
Link	withStationConfig(Collection<StationConfig> values) Set the StationConfig
Link	withStationConfig(StationConfig... values) Set the StationConfig
Link	withTuning(Collection<Tuning> values) Set the Tuning
Link	withTuning(Tuning... values) Set the Tuning

Methods inherited from class java.lang.Object

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

Constructor Detail

Link

public Link()

Method Detail

getLinkID

public S100 getLinkID()

Get a unique identifier for the link. This identifier should be a meaningful identification of the link, but may also be automatically generated. The identifier SHOULD NOT be modified during the lifetime of the dataset..

Returns:

a S100 instance

Since:

3.1.0

setLinkID

public void setLinkID(S100 value)

Set a unique identifier for the link. This identifier should be a meaningful identification of the link, but may also be automatically generated. The identifier SHOULD NOT be modified during the lifetime of the dataset..

Parameters:

value - a S100 instance

Since:

3.1.0

isSetLinkID

public boolean isSetLinkID()

Determine if the LinkID is configured.

Returns:

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

getFunction

public TString getFunction()

Get Data item Function is not used by US except when exchanging with NATO.

NATO Definition: Enter the primary, intermediate and optionally detailed function identifiers of the frequency assignment. The primary identifier indicates the type of operations (ground, air, maritime, C3); the intermediate identifier indicates the function; the detailed identifier is not normally used, but may be used to indicate for example some specific system.

US-Only: When sending data to SMADEF, enter UNKNOWN in Function If desired, add a Remark with US:MajorFunction, US:IntermedFunction, and US:DetailedFunction(s) separated by dashes. When receiving data from SMADEF, the contents SHOULD be parsed into US:MajorFunction, US:IntermedFunction, and US:DetailedFunction, in order of appearance..

Returns:

the Function value in a TString data type

Since:

3.1.0

setFunction

public void setFunction(TString value)

Set Data item Function is not used by US except when exchanging with NATO.

NATO Definition: Enter the primary, intermediate and optionally detailed function identifiers of the frequency assignment. The primary identifier indicates the type of operations (ground, air, maritime, C3); the intermediate identifier indicates the function; the detailed identifier is not normally used, but may be used to indicate for example some specific system.

US-Only: When sending data to SMADEF, enter UNKNOWN in Function If desired, add a Remark with US:MajorFunction, US:IntermedFunction, and US:DetailedFunction(s) separated by dashes. When receiving data from SMADEF, the contents SHOULD be parsed into US:MajorFunction, US:IntermedFunction, and US:DetailedFunction, in order of appearance..

Parameters:

value - the Function value in a TString data type

Since:

3.1.0

isSetFunction

public boolean isSetFunction()

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

getIntermediateFunction

public TString getIntermediateFunction()

Get .

Returns:

the IntermediateFunction value in a TString data type

Since:

3.1.0

setIntermediateFunction

public void setIntermediateFunction(TString value)

Set .

Parameters:

value - the IntermediateFunction value in a TString data type

Since:

3.1.0

isSetIntermediateFunction

public boolean isSetIntermediateFunction()

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

getMajorFunction

public TString getMajorFunction()

Get the major (or primary) function of the frequency assignment..

Returns:

the MajorFunction value in a TString data type

Since:

3.1.0

setMajorFunction

public void setMajorFunction(TString value)

Set the major (or primary) function of the frequency assignment..

Parameters:

value - the MajorFunction value in a TString data type

Since:

3.1.0

isSetMajorFunction

public boolean isSetMajorFunction()

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

getLinkName

public S25 getLinkName()

Get a human readable name of the link..

Returns:

a S25 instance

Since:

3.1.0

setLinkName

public void setLinkName(S25 value)

Set a human readable name of the link..

Parameters:

value - a S25 instance

Since:

3.1.0

isSetLinkName

public boolean isSetLinkName()

Determine if the LinkName is configured.

Returns:

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

getTuning

public Set<Tuning> getTuning()

Get the Tuning

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

Returns:

a Tuning instance

Since:

3.1.0

isSetTuning

public boolean isSetTuning()

Determine if the Tuning is configured.

Returns:

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

unsetTuning

public void unsetTuning()

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

getStationConfig

public Set<StationConfig> getStationConfig()

Get the StationConfig

Complex element StationConfig describes one couple (station, configuration) used for transmitting and/or receiving in the current Link. It may also contain additional antenna pointing/blanking parameters..

Returns:

a StationConfig instance

Since:

3.1.0

isSetStationConfig

public boolean isSetStationConfig()

Determine if the StationConfig is configured.

Returns:

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

unsetStationConfig

public void unsetStationConfig()

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

getAssigned

public Set<Assigned> getAssigned()

Get the Assigned

Complex element Assigned contains the assigned frequency(ies), channel or net number; it can also contain the old frequency..

Returns:

a Assigned instance

Since:

3.1.0

isSetAssigned

public boolean isSetAssigned()

Determine if the Assigned is configured.

Returns:

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

unsetAssigned

public void unsetAssigned()

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

getDCSTrunk

public Set<DCSTrunk> getDCSTrunk()

Get the US:DCSTrunk

Complex element DCSTrunk (US) is the Defense Communications System (DCS) trunk identifier for a specific "trunked" system. The identifier is assigned by the Defense Information Systems Agency (DISA)..

Returns:

a DCSTrunk instance

Since:

3.1.0

isSetDCSTrunk

public boolean isSetDCSTrunk()

Determine if the DCSTrunk is configured.

Returns:

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

unsetDCSTrunk

public void unsetDCSTrunk()

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

getDetailedFunction

public Set<DetailedFunction> getDetailedFunction()

Get .

Returns:

a DetailedFunction instance

Since:

3.1.0

isSetDetailedFunction

public boolean isSetDetailedFunction()

Determine if the DetailedFunction is configured.

Returns:

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

unsetDetailedFunction

public void unsetDetailedFunction()

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

withLinkID

public Link withLinkID(String value)

Set a unique identifier for the link. This identifier should be a meaningful identification of the link, but may also be automatically generated. The identifier SHOULD NOT be modified during the lifetime of the dataset.

Parameters:

value - An instances of type String.

Returns:

The current Link object instance.

Since:

3.1.0

withFunction

public Link withFunction(ListCFN value)

Set Data item Function is not used by US except when exchanging with NATO.

NATO Definition: Enter the primary, intermediate and optionally detailed function identifiers of the frequency assignment. The primary identifier indicates the type of operations (ground, air, maritime, C3); the intermediate identifier indicates the function; the detailed identifier is not normally used, but may be used to indicate for example some specific system.

US-Only: When sending data to SMADEF, enter UNKNOWN in Function If desired, add a Remark with US:MajorFunction, US:IntermedFunction, and US:DetailedFunction(s) separated by dashes. When receiving data from SMADEF, the contents SHOULD be parsed into US:MajorFunction, US:IntermedFunction, and US:DetailedFunction, in order of appearance.

Parameters:

value - An instances of type ListCFN.

Returns:

The current Link object instance.

Since:

3.1.0

withIntermediateFunction

public Link withIntermediateFunction(ListUFN value)

Set

Parameters:

value - An instances of type ListUFN.

Returns:

The current Link object instance.

Since:

3.1.0

withMajorFunction

public Link withMajorFunction(ListUFN value)

Set the major (or primary) function of the frequency assignment.

Parameters:

value - An instances of type ListUFN.

Returns:

The current Link object instance.

Since:

3.1.0

withLinkName

public Link withLinkName(String value)

Set a human readable name of the link.

Parameters:

value - An instances of type String.

Returns:

The current Link object instance.

Since:

3.1.0

withTuning

public Link withTuning(Tuning... values)

Set the Tuning

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

Parameters:

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

Returns:

The current Link object instance.

Since:

3.1.0

withTuning

public Link withTuning(Collection<Tuning> values)

Set the Tuning

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

Parameters:

values - A collection of Tuning instances

Returns:

The current Link object instance.

Since:

3.1.0

withStationConfig

public Link withStationConfig(StationConfig... values)

Set the StationConfig

Complex element StationConfig describes one couple (station, configuration) used for transmitting and/or receiving in the current Link. It may also contain additional antenna pointing/blanking parameters.

Parameters:

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

Returns:

The current Link object instance.

Since:

3.1.0

withStationConfig

public Link withStationConfig(Collection<StationConfig> values)

Set the StationConfig

Complex element StationConfig describes one couple (station, configuration) used for transmitting and/or receiving in the current Link. It may also contain additional antenna pointing/blanking parameters.

Parameters:

values - A collection of StationConfig instances

Returns:

The current Link object instance.

Since:

3.1.0

withAssigned

public Link withAssigned(Assigned... values)

Set the Assigned

Complex element Assigned contains the assigned frequency(ies), channel or net number; it can also contain the old frequency.

Parameters:

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

Returns:

The current Link object instance.

Since:

3.1.0

withAssigned

public Link withAssigned(Collection<Assigned> values)

Set the Assigned

Complex element Assigned contains the assigned frequency(ies), channel or net number; it can also contain the old frequency.

Parameters:

values - A collection of Assigned instances

Returns:

The current Link object instance.

Since:

3.1.0

withDCSTrunk

public Link withDCSTrunk(DCSTrunk... values)

Set the US:DCSTrunk

Complex element DCSTrunk (US) is the Defense Communications System (DCS) trunk identifier for a specific "trunked" system. The identifier is assigned by the Defense Information Systems Agency (DISA).

Parameters:

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

Returns:

The current Link object instance.

Since:

3.1.0

withDCSTrunk

public Link withDCSTrunk(Collection<DCSTrunk> values)

Set the US:DCSTrunk

Complex element DCSTrunk (US) is the Defense Communications System (DCS) trunk identifier for a specific "trunked" system. The identifier is assigned by the Defense Information Systems Agency (DISA).

Parameters:

values - A collection of DCSTrunk instances

Returns:

The current Link object instance.

Since:

3.1.0

withDetailedFunction

public Link withDetailedFunction(DetailedFunction... values)

Set

Parameters:

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

Returns:

The current Link object instance.

Since:

3.1.0

withDetailedFunction

public Link withDetailedFunction(Collection<DetailedFunction> values)

Set

Parameters:

values - A collection of DetailedFunction instances

Returns:

The current Link object instance.

Since:

3.1.0

toString

public String toString()

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

Link requires LinkID, StationConfig.

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