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

Class Station

java.lang.Object

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

public class Station
extends Object

Station defines the station, or one of the stations, within the current Assignment dataset.

Element of Assignment

Sub-Elements are POCInformation, StationLoc

Example:

 <Station>
   <Name cls="U">Base Station</Name>
   <CallSign cls="U">WUH55</CallSign>
   <sub-elements/>
   </Station>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
Station()

Method Summary

Modifier and Type	Method and Description
AntHeight	getAntStructureHeight() Get the overall height, of the antenna support structure above ground level..
S20	getCallSign() Get the call sign assigned to the transmitting station.
FreqM	getCositeSep() Get the minimum required frequency separation between the equipment for which the assignment is being made and any other equipment operating at the same location.
MEMO	getCositeSepDescription() Get a free text description of the minimum required frequency separation between a number of transmitters, or between a transmitter and a related receiver in radio relay frequency requests..
UN9	getNumAreaUnits() Get the maximum number of units (equipment) that will be operating simultaneously in the same area of operation.
UN9	getNumCositedUnits() Get the maximum number of units (equipment) that will be operating simultaneously in the same cosite environment.
UN9	getNumMobileUnits() Get the number of mobile units (equipment).
Set<POCInformation>	getPOCInformation() Get the POCInformation
TString	getPrimaryStation() Get whether this station is the station of primary regulatory interest..
S18	getStationControl() Get the operating unit that controls the station when different than the assignment users..
S100	getStationID() Get the unique identifier of one of the stations used by this Assignment at this specific Station.
Set<StationLoc>	getStationLoc() Get the US:StationLoc
S100	getStationName() Get a short descriptive name for the station.
TSDFValue	getTSDF() Get .
S6	getUserCode() Get a code identifying the user of the station..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetAntStructureHeight() Determine if the AntStructureHeight is configured.
boolean	isSetCallSign() Determine if the CallSign is configured.
boolean	isSetCositeSep() Determine if the CositeSep is configured.
boolean	isSetCositeSepDescription() Determine if the CositeSepDescription is configured.
boolean	isSetNumAreaUnits() Determine if the NumAreaUnits is configured.
boolean	isSetNumCositedUnits() Determine if the NumCositedUnits is configured.
boolean	isSetNumMobileUnits() Determine if the NumMobileUnits is configured.
boolean	isSetPOCInformation() Determine if the POCInformation is configured.
boolean	isSetPrimaryStation() Determine if the PrimaryStation is configured.
boolean	isSetStationControl() Determine if the StationControl is configured.
boolean	isSetStationID() Determine if the StationID is configured.
boolean	isSetStationLoc() Determine if the StationLoc is configured.
boolean	isSetStationName() Determine if the StationName is configured.
boolean	isSetTSDF() Determine if the TSDF is configured.
boolean	isSetUserCode() Determine if the UserCode is configured.
void	setAntStructureHeight(AntHeight value) Set the overall height, of the antenna support structure above ground level..
void	setCallSign(S20 value) Set the call sign assigned to the transmitting station.
void	setCositeSep(FreqM value) Set the minimum required frequency separation between the equipment for which the assignment is being made and any other equipment operating at the same location.
void	setCositeSepDescription(MEMO value) Set a free text description of the minimum required frequency separation between a number of transmitters, or between a transmitter and a related receiver in radio relay frequency requests..
void	setNumAreaUnits(UN9 value) Set the maximum number of units (equipment) that will be operating simultaneously in the same area of operation.
void	setNumCositedUnits(UN9 value) Set the maximum number of units (equipment) that will be operating simultaneously in the same cosite environment.
void	setNumMobileUnits(UN9 value) Set the number of mobile units (equipment).
void	setPrimaryStation(TString value) Set whether this station is the station of primary regulatory interest..
void	setStationControl(S18 value) Set the operating unit that controls the station when different than the assignment users..
void	setStationID(S100 value) Set the unique identifier of one of the stations used by this Assignment at this specific Station.
void	setStationName(S100 value) Set a short descriptive name for the station.
void	setTSDF(TSDFValue value) Set .
void	setUserCode(S6 value) Set a code identifying the user of the station..
String	toString() Get a string representation of this Station instance configuration.
void	unsetPOCInformation() Clear the POCInformation field.
void	unsetStationLoc() Clear the StationLoc field.
Station	withAntStructureHeight(Integer value) Set the overall height, of the antenna support structure above ground level.
Station	withCallSign(String value) Set the call sign assigned to the transmitting station.
Station	withCositeSep(Double value) Set the minimum required frequency separation between the equipment for which the assignment is being made and any other equipment operating at the same location.
Station	withCositeSepDescription(String value) Set a free text description of the minimum required frequency separation between a number of transmitters, or between a transmitter and a related receiver in radio relay frequency requests.
Station	withNumAreaUnits(Integer value) Set the maximum number of units (equipment) that will be operating simultaneously in the same area of operation.
Station	withNumCositedUnits(Integer value) Set the maximum number of units (equipment) that will be operating simultaneously in the same cosite environment.
Station	withNumMobileUnits(Integer value) Set the number of mobile units (equipment).
Station	withPOCInformation(Collection<POCInformation> values) Set the POCInformation
Station	withPOCInformation(POCInformation... values) Set the POCInformation
Station	withPrimaryStation(ListCBO value) Set whether this station is the station of primary regulatory interest.
Station	withStationControl(String value) Set the operating unit that controls the station when different than the assignment users.
Station	withStationID(String value) Set the unique identifier of one of the stations used by this Assignment at this specific Station.
Station	withStationLoc(Collection<StationLoc> values) Set the US:StationLoc
Station	withStationLoc(StationLoc... values) Set the US:StationLoc
Station	withStationName(String value) Set a short descriptive name for the station.
Station	withTSDF(String value) Set
Station	withUserCode(String value) Set a code identifying the user of the station.

