us.gov.dod.standard.ssrf._3_1

Class RFSystem

java.lang.Object

us.gov.dod.standard.ssrf._3_1.Common<RFSystem>

us.gov.dod.standard.ssrf._3_1.RFSystem

All Implemented Interfaces:

Comparable<RFSystem>

public class RFSystem
extends Common<RFSystem>

RFSystem describes the association of one or several Transmitters, Receivers and Antennas as they are assembled to form a system on a platform; it can also include the specific modes which are allowed or technically possible in this assembly.

Sub-Elements are Configuration, Deployment, Nomenclature, POCInformation, RelatedSystem, StockNum, UsingCountries

Example:

 <RFSystem cls="U">
   <Serial cls="U">USA::TR:123</Serial>
   <EntryDateTime cls="U">2011-12-25T00:00:00Z</EntryDateTime>
   <Deployment>
     <Type cls="U">Land Mobile</Type>
   </Deployment>
   <Configuration>
     <ConfigID cls="U">CONFIG1</ConfigID>
     <TxRef>
       <Serial cls="U">USA::TX:1111</Serial>
       <TxAntModeRef>
         <Serial cls="U">USA::AN:2222</Serial>
       </TxAntModeRef>
     </TxRef>
     <RxRef>
       <Serial cls="U">USA::RX:3333</Serial>
     </RxRef>
   </Configuration>
 </RFSystem>
 

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Field Summary

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

approvedBy, approvedDateTime, caseNum, cls, description, entryBy, entryByRole, entryDateTime, extReferenceRef, extReferences, idref, lastChangeBy, lastChangeByRole, lastChangeDateTime, lastObservedBy, lastReviewBy, lastReviewByRole, lastReviewDate, legacyReleasability, modAllowedBy, modAllowedByRole, observedFirstDateTime, observedLastDateTime, owner, ownerRole, quality, recommendedValue, redacted, releasability, remarkRef, remarks, securityClass, serial, state

Constructor Summary

Constructors

Constructor and Description
RFSystem() No arg constructor.

Method Summary

Modifier and Type	Method and Description
Set<Configuration>	getConfiguration() Get the Configuration
Set<Deployment>	getDeployment() Get the Deployment
TString	getEmergency() Get "Yes" if the system may be used in a case of emergency..
TString	getFieldedStatus() Get the current stage of the RFSystem..
S70	getInitialCost() Get the estimated initial cost, in US dollars, of the system/equipment..
Set<Nomenclature>	getNomenclature() Get the Nomenclature
Set<POCInformation>	getPOCInformation() Get the POCInformation
Set<RelatedSystem>	getRelatedSystem() Get the RelatedSystem
Set<StockNum>	getStockNum() Get the US:StockNum
Set<UsingCountries>	getUsingCountries() Get the US:UsingCountries
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetConfiguration() Determine if the Configuration is configured.
boolean	isSetDeployment() Determine if the Deployment is configured.
boolean	isSetEmergency() Determine if the Emergency is configured.
boolean	isSetFieldedStatus() Determine if the FieldedStatus is configured.
boolean	isSetInitialCost() Determine if the InitialCost is configured.
boolean	isSetNomenclature() Determine if the Nomenclature is configured.
boolean	isSetPOCInformation() Determine if the POCInformation is configured.
boolean	isSetRelatedSystem() Determine if the RelatedSystem is configured.
boolean	isSetStockNum() Determine if the StockNum is configured.
boolean	isSetUsingCountries() Determine if the UsingCountries is configured.
void	setEmergency(TString value) Set "Yes" if the system may be used in a case of emergency..
void	setFieldedStatus(TString value) Set the current stage of the RFSystem..
void	setInitialCost(S70 value) Set the estimated initial cost, in US dollars, of the system/equipment..
String	toString() Get a string representation of this RFSystem instance configuration.
void	unsetConfiguration() Clear the Configuration field.
void	unsetDeployment() Clear the Deployment field.
void	unsetNomenclature() Clear the Nomenclature field.
void	unsetPOCInformation() Clear the POCInformation field.
void	unsetRelatedSystem() Clear the RelatedSystem field.
void	unsetStockNum() Clear the StockNum field.
void	unsetUsingCountries() Clear the UsingCountries field.
RFSystem	withConfiguration(Collection<Configuration> values) Set the Configuration
RFSystem	withConfiguration(Configuration... values) Set the Configuration
RFSystem	withDeployment(Collection<Deployment> values) Set the Deployment
RFSystem	withDeployment(Deployment... values) Set the Deployment
RFSystem	withEmergency(ListCBO value) Set "Yes" if the system may be used in a case of emergency.
RFSystem	withFieldedStatus(ListCSG value) Set the current stage of the RFSystem.
RFSystem	withInitialCost(String value) Set the estimated initial cost, in US dollars, of the system/equipment.
RFSystem	withNomenclature(Collection<Nomenclature> values) Set the Nomenclature
RFSystem	withNomenclature(Nomenclature... values) Set the Nomenclature
RFSystem	withPOCInformation(Collection<POCInformation> values) Set the POCInformation
RFSystem	withPOCInformation(POCInformation... values) Set the POCInformation
RFSystem	withRelatedSystem(Collection<RelatedSystem> values) Set the RelatedSystem
RFSystem	withRelatedSystem(RelatedSystem... values) Set the RelatedSystem
RFSystem	withStockNum(Collection<StockNum> values) Set the US:StockNum
RFSystem	withStockNum(StockNum... values) Set the US:StockNum
RFSystem	withUsingCountries(Collection<UsingCountries> values) Set the US:UsingCountries
RFSystem	withUsingCountries(UsingCountries... values) Set the US:UsingCountries

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

