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

Class Configuration

java.lang.Object

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

public class Configuration
extends Object

Configuration identifies each operational configuration that is required in a SSRequest, granted by a Host Nation in a SSReply, or authorised in a frequency Assignment or Allotment dataset.

Element of Assignment, Multiple, RFSystem, SSReply, SSRequest

Sub-Elements are CaseNum, ConfigEmission, ConfigFreq, Notation, ObservedERPAnalysis, RxRef, TxRef, Usage

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
Configuration()

Method Summary

Modifier and Type	Method and Description
Set<CaseNum>	getCaseNum() Get the CaseNum
S50	getConfigApprovedBy() Get .
DT	getConfigApprovedDateTime() Get .
Set<ConfigEmission>	getConfigEmission() Get the US:ConfigEmission
Set<ConfigFreq>	getConfigFreq() Get the ConfigFreq
S100	getConfigID() Get a short name for the configuration; this name should be a meaningful identification of the configuration, but it can also be automatically generated in some systems.
S100	getDescription() Get a description of the operational configuration.
dBW	getEIRPMax() Get the maximum effective isotropic radiated power (EIRP) radiated from the transmitter antenna.
dBW	getEIRPMin() Get the minimum or nominal effective isotropic radiated power (EIRP) radiated from the transmitter antenna.
S50	getLastObservedBy() Get the identifier of the person or entity who last observed this signal configuration..
S50	getLastReviewedBy() Get the identifier of the person who last reviewed this configuration..
DT	getLastReviewedDateTime() Get the date and time, based on Greenwich Mean Time (GMT), the configuration was thoroughly reviewed..
Set<Loadset>	getLoadset() Get the LoadsetRef
Set<Serial>	getLoadsetRef() Deprecated. SSRF references are managed automatically. Use getLoadset() instead.
Set<Notation>	getNotation() Get the Notation
UN9	getNumUsers() Get the number of users supported by the configuration.
Set<ObservedERPAnalysis>	getObservedERPAnalysis() Get the US:ObservedERPAnalysis
DT	getObservedFirstDateTime() Get the date and time, based on Greenwich Mean Time (GMT), the subject signal was first collected..
DT	getObservedLastDateTime() Get the date and time, based on Greenwich Mean Time (GMT), the subject signal was last collected..
MEMO	getOOBJustification() Get the justification for out-of-band frequency use..
dBW	getPowerLimit() Get the power limit of the transmissions in this configuration..
TString	getPowerType() Get the power type code for carrier, mean, or peak envelope power emitted.
TString	getRepeater() Get "Yes" for each receiver location when a station in the fixed or mobile service is used primarily as a repeater..
Set<RxRef>	getRxRef() Get the RxRef
TString	getSpectrumLink() Get whether the transmitter(s) communicate or interact with the receiver(s) in this Configuration, i.e.
Set<TxRef>	getTxRef() Get the TxRef
Set<Usage>	getUsage() Get the Usage
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetCaseNum() Determine if the CaseNum is configured.
boolean	isSetConfigApprovedBy() Determine if the ConfigApprovedBy is configured.
boolean	isSetConfigApprovedDateTime() Determine if the ConfigApprovedDateTime is configured.
boolean	isSetConfigEmission() Determine if the ConfigEmission is configured.
boolean	isSetConfigFreq() Determine if the ConfigFreq is configured.
boolean	isSetConfigID() Determine if the ConfigID is configured.
boolean	isSetDescription() Determine if the Description is configured.
boolean	isSetEIRPMax() Determine if the EIRPMax is configured.
boolean	isSetEIRPMin() Determine if the EIRPMin is configured.
boolean	isSetLastObservedBy() Determine if the LastObservedBy is configured.
boolean	isSetLastReviewedBy() Determine if the LastReviewedBy is configured.
boolean	isSetLastReviewedDateTime() Determine if the LastReviewedDateTime is configured.
boolean	isSetLoadset() Determine if the loadset field is configured.
boolean	isSetLoadsetRef() Determine if the LoadsetRef is configured.
boolean	isSetNotation() Determine if the Notation is configured.
boolean	isSetNumUsers() Determine if the NumUsers is configured.
boolean	isSetObservedERPAnalysis() Determine if the ObservedERPAnalysis is configured.
boolean	isSetObservedFirstDateTime() Determine if the ObservedFirstDateTime is configured.
boolean	isSetObservedLastDateTime() Determine if the ObservedLastDateTime is configured.
boolean	isSetOOBJustification() Determine if the OOBJustification is configured.
boolean	isSetPowerLimit() Determine if the PowerLimit is configured.
boolean	isSetPowerType() Determine if the PowerType is configured.
boolean	isSetRepeater() Determine if the Repeater is configured.
boolean	isSetRxRef() Determine if the RxRef is configured.
boolean	isSetSpectrumLink() Determine if the SpectrumLink is configured.
boolean	isSetTxRef() Determine if the TxRef is configured.
boolean	isSetUsage() Determine if the Usage is configured.
void	postLoad(SSRF root) Update the SSRF data type references in this Configuration record after loading from XML.
void	prepare() Update the SSRF data type references in this Configuration record.
void	setConfigApprovedBy(S50 value) Set .
void	setConfigApprovedDateTime(DT value) Set .
void	setConfigID(S100 value) Set a short name for the configuration; this name should be a meaningful identification of the configuration, but it can also be automatically generated in some systems.
void	setDescription(S100 value) Set a description of the operational configuration.
void	setEIRPMax(dBW value) Set the maximum effective isotropic radiated power (EIRP) radiated from the transmitter antenna.
void	setEIRPMin(dBW value) Set the minimum or nominal effective isotropic radiated power (EIRP) radiated from the transmitter antenna.
void	setLastObservedBy(S50 value) Set the identifier of the person or entity who last observed this signal configuration..
void	setLastReviewedBy(S50 value) Set the identifier of the person who last reviewed this configuration..
void	setLastReviewedDateTime(DT value) Set the date and time, based on Greenwich Mean Time (GMT), the configuration was thoroughly reviewed..
void	setNumUsers(UN9 value) Set the number of users supported by the configuration.
void	setObservedFirstDateTime(DT value) Set the date and time, based on Greenwich Mean Time (GMT), the subject signal was first collected..
void	setObservedLastDateTime(DT value) Set the date and time, based on Greenwich Mean Time (GMT), the subject signal was last collected..
void	setOOBJustification(MEMO value) Set the justification for out-of-band frequency use..
void	setPowerLimit(dBW value) Set the power limit of the transmissions in this configuration..
void	setPowerType(TString value) Set the power type code for carrier, mean, or peak envelope power emitted.
void	setRepeater(TString value) Set "Yes" for each receiver location when a station in the fixed or mobile service is used primarily as a repeater..
void	setSpectrumLink(TString value) Set whether the transmitter(s) communicate or interact with the receiver(s) in this Configuration, i.e.
String	toString() Get a string representation of this Configuration instance configuration.
void	unsetCaseNum() Clear the CaseNum field.
void	unsetConfigEmission() Clear the ConfigEmission field.
void	unsetConfigFreq() Clear the ConfigFreq field.
void	unsetLoadsetRef() Clear the LoadsetRef field.
void	unsetNotation() Clear the Notation field.
void	unsetObservedERPAnalysis() Clear the ObservedERPAnalysis field.
void	unsetRxRef() Clear the RxRef field.
void	unsetTxRef() Clear the TxRef field.
void	unsetUsage() Clear the Usage field.
Configuration	withCaseNum(CaseNum... values) Set the CaseNum
Configuration	withCaseNum(Collection<CaseNum> values) Set the CaseNum
Configuration	withConfigApprovedBy(String value) Set
Configuration	withConfigApprovedDateTime(Calendar value) Set
Configuration	withConfigApprovedDateTime(Date value) Set
Configuration	withConfigEmission(Collection<ConfigEmission> values) Set the US:ConfigEmission
Configuration	withConfigEmission(ConfigEmission... values) Set the US:ConfigEmission
Configuration	withConfigFreq(Collection<ConfigFreq> values) Set the ConfigFreq
Configuration	withConfigFreq(ConfigFreq... values) Set the ConfigFreq
Configuration	withConfigID(String value) Set a short name for the configuration; this name should be a meaningful identification of the configuration, but it can also be automatically generated in some systems.
Configuration	withDescription(String value) Set a description of the operational configuration.
Configuration	withEIRPMax(Double value) Set the maximum effective isotropic radiated power (EIRP) radiated from the transmitter antenna.
Configuration	withEIRPMin(Double value) Set the minimum or nominal effective isotropic radiated power (EIRP) radiated from the transmitter antenna.
Configuration	withLastObservedBy(String value) Set the identifier of the person or entity who last observed this signal configuration.
Configuration	withLastReviewedBy(String value) Set the identifier of the person who last reviewed this configuration.
Configuration	withLastReviewedDateTime(Calendar value) Set the date and time, based on Greenwich Mean Time (GMT), the configuration was thoroughly reviewed.
Configuration	withLastReviewedDateTime(Date value) Set the date and time, based on Greenwich Mean Time (GMT), the configuration was thoroughly reviewed.
Configuration	withLoadset(Collection<Loadset> values) Set the LoadsetRef
Configuration	withLoadset(Loadset... values) Set the LoadsetRef
Configuration	withLoadsetRef(Collection<Serial> values) Deprecated. SSRF references are managed automatically. Use withLoadset(Loadset...) instead.
Configuration	withLoadsetRef(Serial... values) Deprecated. SSRF references are managed automatically. Use withLoadset(Loadset...) instead.
Configuration	withNotation(Collection<Notation> values) Set the Notation
Configuration	withNotation(Notation... values) Set the Notation
Configuration	withNumUsers(Integer value) Set the number of users supported by the configuration.
Configuration	withObservedERPAnalysis(Collection<ObservedERPAnalysis> values) Set the US:ObservedERPAnalysis
Configuration	withObservedERPAnalysis(ObservedERPAnalysis... values) Set the US:ObservedERPAnalysis
Configuration	withObservedFirstDateTime(Calendar value) Set the date and time, based on Greenwich Mean Time (GMT), the subject signal was first collected.
Configuration	withObservedFirstDateTime(Date value) Set the date and time, based on Greenwich Mean Time (GMT), the subject signal was first collected.
Configuration	withObservedLastDateTime(Calendar value) Set the date and time, based on Greenwich Mean Time (GMT), the subject signal was last collected.
Configuration	withObservedLastDateTime(Date value) Set the date and time, based on Greenwich Mean Time (GMT), the subject signal was last collected.
Configuration	withOOBJustification(String value) Set the justification for out-of-band frequency use.
Configuration	withPowerLimit(Double value) Set the power limit of the transmissions in this configuration.
Configuration	withPowerType(ListCPT value) Set the power type code for carrier, mean, or peak envelope power emitted.
Configuration	withRepeater(ListCBO value) Set "Yes" for each receiver location when a station in the fixed or mobile service is used primarily as a repeater.
Configuration	withRxRef(Collection<RxRef> values) Set the RxRef
Configuration	withRxRef(RxRef... values) Set the RxRef
Configuration	withSpectrumLink(ListCBO value) Set whether the transmitter(s) communicate or interact with the receiver(s) in this Configuration, i.e.
Configuration	withTxRef(Collection<TxRef> values) Set the TxRef
Configuration	withTxRef(TxRef... values) Set the TxRef
Configuration	withUsage(Collection<Usage> values) Set the Usage
Configuration	withUsage(Usage... values) Set the Usage

