public class JammingPlan extends Object
Element of RadiationPlan
Sub-Element is JammingTarget
Example: See RadiationPlan
.
Constructor and Description |
---|
JammingPlan() |
Modifier and Type | Method and Description |
---|---|
Set<JammingTarget> |
getJammingTarget()
Get the US:JammingTarget
|
TString |
getLevel3Auth()
Get In Data Item Level3Auth (US), indicate if a request should go directly
to third-level authorization.
|
S100 |
getName()
Get In Data Item Name (US), enter a unique name (within the parent
RadiationPlan) for the Jamming Plan..
|
UN6 |
getNumFreqs()
Get the number of discrete frequencies or frequency ranges associated with
this Jamming Plan.
|
TString |
getPriority()
Get the relative priority of the service request..
|
TString |
getRequiredEffect()
Get the desired effect of this service request..
|
TString |
getRequiredPerformance()
Get the desired effectiveness of the service request.
|
DistSpace |
getStandOffDist()
Get the required distance from the jammer to non-threat equipment, in km..
|
DT |
getStartDateTime()
Get the date/time stamp when to initiate the jamming, if "Date/Time" is
used in element StartTrigger.
|
Location |
getStartLocation()
Get the Location serial indicating the region associated with "Troops in
Region" or "Troops Not in Region", in attribute StartTrigger..
|
Serial |
getStartLocationRef()
Deprecated.
SSRF references are managed automatically. Use
getStartLocation() instead. |
TString |
getStartTrigger()
Get the type of trigger that indicates when it is time to start jamming..
|
DT |
getStopDateTime()
Get the date/time stamp when to stop the jamming, if "Date/Time" is used in
element StopTrigger.
|
Location |
getStopLocation()
Get the Location serial indicating the region associated with "Troops in
Region" or "Troops Not in Region", in attribute StopTrigger..
|
Serial |
getStopLocationRef()
Deprecated.
SSRF references are managed automatically.
|
TString |
getStopTrigger()
Get the type of trigger that indicates when it is time to stop jamming..
|
S10 |
getVersion()
Get the current version of the Jamming Plan..
|
boolean |
isSet()
Determine if the required fields in this SSRF data type instance are set.
|
boolean |
isSetJammingTarget()
Determine if the JammingTarget is configured.
|
boolean |
isSetLevel3Auth()
Determine if the Level3Auth is configured.
|
boolean |
isSetName()
Determine if the Name is configured.
|
boolean |
isSetNumFreqs()
Determine if the NumFreqs is configured.
|
boolean |
isSetPriority()
Determine if the Priority is configured.
|
boolean |
isSetRequiredEffect()
Determine if the RequiredEffect is configured.
|
boolean |
isSetRequiredPerformance()
Determine if the RequiredPerformance is configured.
|
boolean |
isSetStandOffDist()
Determine if the StandOffDist is configured.
|
boolean |
isSetStartDateTime()
Determine if the StartDateTime is configured.
|
boolean |
isSetStartLocation()
Determine if the startLocation field is configured.
|
boolean |
isSetStartLocationRef()
Determine if the StartLocationRef is configured.
|
boolean |
isSetStartTrigger()
Determine if the StartTrigger is configured.
|
boolean |
isSetStopDateTime()
Determine if the StopDateTime is configured.
|
boolean |
isSetStopLocation()
Determine if the stopLocation field is configured.
|
boolean |
isSetStopLocationRef()
Determine if the StopLocationRef is configured.
|
boolean |
isSetStopTrigger()
Determine if the StopTrigger is configured.
|
boolean |
isSetVersion()
Determine if the Version is configured.
|
void |
postLoad(SSRF root)
Update the SSRF data type references in this JammingPlan record after
loading from XML.
|
void |
prepare()
Update the SSRF data type references in this JammingPlan record.
|
void |
setLevel3Auth(TString value)
Set In Data Item Level3Auth (US), indicate if a request should go directly
to third-level authorization.
|
void |
setName(S100 value)
Set In Data Item Name (US), enter a unique name (within the parent
RadiationPlan) for the Jamming Plan..
|
void |
setNumFreqs(UN6 value)
Set the number of discrete frequencies or frequency ranges associated with
this Jamming Plan.
|
void |
setPriority(TString value)
Set the relative priority of the service request..
|
void |
setRequiredEffect(TString value)
Set the desired effect of this service request..
|
void |
setRequiredPerformance(TString value)
Set the desired effectiveness of the service request.
|
void |
setStandOffDist(DistSpace value)
Set the required distance from the jammer to non-threat equipment, in km..
|
void |
setStartDateTime(DT value)
Set the date/time stamp when to initiate the jamming, if "Date/Time" is
used in element StartTrigger.
|
void |
setStartLocationRef(Serial value)
Deprecated.
SSRF references are managed automatically. Use
#setStartLocation(Location) instead. |
void |
setStartTrigger(TString value)
Set the type of trigger that indicates when it is time to start jamming..
|
void |
setStopDateTime(DT value)
Set the date/time stamp when to stop the jamming, if "Date/Time" is used in
element StopTrigger.
|
void |
setStopLocationRef(Serial value)
Deprecated.
SSRF references are managed automatically.
|
void |
setStopTrigger(TString value)
Set the type of trigger that indicates when it is time to stop jamming..
|
void |
setVersion(S10 value)
Set the current version of the Jamming Plan..
|
String |
toString()
Get a string representation of this JammingPlan instance configuration.
|
void |
unsetJammingTarget()
Clear the JammingTarget field.
|
JammingPlan |
withJammingTarget(Collection<JammingTarget> values)
Set the US:JammingTarget
|
JammingPlan |
withJammingTarget(JammingTarget... values)
Set the US:JammingTarget
|
JammingPlan |
withLevel3Auth(ListCBO value)
Set In Data Item Level3Auth (US), indicate if a request should go directly
to third-level authorization.
|
JammingPlan |
withName(String value)
Set In Data Item Name (US), enter a unique name (within the parent
RadiationPlan) for the Jamming Plan.
|
JammingPlan |
withNumFreqs(Integer value)
Set the number of discrete frequencies or frequency ranges associated with
this Jamming Plan.
|
JammingPlan |
withPriority(ListUWE value)
Set the relative priority of the service request.
|
JammingPlan |
withRequiredEffect(ListUWA value)
Set the desired effect of this service request.
|
JammingPlan |
withRequiredPerformance(ListUWB value)
Set the desired effectiveness of the service request.
|
JammingPlan |
withStandOffDist(Double value)
Set the required distance from the jammer to non-threat equipment, in km.
|
JammingPlan |
withStartDateTime(Calendar value)
Set the date/time stamp when to initiate the jamming, if "Date/Time" is
used in element StartTrigger.
|
JammingPlan |
withStartDateTime(Date value)
Set the date/time stamp when to initiate the jamming, if "Date/Time" is
used in element StartTrigger.
|
JammingPlan |
withStartLocation(Location value)
Set the Location serial indicating the region associated with "Troops in
Region" or "Troops Not in Region", in attribute StartTrigger.
|
JammingPlan |
withStartLocationRef(Serial value)
Deprecated.
SSRF references are managed automatically. Use
withStartLocation(Location) instead. |
JammingPlan |
withStartTrigger(ListUWF value)
Set the type of trigger that indicates when it is time to start jamming.
|
JammingPlan |
withStopDateTime(Calendar value)
Set the date/time stamp when to stop the jamming, if "Date/Time" is used in
element StopTrigger.
|
JammingPlan |
withStopDateTime(Date value)
Set the date/time stamp when to stop the jamming, if "Date/Time" is used in
element StopTrigger.
|
JammingPlan |
withStopLocation(Location value)
Set the Location serial indicating the region associated with "Troops in
Region" or "Troops Not in Region", in attribute StopTrigger.
|
JammingPlan |
withStopLocationRef(Serial value)
Deprecated.
SSRF references are managed automatically.
|
JammingPlan |
withStopTrigger(ListUWF value)
Set the type of trigger that indicates when it is time to stop jamming.
|
JammingPlan |
withVersion(String value)
Set the current version of the Jamming Plan.
|
public S100 getName()
S100
instancepublic void setName(S100 value)
value
- a S100
instancepublic boolean isSetName()
public UN6 getNumFreqs()
UN6
instancepublic void setNumFreqs(UN6 value)
value
- a UN6
instancepublic boolean isSetNumFreqs()
public TString getPriority()
TString
data typepublic void setPriority(TString value)
value
- the Priority value in a TString
data typepublic boolean isSetPriority()
If configured this method also inspects the TString
wrapped value.
public TString getRequiredEffect()
TString
data typepublic void setRequiredEffect(TString value)
value
- the RequiredEffect value in a TString
data typepublic boolean isSetRequiredEffect()
If configured this method also inspects the TString
wrapped value.
public TString getRequiredPerformance()
TString
data typepublic void setRequiredPerformance(TString value)
value
- the RequiredPerformance value in a TString
data typepublic boolean isSetRequiredPerformance()
If configured this method also inspects the TString
wrapped value.
public DT getStartDateTime()
DT
instancepublic void setStartDateTime(DT value)
value
- a DT
instancepublic boolean isSetStartDateTime()
@Deprecated public Serial getStartLocationRef()
getStartLocation()
instead.Serial
instance@Deprecated public void setStartLocationRef(Serial value)
#setStartLocation(Location)
instead.value
- a Serial
instancepublic boolean isSetStartLocationRef()
public TString getStartTrigger()
TString
data typepublic void setStartTrigger(TString value)
value
- the StartTrigger value in a TString
data typepublic boolean isSetStartTrigger()
If configured this method also inspects the TString
wrapped value.
public DT getStopDateTime()
DT
instancepublic void setStopDateTime(DT value)
value
- a DT
instancepublic boolean isSetStopDateTime()
@Deprecated public Serial getStopLocationRef()
Serial
instance@Deprecated public void setStopLocationRef(Serial value)
value
- a Serial
instancepublic boolean isSetStopLocationRef()
public TString getStopTrigger()
TString
data typepublic void setStopTrigger(TString value)
value
- the StopTrigger value in a TString
data typepublic boolean isSetStopTrigger()
If configured this method also inspects the TString
wrapped value.
public S10 getVersion()
S10
instancepublic void setVersion(S10 value)
value
- a S10
instancepublic boolean isSetVersion()
public TString getLevel3Auth()
TString
data typepublic void setLevel3Auth(TString value)
value
- the Level3Auth value in a TString
data typepublic boolean isSetLevel3Auth()
If configured this method also inspects the TString
wrapped value.
public DistSpace getStandOffDist()
DistSpace
instancepublic void setStandOffDist(DistSpace value)
value
- a DistSpace
instancepublic boolean isSetStandOffDist()
public Set<JammingTarget> getJammingTarget()
Complex element JammingTarget (US) describes the target location and identifies the jamming loadset to be used..
JammingTarget
instancepublic boolean isSetJammingTarget()
public void unsetJammingTarget()
public JammingPlan withName(String value)
value
- An instances of type String
.public JammingPlan withNumFreqs(Integer value)
value
- An instances of type Integer
.public JammingPlan withPriority(ListUWE value)
value
- An instances of type ListUWE
.public JammingPlan withRequiredEffect(ListUWA value)
value
- An instances of type ListUWA
.public JammingPlan withRequiredPerformance(ListUWB value)
value
- An instances of type ListUWB
.public JammingPlan withStartDateTime(Calendar value)
value
- An instances of type Calendar
.public JammingPlan withStartDateTime(Date value)
value
- An instances of type Date
.@Deprecated public JammingPlan withStartLocationRef(Serial value)
withStartLocation(Location)
instead.value
- An instances of type Serial
.public JammingPlan withStartTrigger(ListUWF value)
value
- An instances of type ListUWF
.public JammingPlan withStopDateTime(Calendar value)
value
- An instances of type Calendar
.public JammingPlan withStopDateTime(Date value)
value
- An instances of type Date
.@Deprecated public JammingPlan withStopLocationRef(Serial value)
value
- An instances of type Serial
.public JammingPlan withStopTrigger(ListUWF value)
value
- An instances of type ListUWF
.public JammingPlan withVersion(String value)
value
- An instances of type String
.public JammingPlan withLevel3Auth(ListCBO value)
value
- An instances of type ListCBO
.public JammingPlan withStandOffDist(Double value)
value
- An instances of type Double
.public JammingPlan withJammingTarget(JammingTarget... values)
Complex element JammingTarget (US) describes the target location and identifies the jamming loadset to be used.
values
- One or more instances of type JammingTarget...
.public JammingPlan withJammingTarget(Collection<JammingTarget> values)
Complex element JammingTarget (US) describes the target location and identifies the jamming loadset to be used.
values
- A collection of JammingTarget
instancespublic String toString()
public boolean isSet()
JammingPlan
requires JammingTarget
,
Level3Auth
, Priority
, StartTrigger
, StopTrigger
.
Note that this method only checks for the presence of required information; this method does not validate the information format.
public Location getStartLocation()
Location
instancepublic boolean isSetStartLocation()
public JammingPlan withStartLocation(Location value)
value
- An instances of type Location
.public Location getStopLocation()
Location
instancepublic boolean isSetStopLocation()
public JammingPlan withStopLocation(Location value)
value
- An instances of type Location
.public void prepare()
This method builds the exported startLocationRef
field with values
from the transient startLocation
field. This method should
typically be called after the JammingPlan is configured and (optionally)
before exporting an SSRF message.
public void postLoad(SSRF root)
This method builds the transient startLocation
with values from
the imported startLocationRef
field. This method should typically
be called after the JammingPlan is imported from XML. * @param root the
SSRF root instance.
Copyright © 2016 OpenSSRF.org. All rights reserved.