compareTo, equals, getApprovedBy, getApprovedDateTime, getCaseNum, getCls, getDescription, getEntryBy, getEntryByRole, getEntryDateTime, getExtReferenceRef, getExtReferences, getIdref, getLastChangeBy, getLastChangeByRole, getLastChangeDateTime, getLastObservedBy, getLastReviewBy, getLastReviewByRole, getLastReviewDate, getLegacyReleasability, getModAllowedBy, getModAllowedByRole, getObservedFirstDateTime, getObservedLastDateTime, getOwner, getOwnerRole, getQuality, getRecommendedValue, getRedacted, getReleasability, getRemarkRef, getRemarks, getSecurityClass, getSerial, getState, hashCode, isSetApprovedBy, isSetApprovedDateTime, isSetCaseNum, isSetCls, isSetDescription, isSetEntryBy, isSetEntryByRole, isSetEntryDateTime, isSetExtReferenceRef, isSetExtReferences, isSetIdref, isSetLastChangeBy, isSetLastChangeByRole, isSetLastChangeDateTime, isSetLastObservedBy, isSetLastReviewBy, isSetLastReviewByRole, isSetLastReviewDate, isSetLegacyReleasability, isSetModAllowedBy, isSetModAllowedByRole, isSetObservedFirstDateTime, isSetObservedLastDateTime, isSetOwner, isSetOwnerRole, isSetQuality, isSetRecommendedValue, isSetRedacted, isSetReleasability, isSetRemarkRef, isSetRemarks, isSetSecurityClass, isSetSerial, isSetState, postLoad, prepare, setApprovedBy, setApprovedDateTime, setCls, setDescription, setEntryBy, setEntryDateTime, setIdref, setLastChangeBy, setLastChangeDateTime, setLastObservedBy, setLastReviewBy, setLastReviewDate, setLegacyReleasability, setModAllowedBy, setObservedFirstDateTime, setObservedLastDateTime, setOwner, setQuality, setRecommendedValue, setRedacted, setSecurityClass, setSerial, setState, unsetCaseNum, unsetExtReferenceRef, unsetExtReferences, unsetReleasability, unsetRemarkRef, unsetRemarks, withApprovedBy, withApprovedDateTime, withApprovedDateTime, withCaseNum, withCaseNum, withCls, withDescription, withEntryBy, withEntryByRole, withEntryDateTime, withExtReferenceRef, withExtReferenceRef, withExtReferences, withExtReferences, withExtReferences, withIdref, withLastChangeBy, withLastChangeByRole, withLastChangeDateTime, withLastChangeDateTime, withLastObservedBy, withLastReviewBy, withLastReviewByRole, withLastReviewDate, withLastReviewDate, withLegacyReleasability, withModAllowedBy, withModAllowedByRole, withObservedFirstDateTime, withObservedFirstDateTime, withObservedLastDateTime, withObservedLastDateTime, withOwner, withOwnerRole, withQuality, withRecommendedValue, withRedacted, withReleasability, withReleasability, withRemarkRef, withRemarkRef, withRemarkRef, withRemarks, withRemarks, withSecurityClass, withSerial, withState

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RFSystem

public RFSystem()

No arg constructor. Initializes the Common required fields.

Method Detail

getFieldedStatus

public TString getFieldedStatus()

Get the current stage of the RFSystem..

Returns:

the FieldedStatus value in a TString data type

Since:

3.1.0

setFieldedStatus

public void setFieldedStatus(TString value)

Set the current stage of the RFSystem..

Parameters:

value - the FieldedStatus value in a TString data type

Since:

3.1.0

isSetFieldedStatus

public boolean isSetFieldedStatus()

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

getEmergency

public TString getEmergency()

Get "Yes" if the system may be used in a case of emergency..

Returns:

the Emergency value in a TString data type

Since:

3.1.0

setEmergency

public void setEmergency(TString value)

Set "Yes" if the system may be used in a case of emergency..

Parameters:

value - the Emergency value in a TString data type

Since:

3.1.0

isSetEmergency

public boolean isSetEmergency()

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

getInitialCost

public S70 getInitialCost()

Get the estimated initial cost, in US dollars, of the system/equipment..

Returns:

a S70 instance

Since:

3.1.0

setInitialCost

public void setInitialCost(S70 value)

Set the estimated initial cost, in US dollars, of the system/equipment..

Parameters:

value - a S70 instance

Since:

3.1.0

isSetInitialCost

public boolean isSetInitialCost()

Determine if the InitialCost is configured.

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.

getNomenclature

public Set<Nomenclature> getNomenclature()

Get the Nomenclature

Complex element Nomenclature identifies either the standard military, government, nomenclature or the commercial model number of an equipment. Each device or group of devices may have several types of nomenclatures, e.g. both a military nomenclature and a commercial model number..

Returns:

a Nomenclature instance

Since:

3.1.0

isSetNomenclature

public boolean isSetNomenclature()

Determine if the Nomenclature is configured.

Returns:

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

unsetNomenclature

public void unsetNomenclature()

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

getDeployment

public Set<Deployment> getDeployment()

Get the Deployment

Complex element Deployment provides the general type of equipment deployment. For the detailed data, the appropriate force element and platforms elements should be referenced. Data element Deployment identifies the general category of how the equipment is deployed. For example an equipment may be deployed on an airborne platform, a ship or fixed land installation..

Returns:

a Deployment instance

Since:

3.1.0

isSetDeployment

public boolean isSetDeployment()

Determine if the Deployment is configured.

Returns:

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

unsetDeployment

public void unsetDeployment()

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

getConfiguration

public Set<Configuration> getConfiguration()

Get the Configuration

Complex element 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. It also identifies the functional use of the assigned frequency at a particular transmitting station. Finally, it may indicate if the receiver station is used primarily as a repeater. A direct coupling between the station's receiver and the station's transmitter allows the incoming signal to be retransmitted exactly as received..

Returns:

a Configuration instance

Since:

3.1.0

isSetConfiguration

public boolean isSetConfiguration()

Determine if the Configuration is configured.

Returns:

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

unsetConfiguration

public void unsetConfiguration()

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

getRelatedSystem

public Set<RelatedSystem> getRelatedSystem()

Get the RelatedSystem

Complex element RelatedSystem identifies a System linked to the current System, and the relation (parent, child, sibling)..

Returns:

a RelatedSystem instance

Since:

3.1.0

isSetRelatedSystem

public boolean isSetRelatedSystem()

Determine if the RelatedSystem is configured.

Returns:

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

unsetRelatedSystem

public void unsetRelatedSystem()

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

getStockNum

public Set<StockNum> getStockNum()

Get the US:StockNum

Complex element StockNum (US) provides the equipment stock number and indicates the type of stock number..

Returns:

a StockNum instance

Since:

3.1.0

isSetStockNum

public boolean isSetStockNum()

Determine if the StockNum is configured.

Returns:

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

unsetStockNum

public void unsetStockNum()

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

getUsingCountries

public Set<UsingCountries> getUsingCountries()

Get the US:UsingCountries

Complex element UsingCountries (US) describes the countries that manufacture (Producing), supply (Source), and use (Using) the RFSystem..

Returns:

a UsingCountries instance

Since:

3.1.0

isSetUsingCountries

public boolean isSetUsingCountries()

Determine if the UsingCountries is configured.

Returns:

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

unsetUsingCountries

public void unsetUsingCountries()

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

withFieldedStatus

public RFSystem withFieldedStatus(ListCSG value)

Set the current stage of the RFSystem.

Parameters:

value - An instances of type ListCSG.

Returns:

The current RFSystem object instance.

Since:

3.1.0

withEmergency

public RFSystem withEmergency(ListCBO value)

Set "Yes" if the system may be used in a case of emergency.

Parameters:

value - An instances of type ListCBO.

Returns:

The current RFSystem object instance.

Since:

3.1.0

withInitialCost

public RFSystem withInitialCost(String value)

Set the estimated initial cost, in US dollars, of the system/equipment.

Parameters:

value - An instances of type String.

Returns:

The current RFSystem object instance.

Since:

3.1.0

withPOCInformation

public RFSystem 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 RFSystem object instance.

Since:

3.1.0

withPOCInformation

public RFSystem 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 RFSystem object instance.

Since:

3.1.0

withNomenclature

public RFSystem withNomenclature(Nomenclature... values)

Set the Nomenclature