Methods inherited from class java.lang.Object

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

Constructor Detail

Configuration

public Configuration()

Method Detail

getConfigID

public S100 getConfigID()

Get a short name for the configuration; this name should be a meaningful identification of the configuration, but it can also be automatically generated in some systems. The identifier MUST be unique within the dataset and SHOULD NOT be modified during the entire lifetime of the dataset..

Returns:

a S100 instance

Since:

3.1.0

setConfigID

public void setConfigID(S100 value)

Set a short name for the configuration; this name should be a meaningful identification of the configuration, but it can also be automatically generated in some systems. The identifier MUST be unique within the dataset and SHOULD NOT be modified during the entire lifetime of the dataset..

Parameters:

value - a S100 instance

Since:

3.1.0

isSetConfigID

public boolean isSetConfigID()

Determine if the ConfigID is configured.

Returns:

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

getDescription

public S100 getDescription()

Get a description of the operational configuration. This description should be a meaningful explanation of the configurations main characteristics..

Returns:

a S100 instance

Since:

3.1.0

setDescription

public void setDescription(S100 value)

Set a description of the operational configuration. This description should be a meaningful explanation of the configurations main characteristics..

Parameters:

value - a S100 instance

Since:

3.1.0

isSetDescription

public boolean isSetDescription()