Methods inherited from class java.lang.Object

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

Constructor Detail

Station

public Station()

Method Detail

getStationID

public S100 getStationID()

Get the unique identifier of one of the stations used by this Assignment at this specific Station. A Station dataset may have more than one discrete station..

Returns:

a S100 instance

Since:

3.1.0

setStationID

public void setStationID(S100 value)

Set the unique identifier of one of the stations used by this Assignment at this specific Station. A Station dataset may have more than one discrete station..

Parameters:

value - a S100 instance

Since:

3.1.0

isSetStationID

public boolean isSetStationID()

Determine if the StationID is configured.

Returns:

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

getCallSign

public S20 getCallSign()

Get the call sign assigned to the transmitting station. It can be an internationally allocated call sign or the tactical call sign assigned by the operational authority when the Station is used within a Net. For navigational aids, enter the NAVAIDS identifier..

Returns:

a S20 instance

Since:

3.1.0

setCallSign

public void setCallSign(S20 value)

Set the call sign assigned to the transmitting station. It can be an internationally allocated call sign or the tactical call sign assigned by the operational authority when the Station is used within a Net. For navigational aids, enter the NAVAIDS identifier..

Parameters:

value - a S20 instance

Since:

3.1.0

isSetCallSign

public boolean isSetCallSign()

Determine if the CallSign is configured.

Returns:

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

getCositeSep

public FreqM getCositeSep()

Get the minimum required frequency separation between the equipment for which the assignment is being made and any other equipment operating at the same location. Enter: - For a fixed frequency assignment, the required frequency separation in MHz (without unit), between this equipment and other equipment operated at one location. If the frequency separation is unknown use the NATO recommended frequency separation requirements are listed below. 0.5 (MHz) for a transmitter power below 24.8 dBW (300 watts); 2 (MHz) for a transmitter power above 24.8 dBW (300 watts); 2.0 through 9.9 (MHz) for exceptionally high transmitter powers or difficult cosite constraints. - For a HAVE QUICK II or SATURN frequency hopping assignments, one of the following values: 0 - Instantaneous separation may be as small as 25 kHz; 4 - Minimum separation is 4 MHz; 8 - Minimum separation is 8 MHz; 12 - Minimum separation is 12 MHz.

Returns:

a FreqM instance

Since:

3.1.0

setCositeSep

public void setCositeSep(FreqM value)

Set the minimum required frequency separation between the equipment for which the assignment is being made and any other equipment operating at the same location. Enter: - For a fixed frequency assignment, the required frequency separation in MHz (without unit), between this equipment and other equipment operated at one location. If the frequency separation is unknown use the NATO recommended frequency separation requirements are listed below. 0.5 (MHz) for a transmitter power below 24.8 dBW (300 watts); 2 (MHz) for a transmitter power above 24.8 dBW (300 watts); 2.0 through 9.9 (MHz) for exceptionally high transmitter powers or difficult cosite constraints. - For a HAVE QUICK II or SATURN frequency hopping assignments, one of the following values: 0 - Instantaneous separation may be as small as 25 kHz; 4 - Minimum separation is 4 MHz; 8 - Minimum separation is 8 MHz; 12 - Minimum separation is 12 MHz.