Complex element Nomenclature identifies either the standard military, government, nomenclature or the commercial model number of an equipment. Each device or group of devices may have several types of nomenclatures, e.g. both a military nomenclature and a commercial model number.

Parameters:

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

Returns:

The current RFSystem object instance.

Since:

3.1.0

withNomenclature

public RFSystem withNomenclature(Collection<Nomenclature> values)

Set the Nomenclature

Complex element Nomenclature identifies either the standard military, government, nomenclature or the commercial model number of an equipment. Each device or group of devices may have several types of nomenclatures, e.g. both a military nomenclature and a commercial model number.

Parameters:

values - A collection of Nomenclature instances

Returns:

The current RFSystem object instance.

Since:

3.1.0

withDeployment

public RFSystem withDeployment(Deployment... values)

Set the Deployment

Complex element Deployment provides the general type of equipment deployment. For the detailed data, the appropriate force element and platforms elements should be referenced. Data element Deployment identifies the general category of how the equipment is deployed. For example an equipment may be deployed on an airborne platform, a ship or fixed land installation.

Parameters:

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

Returns:

The current RFSystem object instance.

Since:

3.1.0

withDeployment

public RFSystem withDeployment(Collection<Deployment> values)

Set the Deployment

Complex element Deployment provides the general type of equipment deployment. For the detailed data, the appropriate force element and platforms elements should be referenced. Data element Deployment identifies the general category of how the equipment is deployed. For example an equipment may be deployed on an airborne platform, a ship or fixed land installation.

Parameters:

values - A collection of Deployment instances

Returns:

The current RFSystem object instance.

Since:

3.1.0

withConfiguration

public RFSystem withConfiguration(Configuration... values)

Set the Configuration

Complex element 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. It also identifies the functional use of the assigned frequency at a particular transmitting station. Finally, it may indicate if the receiver station is used primarily as a repeater. A direct coupling between the station's receiver and the station's transmitter allows the incoming signal to be retransmitted exactly as received.

Parameters:

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

Returns:

The current RFSystem object instance.

Since:

3.1.0

withConfiguration

public RFSystem withConfiguration(Collection<Configuration> values)

Set the Configuration

Complex element 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. It also identifies the functional use of the assigned frequency at a particular transmitting station. Finally, it may indicate if the receiver station is used primarily as a repeater. A direct coupling between the station's receiver and the station's transmitter allows the incoming signal to be retransmitted exactly as received.

Parameters:

values - A collection of Configuration instances

Returns:

The current RFSystem object instance.

Since:

3.1.0

withRelatedSystem

public RFSystem withRelatedSystem(RelatedSystem... values)

Set the RelatedSystem

Complex element RelatedSystem identifies a System linked to the current System, and the relation (parent, child, sibling).

Parameters:

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

Returns:

The current RFSystem object instance.

Since:

3.1.0

withRelatedSystem

public RFSystem withRelatedSystem(Collection<RelatedSystem> values)

Set the RelatedSystem

Complex element RelatedSystem identifies a System linked to the current System, and the relation (parent, child, sibling).

Parameters:

values - A collection of RelatedSystem instances

Returns:

The current RFSystem object instance.

Since:

3.1.0

withStockNum

public RFSystem withStockNum(StockNum... values)

Set the US:StockNum

Complex element StockNum (US) provides the equipment stock number and indicates the type of stock number.

Parameters:

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

Returns:

The current RFSystem object instance.

Since:

3.1.0

withStockNum

public RFSystem withStockNum(Collection<StockNum> values)

Set the US:StockNum

Complex element StockNum (US) provides the equipment stock number and indicates the type of stock number.

Parameters:

values - A collection of StockNum instances

Returns:

The current RFSystem object instance.

Since:

3.1.0

withUsingCountries

public RFSystem withUsingCountries(UsingCountries... values)

Set the US:UsingCountries

Complex element UsingCountries (US) describes the countries that manufacture (Producing), supply (Source), and use (Using) the RFSystem.

Parameters:

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

Returns:

The current RFSystem object instance.

Since:

3.1.0

withUsingCountries

public RFSystem withUsingCountries(Collection<UsingCountries> values)

Set the US:UsingCountries

Complex element UsingCountries (US) describes the countries that manufacture (Producing), supply (Source), and use (Using) the RFSystem.

Parameters:

values - A collection of UsingCountries instances

Returns:

The current RFSystem object instance.

Since:

3.1.0

toString

public String toString()

Get a string representation of this RFSystem instance configuration.

Overrides:

toString in class Common<RFSystem>

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.

RFSystem requires cls, Serial, EntryDateTime.

Note that this method only checks for the presence of required information; this method does not validate the information format.

Overrides:

isSet in class Common<RFSystem>

Returns:

TRUE if required fields are set, otherwise FALSE