Determine if the Description is configured.

Returns:

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

getRepeater

public TString getRepeater()

Get "Yes" for each receiver location when a station in the fixed or mobile service is used primarily as a repeater..

Returns:

the Repeater value in a TString data type

Since:

3.1.0

setRepeater

public void setRepeater(TString value)

Set "Yes" for each receiver location when a station in the fixed or mobile service is used primarily as a repeater..

Parameters:

value - the Repeater value in a TString data type

Since:

3.1.0

isSetRepeater

public boolean isSetRepeater()

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

getNumUsers

public UN9 getNumUsers()

Get the number of users supported by the configuration. This data may be used to analyse spectrum usage..

Returns:

a UN9 instance

Since:

3.1.0

setNumUsers

public void setNumUsers(UN9 value)

Set the number of users supported by the configuration. This data may be used to analyse spectrum usage..

Parameters:

value - a UN9 instance

Since:

3.1.0

isSetNumUsers

public boolean isSetNumUsers()

Determine if the NumUsers is configured.

Returns:

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

getEIRPMin

public dBW getEIRPMin()

Get the minimum or nominal effective isotropic radiated power (EIRP) radiated from the transmitter antenna. It is the sum of the power supplied to the antenna and the gain of the antenna, less the line loss..

Returns:

a dBW instance

Since:

3.1.0

setEIRPMin

public void setEIRPMin(dBW value)

Set the minimum or nominal effective isotropic radiated power (EIRP) radiated from the transmitter antenna. It is the sum of the power supplied to the antenna and the gain of the antenna, less the line loss..