Parameters:

value - a FreqM instance

Since:

3.1.0

isSetCositeSep

public boolean isSetCositeSep()

Determine if the CositeSep is configured.

Returns:

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

getCositeSepDescription

public MEMO getCositeSepDescription()

Get a free text description of the minimum required frequency separation between a number of transmitters, or between a transmitter and a related receiver in radio relay frequency requests..

Returns:

a MEMO instance

Since:

3.1.0

setCositeSepDescription

public void setCositeSepDescription(MEMO value)

Set a free text description of the minimum required frequency separation between a number of transmitters, or between a transmitter and a related receiver in radio relay frequency requests..

Parameters:

value - a MEMO instance

Since:

3.1.0

isSetCositeSepDescription

public boolean isSetCositeSepDescription()

Determine if the CositeSepDescription is configured.

Returns:

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

getNumMobileUnits

public UN9 getNumMobileUnits()

Get the number of mobile units (equipment). These units do not necessarily operate simultaneously in the same electromagnetic environment..

Returns:

a UN9 instance

Since:

3.1.0

setNumMobileUnits

public void setNumMobileUnits(UN9 value)

Set the number of mobile units (equipment). These units do not necessarily operate simultaneously in the same electromagnetic environment..

Parameters:

value - a UN9 instance

Since:

3.1.0

isSetNumMobileUnits

public boolean isSetNumMobileUnits()

Determine if the NumMobileUnits is configured.

Returns:

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

getNumAreaUnits

public UN9 getNumAreaUnits()

Get the maximum number of units (equipment) that will be operating simultaneously in the same area of operation. An area is generally defined as a country. enter the number of land mobile stations, ship stations, and transportable stations associated with the current Assignment or SSRequest dataset. Within an Assignment (but not under SSRequest), the number entered shall represent either the exact number of stations or a range of numbers as follows: Number of Stations Enter 1-10 10 11-30 30 31-100 100 101-300 300 301-1000 1000 1001-3000 3000 3001-10000 10000 Above 10000 Nearest 10000 If the exact number is to be recorded, and it is 10, 30, 100, 300, 1000, 3000, or a multiple of 10000, add one to the number to distinguish it from a figure that represents a range of numbers..

Returns:

a UN9 instance

Since:

3.1.0

setNumAreaUnits

public void setNumAreaUnits(UN9 value)

Set the maximum number of units (equipment) that will be operating simultaneously in the same area of operation. An area is generally defined as a country. enter the number of land mobile stations, ship stations, and transportable stations associated with the current Assignment or SSRequest dataset. Within an Assignment (but not under SSRequest), the number entered shall represent either the exact number of stations or a range of numbers as follows: Number of Stations Enter 1-10 10 11-30 30 31-100 100 101-300 300 301-1000 1000 1001-3000 3000 3001-10000 10000 Above 10000 Nearest 10000 If the exact number is to be recorded, and it is 10, 30, 100, 300, 1000, 3000, or a multiple of 10000, add one to the number to distinguish it from a figure that represents a range of numbers..

Parameters:

value - a UN9 instance

Since:

3.1.0

isSetNumAreaUnits

public boolean isSetNumAreaUnits()

Determine if the NumAreaUnits is configured.

Returns:

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

getNumCositedUnits

public UN9 getNumCositedUnits()

Get the maximum number of units (equipment) that will be operating simultaneously in the same cosite environment. A cosite situation occurs when several antennas are within the near field of each other..

Returns:

a UN9 instance

Since:

3.1.0

setNumCositedUnits

public void setNumCositedUnits(UN9 value)

Set the maximum number of units (equipment) that will be operating simultaneously in the same cosite environment. A cosite situation occurs when several antennas are within the near field of each other..

Parameters:

value - a UN9 instance

Since:

3.1.0

isSetNumCositedUnits

public boolean isSetNumCositedUnits()

Determine if the NumCositedUnits is configured.

Returns:

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

getTSDF

public TSDFValue getTSDF()

Get .

Returns:

the TSDF value in a TSDFValue data type

Since:

3.1.0

setTSDF

public void setTSDF(TSDFValue value)

Set .

Parameters:

value - the TSDF value in a TSDFValue data type

Since:

3.1.0

isSetTSDF

public boolean isSetTSDF()

Determine if the TSDF is configured.

If configured this method also inspects the TSDFValue wrapped value.

Returns:

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

getUserCode

public S6 getUserCode()

Get a code identifying the user of the station..

Returns:

a S6 instance