Parameters:

value - a dBW instance

Since:

3.1.0

isSetEIRPMin

public boolean isSetEIRPMin()

Determine if the EIRPMin is configured.

Returns:

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

getEIRPMax

public dBW getEIRPMax()

Get the maximum effective isotropic radiated power (EIRP) radiated from the transmitter antenna. It is the sum of the power supplied to the antenna and the gain of the antenna, less the line loss.

[XSL ERR MINMAX] If EIRPMax is used, it MUST be greater than EIRPMin..

Returns:

a dBW instance

Since:

3.1.0

setEIRPMax

public void setEIRPMax(dBW value)

Set the maximum effective isotropic radiated power (EIRP) radiated from the transmitter antenna. It is the sum of the power supplied to the antenna and the gain of the antenna, less the line loss.

[XSL ERR MINMAX] If EIRPMax is used, it MUST be greater than EIRPMin..

Parameters:

value - a dBW instance

Since:

3.1.0

isSetEIRPMax

public boolean isSetEIRPMax()

Determine if the EIRPMax is configured.

Returns:

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

getOOBJustification

public MEMO getOOBJustification()

Get the justification for out-of-band frequency use..

Returns:

a MEMO instance

Since:

3.1.0

setOOBJustification

public void setOOBJustification(MEMO value)

Set the justification for out-of-band frequency use..

Parameters:

value - a MEMO instance

Since:

3.1.0

isSetOOBJustification

public boolean isSetOOBJustification()

Determine if the OOBJustification is configured.

Returns:

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

getPowerLimit

public dBW getPowerLimit()

Get the power limit of the transmissions in this configuration..

Returns:

a dBW instance

Since:

3.1.0

setPowerLimit

public void setPowerLimit(dBW value)

Set the power limit of the transmissions in this configuration..

Parameters:

value - a dBW instance

Since:

3.1.0

isSetPowerLimit

public boolean isSetPowerLimit()

Determine if the PowerLimit is configured.

Returns:

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

getPowerType

public TString getPowerType()

Get the power type code for carrier, mean, or peak envelope power emitted. The power type code will depend on the type of emission of the transmitter equipment..

Returns:

the PowerType value in a TString data type

Since:

3.1.0

setPowerType

public void setPowerType(TString value)

Set the power type code for carrier, mean, or peak envelope power emitted. The power type code will depend on the type of emission of the transmitter equipment..

Parameters:

value - the PowerType value in a TString data type

Since:

3.1.0

isSetPowerType

public boolean isSetPowerType()

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

getSpectrumLink

public TString getSpectrumLink()

Get whether the transmitter(s) communicate or interact with the receiver(s) in this Configuration, i.e. enters a link versus a box..

Returns:

the SpectrumLink value in a TString data type

Since:

3.1.0

setSpectrumLink

public void setSpectrumLink(TString value)

Set whether the transmitter(s) communicate or interact with the receiver(s) in this Configuration, i.e. enters a link versus a box..

Parameters:

value - the SpectrumLink value in a TString data type

Since:

3.1.0

isSetSpectrumLink

public boolean isSetSpectrumLink()

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

getConfigApprovedBy

public S50 getConfigApprovedBy()

Get .

Returns:

a S50 instance

Since:

3.1.0

setConfigApprovedBy

public void setConfigApprovedBy(S50 value)

Set .

Parameters:

value - a S50 instance

Since:

3.1.0

isSetConfigApprovedBy

public boolean isSetConfigApprovedBy()

Determine if the ConfigApprovedBy is configured.

Returns:

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

getConfigApprovedDateTime

public DT getConfigApprovedDateTime()

Get .

Returns:

a DT instance

Since:

3.1.0

setConfigApprovedDateTime

public void setConfigApprovedDateTime(DT value)

Set .

Parameters:

value - a DT instance

Since:

3.1.0

isSetConfigApprovedDateTime

public boolean isSetConfigApprovedDateTime()

Determine if the ConfigApprovedDateTime is configured.

Returns:

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

getObservedFirstDateTime

public DT getObservedFirstDateTime()

Get the date and time, based on Greenwich Mean Time (GMT), the subject signal was first collected..

Returns:

a DT instance

Since:

3.1.0

setObservedFirstDateTime

public void setObservedFirstDateTime(DT value)

Set the date and time, based on Greenwich Mean Time (GMT), the subject signal was first collected..

Parameters:

value - a DT instance

Since:

3.1.0

isSetObservedFirstDateTime

public boolean isSetObservedFirstDateTime()

Determine if the ObservedFirstDateTime is configured.

Returns:

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

getObservedLastDateTime

public DT getObservedLastDateTime()

Get the date and time, based on Greenwich Mean Time (GMT), the subject signal was last collected..

Returns:

a DT instance

Since:

3.1.0

setObservedLastDateTime

public void setObservedLastDateTime(DT value)

Set the date and time, based on Greenwich Mean Time (GMT), the subject signal was last collected..

Parameters:

value - a DT instance

Since:

3.1.0

isSetObservedLastDateTime

public boolean isSetObservedLastDateTime()

Determine if the ObservedLastDateTime is configured.

Returns:

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

getLastObservedBy

public S50 getLastObservedBy()

Get the identifier of the person or entity who last observed this signal configuration..

Returns:

a S50 instance

Since:

3.1.0

setLastObservedBy

public void setLastObservedBy(S50 value)

Set the identifier of the person or entity who last observed this signal configuration..

Parameters:

value - a S50 instance

Since:

3.1.0

isSetLastObservedBy

public boolean isSetLastObservedBy()

Determine if the LastObservedBy is configured.

Returns:

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

getLastReviewedBy

public S50 getLastReviewedBy()

Get the identifier of the person who last reviewed this configuration..

Returns:

a S50 instance

Since:

3.1.0

setLastReviewedBy

public void setLastReviewedBy(S50 value)

Set the identifier of the person who last reviewed this configuration..

Parameters:

value - a S50 instance

Since:

3.1.0

isSetLastReviewedBy

public boolean isSetLastReviewedBy()

Determine if the LastReviewedBy is configured.

Returns:

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

getLastReviewedDateTime

public DT getLastReviewedDateTime()

Get the date and time, based on Greenwich Mean Time (GMT), the configuration was thoroughly reviewed..

Returns:

a DT instance

Since:

3.1.0

setLastReviewedDateTime

public void setLastReviewedDateTime(DT value)

Set the date and time, based on Greenwich Mean Time (GMT), the configuration was thoroughly reviewed..

Parameters:

value - a DT instance

Since:

3.1.0

isSetLastReviewedDateTime

public boolean isSetLastReviewedDateTime()

Determine if the LastReviewedDateTime is configured.

Returns:

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

getNotation

public Set<Notation> getNotation()

Get the Notation

Complex element Notation contains the electronic identification for a pulsed or non-pulsed electromagnetic emission. It includes but is not limited to Communications Emitter Notation (CENOT) and Electronic Intelligence Notation (ELNOT)..

Returns:

a Notation instance

Since:

3.1.0

isSetNotation

public boolean isSetNotation()

Determine if the Notation is configured.

Returns:

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

unsetNotation

public void unsetNotation()

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

getUsage

public Set<Usage> getUsage()

Get the Usage

Complex element Usage identifies how an operational configuration can be used or will be used..

Returns:

a Usage instance

Since:

3.1.0

isSetUsage

public boolean isSetUsage()

Determine if the Usage is configured.

Returns:

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

unsetUsage

public void unsetUsage()

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

getConfigFreq

public Set<ConfigFreq> getConfigFreq()

Get the ConfigFreq

Complex element ConfigFreq indicates the set of frequencies that a configuration uses, which may be a subset of the frequencies that the linked components (Transmitter, Receiver, Antenna) are capable of..

Returns:

a ConfigFreq instance

Since:

3.1.0

isSetConfigFreq

public boolean isSetConfigFreq()

Determine if the ConfigFreq is configured.

Returns:

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

unsetConfigFreq

public void unsetConfigFreq()

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

getTxRef

public Set<TxRef> getTxRef()

Get the TxRef

Complex element TxRef contains the reference of a Transmitter, and optionnally some of its TxModes and the associated Antennas and AntMode..

Returns:

a TxRef instance

Since:

3.1.0

isSetTxRef

public boolean isSetTxRef()

Determine if the TxRef is configured.

Returns:

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

unsetTxRef

public void unsetTxRef()

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

getRxRef

public Set<RxRef> getRxRef()

Get the RxRef

Complex element RxRef contains the reference of a Receiver, and optionnally some of its RxModes and the associated Antennas and AntMode..

Returns:

a RxRef instance

Since:

3.1.0

isSetRxRef

public boolean isSetRxRef()

Determine if the RxRef is configured.

Returns:

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

unsetRxRef

public void unsetRxRef()

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

getCaseNum

public Set<CaseNum> getCaseNum()

Get the CaseNum

Complex element CaseNum contains legacy and other identifiers associated with the Dataset..

Returns:

a CaseNum instance

Since:

3.1.0

isSetCaseNum

public boolean isSetCaseNum()

Determine if the CaseNum is configured.

Returns:

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

unsetCaseNum

public void unsetCaseNum()

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

getConfigEmission

public Set<ConfigEmission> getConfigEmission()

Get the US:ConfigEmission

Complex element ConfigEmission (US) specifies the emission bandwidths and classification symbols that a Configuration uses, which may be a subset of the linked components' capabilities..

Returns:

a ConfigEmission instance

Since:

3.1.0

isSetConfigEmission

public boolean isSetConfigEmission()