Since:

3.1.0

setUserCode

public void setUserCode(S6 value)

Set a code identifying the user of the station..

Parameters:

value - a S6 instance

Since:

3.1.0

isSetUserCode

public boolean isSetUserCode()

Determine if the UserCode is configured.

Returns:

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

getAntStructureHeight

public AntHeight getAntStructureHeight()

Get the overall height, of the antenna support structure above ground level..

Returns:

a AntHeight instance

Since:

3.1.0

setAntStructureHeight

public void setAntStructureHeight(AntHeight value)

Set the overall height, of the antenna support structure above ground level..

Parameters:

value - a AntHeight instance

Since:

3.1.0

isSetAntStructureHeight

public boolean isSetAntStructureHeight()

Determine if the AntStructureHeight is configured.

Returns:

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

getStationName

public S100 getStationName()

Get a short descriptive name for the station. This must be unique within the dataset..

Returns:

a S100 instance

Since:

3.1.0

setStationName

public void setStationName(S100 value)

Set a short descriptive name for the station. This must be unique within the dataset..

Parameters:

value - a S100 instance

Since:

3.1.0

isSetStationName

public boolean isSetStationName()

Determine if the StationName is configured.

Returns:

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

getStationControl

public S18 getStationControl()

Get the operating unit that controls the station when different than the assignment users..

Returns:

a S18 instance

Since:

3.1.0

setStationControl

public void setStationControl(S18 value)

Set the operating unit that controls the station when different than the assignment users..

Parameters:

value - a S18 instance

Since:

3.1.0

isSetStationControl

public boolean isSetStationControl()

Determine if the StationControl is configured.

Returns:

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

getPrimaryStation

public TString getPrimaryStation()

Get whether this station is the station of primary regulatory interest..

Returns:

the PrimaryStation value in a TString data type

Since:

3.1.0

setPrimaryStation

public void setPrimaryStation(TString value)

Set whether this station is the station of primary regulatory interest..

Parameters:

value - the PrimaryStation value in a TString data type

Since:

3.1.0

isSetPrimaryStation

public boolean isSetPrimaryStation()

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

getPOCInformation

public Set<POCInformation> getPOCInformation()

Get the POCInformation

Complex element POCInformation contains a reference to a Contact, Organisation or Role dataset..

Returns:

a POCInformation instance

Since:

3.1.0

isSetPOCInformation

public boolean isSetPOCInformation()

Determine if the POCInformation is configured.

Returns:

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

unsetPOCInformation

public void unsetPOCInformation()

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

getStationLoc

public Set<StationLoc> getStationLoc()

Get the US:StationLoc

Complex element Station (US) defines one or more transmitters or receivers or a combination of transmitters and receivers, including the accessory equipment necessary at one location for carrying on a radiocommunication, radiolocation, or other spectrum dependent function..

Returns:

a StationLoc instance

Since:

3.1.0

isSetStationLoc

public boolean isSetStationLoc()

Determine if the StationLoc is configured.

Returns:

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

unsetStationLoc

public void unsetStationLoc()

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

withStationID

public Station withStationID(String value)

Set the unique identifier of one of the stations used by this Assignment at this specific Station. A Station dataset may have more than one discrete station.

Parameters:

value - An instances of type String.

Returns:

The current Station object instance.

Since:

3.1.0

withCallSign

public Station withCallSign(String value)

Set the call sign assigned to the transmitting station. It can be an internationally allocated call sign or the tactical call sign assigned by the operational authority when the Station is used within a Net. For navigational aids, enter the NAVAIDS identifier.

Parameters:

value - An instances of type String.

Returns:

The current Station object instance.

Since:

3.1.0

withCositeSep

public Station withCositeSep(Double value)

Set the minimum required frequency separation between the equipment for which the assignment is being made and any other equipment operating at the same location. Enter: - For a fixed frequency assignment, the required frequency separation in MHz (without unit), between this equipment and other equipment operated at one location. If the frequency separation is unknown use the NATO recommended frequency separation requirements are listed below. 0.5 (MHz) for a transmitter power below 24.8 dBW (300 watts); 2 (MHz) for a transmitter power above 24.8 dBW (300 watts); 2.0 through 9.9 (MHz) for exceptionally high transmitter powers or difficult cosite constraints. - For a HAVE QUICK II or SATURN frequency hopping assignments, one of the following values: 0 - Instantaneous separation may be as small as 25 kHz; 4 - Minimum separation is 4 MHz; 8 - Minimum separation is 8 MHz; 12 - Minimum separation is 12 MHz