Determine if the ConfigEmission is configured.

Returns:

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

unsetConfigEmission

public void unsetConfigEmission()

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

getLoadsetRef

@Deprecated
public Set<Serial> getLoadsetRef()

Deprecated. SSRF references are managed automatically. Use getLoadset() instead.

Get the LoadsetRef

Complex element LoadsetRef describes the jamming loadset to be used against a specific target or targets..

Returns:

a Serial instance

Since:

3.1.0

isSetLoadsetRef

public boolean isSetLoadsetRef()

Determine if the LoadsetRef is configured.

Returns:

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

unsetLoadsetRef

public void unsetLoadsetRef()

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

getObservedERPAnalysis

public Set<ObservedERPAnalysis> getObservedERPAnalysis()

Get the US:ObservedERPAnalysis

Complex element ObservedERPAnalysis (US) contains data describing Effective Radiated Power (ERP) associated with an emitter or Notation..

Returns:

a ObservedERPAnalysis instance

Since:

3.1.0

isSetObservedERPAnalysis

public boolean isSetObservedERPAnalysis()

Determine if the ObservedERPAnalysis is configured.

Returns:

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

unsetObservedERPAnalysis

public void unsetObservedERPAnalysis()

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

withConfigID

public Configuration withConfigID(String value)

Set a short name for the configuration; this name should be a meaningful identification of the configuration, but it can also be automatically generated in some systems. The identifier MUST be unique within the dataset and SHOULD NOT be modified during the entire lifetime of the dataset.

Parameters:

value - An instances of type String.

Returns:

The current Configuration object instance.

Since:

3.1.0

withDescription

public Configuration withDescription(String value)

Set a description of the operational configuration. This description should be a meaningful explanation of the configurations main characteristics.

Parameters:

value - An instances of type String.

Returns:

The current Configuration object instance.

Since:

3.1.0

withRepeater

public Configuration withRepeater(ListCBO value)

Set "Yes" for each receiver location when a station in the fixed or mobile service is used primarily as a repeater.

Parameters:

value - An instances of type ListCBO.

Returns:

The current Configuration object instance.

Since:

3.1.0

withNumUsers

public Configuration withNumUsers(Integer value)

Set the number of users supported by the configuration. This data may be used to analyse spectrum usage.

Parameters:

value - An instances of type Integer.

Returns:

The current Configuration object instance.

Since:

3.1.0

withEIRPMin

public Configuration withEIRPMin(Double value)

Set the minimum or nominal effective isotropic radiated power (EIRP) radiated from the transmitter antenna. It is the sum of the power supplied to the antenna and the gain of the antenna, less the line loss.

Parameters:

value - An instances of type Double.

Returns:

The current Configuration object instance.

Since:

3.1.0

withEIRPMax

public Configuration withEIRPMax(Double value)

Set the maximum effective isotropic radiated power (EIRP) radiated from the transmitter antenna. It is the sum of the power supplied to the antenna and the gain of the antenna, less the line loss.

[XSL ERR MINMAX] If EIRPMax is used, it MUST be greater than EIRPMin.

Parameters:

value - An instances of type Double.

Returns:

The current Configuration object instance.

Since:

3.1.0

withOOBJustification

public Configuration withOOBJustification(String value)

Set the justification for out-of-band frequency use.

Parameters:

value - An instances of type String.

Returns:

The current Configuration object instance.

Since:

3.1.0

withPowerLimit

public Configuration withPowerLimit(Double value)

Set the power limit of the transmissions in this configuration.

Parameters:

value - An instances of type Double.

Returns:

The current Configuration object instance.

Since:

3.1.0

withPowerType

public Configuration withPowerType(ListCPT value)

Set the power type code for carrier, mean, or peak envelope power emitted. The power type code will depend on the type of emission of the transmitter equipment.

Parameters:

value - An instances of type ListCPT.

Returns:

The current Configuration object instance.

Since:

3.1.0

withSpectrumLink

public Configuration withSpectrumLink(ListCBO value)

Set whether the transmitter(s) communicate or interact with the receiver(s) in this Configuration, i.e. enters a link versus a box.

Parameters:

value - An instances of type ListCBO.

Returns:

The current Configuration object instance.

Since:

3.1.0

withConfigApprovedBy

public Configuration withConfigApprovedBy(String value)

Set

Parameters:

value - An instances of type String.

Returns:

The current Configuration object instance.

Since:

3.1.0

withConfigApprovedDateTime

public Configuration withConfigApprovedDateTime(Calendar value)

Set

Parameters:

value - An instances of type Calendar.

Returns:

The current Configuration object instance.

Since:

3.1.0

withConfigApprovedDateTime

public Configuration withConfigApprovedDateTime(Date value)

Set

Parameters:

value - An instances of type Date.

Returns:

The current Configuration object instance.

Since:

3.1.0

withObservedFirstDateTime

public Configuration withObservedFirstDateTime(Calendar value)

Set the date and time, based on Greenwich Mean Time (GMT), the subject signal was first collected.

Parameters:

value - An instances of type Calendar.

Returns:

The current Configuration object instance.

Since:

3.1.0

withObservedFirstDateTime

public Configuration withObservedFirstDateTime(Date value)

Set the date and time, based on Greenwich Mean Time (GMT), the subject signal was first collected.

Parameters:

value - An instances of type Date.

Returns:

The current Configuration object instance.

Since:

3.1.0

withObservedLastDateTime

public Configuration withObservedLastDateTime(Calendar value)

Set the date and time, based on Greenwich Mean Time (GMT), the subject signal was last collected.

Parameters:

value - An instances of type Calendar.

Returns:

The current Configuration object instance.

Since:

3.1.0

withObservedLastDateTime

public Configuration withObservedLastDateTime(Date value)

Set the date and time, based on Greenwich Mean Time (GMT), the subject signal was last collected.

Parameters:

value - An instances of type Date.

Returns:

The current Configuration object instance.

Since:

3.1.0

withLastObservedBy

public Configuration withLastObservedBy(String value)

Set the identifier of the person or entity who last observed this signal configuration.

Parameters:

value - An instances of type String.

Returns:

The current Configuration object instance.

Since:

3.1.0

withLastReviewedBy

public Configuration withLastReviewedBy(String value)

Set the identifier of the person who last reviewed this configuration.

Parameters:

value - An instances of type String.

Returns:

The current Configuration object instance.

Since:

3.1.0

withLastReviewedDateTime

public Configuration withLastReviewedDateTime(Calendar value)

Set the date and time, based on Greenwich Mean Time (GMT), the configuration was thoroughly reviewed.

Parameters:

value - An instances of type Calendar.

Returns:

The current Configuration object instance.

Since:

3.1.0

withLastReviewedDateTime

public Configuration withLastReviewedDateTime(Date value)

Set the date and time, based on Greenwich Mean Time (GMT), the configuration was thoroughly reviewed.

Parameters:

value - An instances of type Date.

Returns:

The current Configuration object instance.

Since:

3.1.0

withNotation

public Configuration withNotation(Notation... values)

Set the Notation

Complex element Notation contains the electronic identification for a pulsed or non-pulsed electromagnetic emission. It includes but is not limited to Communications Emitter Notation (CENOT) and Electronic Intelligence Notation (ELNOT).

Parameters:

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

Returns:

The current Configuration object instance.

Since:

3.1.0

withNotation

public Configuration withNotation(Collection<Notation> values)

Set the Notation

Complex element Notation contains the electronic identification for a pulsed or non-pulsed electromagnetic emission. It includes but is not limited to Communications Emitter Notation (CENOT) and Electronic Intelligence Notation (ELNOT).

Parameters:

values - A collection of Notation instances

Returns:

The current Configuration object instance.

Since:

3.1.0

withUsage

public Configuration withUsage(Usage... values)

Set the Usage

Complex element Usage identifies how an operational configuration can be used or will be used.

Parameters:

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

Returns:

The current Configuration object instance.

Since:

3.1.0

withUsage

public Configuration withUsage(Collection<Usage> values)

Set the Usage

Complex element Usage identifies how an operational configuration can be used or will be used.

Parameters:

values - A collection of Usage instances

Returns:

The current Configuration object instance.

Since:

3.1.0

withConfigFreq

public Configuration withConfigFreq(ConfigFreq... values)

Set the ConfigFreq

Complex element ConfigFreq indicates the set of frequencies that a configuration uses, which may be a subset of the frequencies that the linked components (Transmitter, Receiver, Antenna) are capable of.

Parameters:

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

Returns:

The current Configuration object instance.

Since:

3.1.0

withConfigFreq

public Configuration withConfigFreq(Collection<ConfigFreq> values)

Set the ConfigFreq

Complex element ConfigFreq indicates the set of frequencies that a configuration uses, which may be a subset of the frequencies that the linked components (Transmitter, Receiver, Antenna) are capable of.

Parameters:

values - A collection of ConfigFreq instances

Returns:

The current Configuration object instance.

Since:

3.1.0

withTxRef

public Configuration withTxRef(TxRef... values)

Set the TxRef

Complex element TxRef contains the reference of a Transmitter, and optionnally some of its TxModes and the associated Antennas and AntMode.

Parameters:

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

Returns:

The current Configuration object instance.

Since:

3.1.0

withTxRef

public Configuration withTxRef(Collection<TxRef> values)

Set the TxRef

Complex element TxRef contains the reference of a Transmitter, and optionnally some of its TxModes and the associated Antennas and AntMode.

Parameters:

values - A collection of TxRef instances

Returns:

The current Configuration object instance.

Since:

3.1.0