Parameters:

value - An instances of type Double.

Returns:

The current Station object instance.

Since:

3.1.0

withCositeSepDescription

public Station withCositeSepDescription(String value)

Set a free text description of the minimum required frequency separation between a number of transmitters, or between a transmitter and a related receiver in radio relay frequency requests.

Parameters:

value - An instances of type String.

Returns:

The current Station object instance.

Since:

3.1.0

withNumMobileUnits

public Station withNumMobileUnits(Integer value)

Set the number of mobile units (equipment). These units do not necessarily operate simultaneously in the same electromagnetic environment.

Parameters:

value - An instances of type Integer.

Returns:

The current Station object instance.

Since:

3.1.0

withNumAreaUnits

public Station withNumAreaUnits(Integer value)

Set the maximum number of units (equipment) that will be operating simultaneously in the same area of operation. An area is generally defined as a country. enter the number of land mobile stations, ship stations, and transportable stations associated with the current Assignment or SSRequest dataset. Within an Assignment (but not under SSRequest), the number entered shall represent either the exact number of stations or a range of numbers as follows: Number of Stations Enter 1-10 10 11-30 30 31-100 100 101-300 300 301-1000 1000 1001-3000 3000 3001-10000 10000 Above 10000 Nearest 10000 If the exact number is to be recorded, and it is 10, 30, 100, 300, 1000, 3000, or a multiple of 10000, add one to the number to distinguish it from a figure that represents a range of numbers.

Parameters:

value - An instances of type Integer.

Returns:

The current Station object instance.

Since:

3.1.0

withNumCositedUnits

public Station withNumCositedUnits(Integer value)

Set the maximum number of units (equipment) that will be operating simultaneously in the same cosite environment. A cosite situation occurs when several antennas are within the near field of each other.

Parameters:

value - An instances of type Integer.

Returns:

The current Station object instance.

Since:

3.1.0

withTSDF

public Station withTSDF(String value)

Set

Parameters:

value - An instances of type String.

Returns:

The current Station object instance.

Since:

3.1.0

withUserCode

public Station withUserCode(String value)

Set a code identifying the user of the station.

Parameters:

value - An instances of type String.

Returns:

The current Station object instance.

Since:

3.1.0

withAntStructureHeight

public Station withAntStructureHeight(Integer value)

Set the overall height, of the antenna support structure above ground level.

Parameters:

value - An instances of type Integer.

Returns:

The current Station object instance.

Since:

3.1.0

withStationName

public Station withStationName(String value)

Set a short descriptive name for the station. This must be unique within the dataset.

Parameters:

value - An instances of type String.

Returns:

The current Station object instance.

Since:

3.1.0

withStationControl

public Station withStationControl(String value)

Set the operating unit that controls the station when different than the assignment users.

Parameters:

value - An instances of type String.

Returns:

The current Station object instance.

Since:

3.1.0

withPrimaryStation

public Station withPrimaryStation(ListCBO value)

Set whether this station is the station of primary regulatory interest.

Parameters:

value - An instances of type ListCBO.

Returns:

The current Station object instance.

Since:

3.1.0

withPOCInformation

public Station withPOCInformation(POCInformation... values)

Set the POCInformation

Complex element POCInformation contains a reference to a Contact, Organisation or Role dataset.

Parameters:

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

Returns:

The current Station object instance.

Since:

3.1.0

withPOCInformation

public Station withPOCInformation(Collection<POCInformation> values)

Set the POCInformation

Complex element POCInformation contains a reference to a Contact, Organisation or Role dataset.

Parameters:

values - A collection of POCInformation instances

Returns:

The current Station object instance.

Since:

3.1.0

withStationLoc

public Station withStationLoc(StationLoc... values)

Set the US:StationLoc

Complex element Station (US) defines one or more transmitters or receivers or a combination of transmitters and receivers, including the accessory equipment necessary at one location for carrying on a radiocommunication, radiolocation, or other spectrum dependent function.

Parameters:

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

Returns:

The current Station object instance.

Since:

3.1.0

withStationLoc

public Station withStationLoc(Collection<StationLoc> values)

Set the US:StationLoc

Complex element Station (US) defines one or more transmitters or receivers or a combination of transmitters and receivers, including the accessory equipment necessary at one location for carrying on a radiocommunication, radiolocation, or other spectrum dependent function.

Parameters:

values - A collection of StationLoc instances

Returns:

The current Station object instance.

Since:

3.1.0

toString

public String toString()

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

Station requires StationID, StationLoc.

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