withRxRef

public Configuration withRxRef(RxRef... values)

Set the RxRef

Complex element RxRef contains the reference of a Receiver, and optionnally some of its RxModes and the associated Antennas and AntMode.

Parameters:

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

Returns:

The current Configuration object instance.

Since:

3.1.0

withRxRef

public Configuration withRxRef(Collection<RxRef> values)

Set the RxRef

Complex element RxRef contains the reference of a Receiver, and optionnally some of its RxModes and the associated Antennas and AntMode.

Parameters:

values - A collection of RxRef instances

Returns:

The current Configuration object instance.

Since:

3.1.0

withCaseNum

public Configuration withCaseNum(CaseNum... values)

Set the CaseNum

Complex element CaseNum contains legacy and other identifiers associated with the Dataset.

Parameters:

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

Returns:

The current Configuration object instance.

Since:

3.1.0

withCaseNum

public Configuration withCaseNum(Collection<CaseNum> values)

Set the CaseNum

Complex element CaseNum contains legacy and other identifiers associated with the Dataset.

Parameters:

values - A collection of CaseNum instances

Returns:

The current Configuration object instance.

Since:

3.1.0

withConfigEmission

public Configuration withConfigEmission(ConfigEmission... values)

Set the US:ConfigEmission

Complex element ConfigEmission (US) specifies the emission bandwidths and classification symbols that a Configuration uses, which may be a subset of the linked components' capabilities.

Parameters:

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

Returns:

The current Configuration object instance.

Since:

3.1.0

withConfigEmission

public Configuration withConfigEmission(Collection<ConfigEmission> values)

Set the US:ConfigEmission

Complex element ConfigEmission (US) specifies the emission bandwidths and classification symbols that a Configuration uses, which may be a subset of the linked components' capabilities.

Parameters:

values - A collection of ConfigEmission instances

Returns:

The current Configuration object instance.

Since:

3.1.0

withLoadsetRef

@Deprecated
public Configuration withLoadsetRef(Serial... values)

Deprecated. SSRF references are managed automatically. Use withLoadset(Loadset...) instead.

Set the LoadsetRef

Complex element LoadsetRef describes the jamming loadset to be used against a specific target or targets.

Parameters:

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

Returns:

The current Configuration object instance.

Since:

3.1.0

withLoadsetRef

@Deprecated
public Configuration withLoadsetRef(Collection<Serial> values)

Deprecated. SSRF references are managed automatically. Use withLoadset(Loadset...) instead.

Set the LoadsetRef

Complex element LoadsetRef describes the jamming loadset to be used against a specific target or targets.

Parameters:

values - A collection of Serial instances

Returns:

The current Configuration object instance.

Since:

3.1.0

withObservedERPAnalysis

public Configuration withObservedERPAnalysis(ObservedERPAnalysis... values)

Set the US:ObservedERPAnalysis

Complex element ObservedERPAnalysis (US) contains data describing Effective Radiated Power (ERP) associated with an emitter or Notation.

Parameters:

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

Returns:

The current Configuration object instance.

Since:

3.1.0

withObservedERPAnalysis

public Configuration withObservedERPAnalysis(Collection<ObservedERPAnalysis> values)

Set the US:ObservedERPAnalysis

Complex element ObservedERPAnalysis (US) contains data describing Effective Radiated Power (ERP) associated with an emitter or Notation.

Parameters:

values - A collection of ObservedERPAnalysis instances

Returns:

The current Configuration object instance.

Since:

3.1.0

toString

public String toString()

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

Configuration requires ConfigID.

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

getLoadset

public Set<Loadset> getLoadset()

Get the LoadsetRef

Complex element LoadsetRef describes the jamming loadset to be used against a specific target or targets..

Returns:

a Loadset instance

Since:

3.1.0

isSetLoadset

public boolean isSetLoadset()

Determine if the loadset field is configured.

Returns:

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

withLoadset

public Configuration withLoadset(Loadset... values)

Set the LoadsetRef

Complex element LoadsetRef describes the jamming loadset to be used against a specific target or targets.

Parameters:

values - An instances of type Loadset.

Returns:

The current Configuration object instance.

Since:

3.1.0

withLoadset

public Configuration withLoadset(Collection<Loadset> values)

Set the LoadsetRef

Complex element LoadsetRef describes the jamming loadset to be used against a specific target or targets.

Parameters:

values - An instances of type Loadset.

Returns:

The current Configuration object instance.

Since:

3.1.0

prepare

public void prepare()

Update the SSRF data type references in this Configuration record.

This method builds the exported loadsetRef field with values from the transient loadset field. This method should typically be called after the Configuration 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 Configuration record after loading from XML.

This method builds the transient loadset with values from the imported loadsetRef field. This method should typically be called after the Configuration is imported from XML.

Parameters:

root - the SSRF root instance.

Since:

3.1.0