public class AgendaMissionCommands extends Object
Constructor and Description |
---|
AgendaMissionCommands() |
Modifier and Type | Method and Description |
---|---|
static void |
addAttackElementTarget(AttackElementType attackElement,
String target,
String description)
Adds a target element to the attack element
|
static void |
addConstraintAvoidArea(AgendaConstraintListType constraintList,
AreaElementType avoidArea)
Adds an avoid area to the constraint list
|
static void |
addConstraintAvoidArea(AgendaConstraintListType constraintList,
int areaType,
int pointType,
List<double[]> points,
double areaParameter1,
double areaParameter2,
double areaParameter3,
int verticalType,
double verticalValue1,
double verticalValue2,
String description)
Adds an avoid area to the constraint list
|
static void |
addDecontaminateElementContaminate(DecontaminateElementType contaminantElement,
String contaminantName,
String description)
Adds a contaminant element to the decontaminate element
|
static void |
addDemolishElementTarget(DemolishElementType demolishElement,
String target,
String description)
Adds a target element to the demolish element
|
static void |
addGoalReportingCriteria(AgendaGoalElementType goalElement,
ReportingCriteriaElementType newReportingCriteria)
Adds a reporting criteria element to the goal
|
static void |
addGoalReportingCriteria(AgendaGoalElementType goalElement,
String value,
double periodicity,
String description)
Adds a reporting criteria to the agenda goal element
|
static void |
addIlluminateElementIlluminatorCharacteristic(IlluminateElementType illuminateElement,
String newChar,
String description)
Adds a characteristic to the illuminator object
|
static void |
addIlluminatorElementCharacteristic(IlluminatorElementType illuminatorElement,
String newCharacteristic,
String description)
Adds a characteristic to the illuminator element
|
static void |
addJamElementFrequencyRange(JamElementType jamElement,
double freq1,
double freq2,
String description)
Adds a frequency range element to the jam element
|
static void |
addMarkElementMarkerCharacteristic(MarkElementType markElement,
String newChar,
String description)
Adds a characteristic to the marker object
|
static void |
addMarkElementTarget(MarkElementType markElement,
String target,
String description)
Adds a target child element to the mark element
|
static void |
addMarkerElementCharacteristic(MarkerElementType marker,
String newChar,
String description)
Adds a characteristic to the marker element
|
static void |
addMonitorTransmissionsElementFrequencyRange(MonitorTransmissionsElementType monitorTransmissionsElement,
double freq1,
double freq2,
String description)
Adds a frequency range element to the jam element
|
static void |
addPatrolElementQualifier(PatrolElementType patrolElement,
String qualValue,
String description)
Adds a qualifier to the patrol element
|
static void |
addRendezvousElementQualifier(RendezvousElementType rendezvousElement,
String qualValue,
String description)
Adds a qualifier to the rendezvous element
|
static void |
addRendezvousElementTargetVehicleID(RendezvousElementType rendezvousElement,
int target)
Sets the rendezvous element target vehicle ID
|
static void |
addSampleEnvironmentElementContaminate(SampleEnvironmentElementType sampleEnvironment,
String contaminant,
String description)
Adds a contaminant element to the decontaminate element
|
static void |
addSearchElementTarget(SearchElementType searchElement,
Object target)
Adds a search target child element to the search
|
static void |
addSearchElementTarget(SearchElementType searchElement,
String target,
String description)
Adds a search target child element to the search
|
static void |
clearAttackElementTargets(AttackElementType attackElement)
Clears all targets from an attack element
|
static void |
clearDecontaminateElementContaminants(DecontaminateElementType contaminantElement)
Clears all contaminants from a decontaminate element
|
static void |
clearDemolishElementTargets(DemolishElementType demolishElement)
Clears all targets from an demolish element
|
static void |
clearGoalSpecifics(AgendaGoalElementType goalElement)
Clears all specifics (attack, decontaminate, etc.) from a goal
|
static void |
clearIlluminateElementIlluminatorCharacteristics(IlluminateElementType illuminateElement)
Clears all characteristics from the illuminator child element
|
static void |
clearIlluminatorElementCharacteristics(IlluminatorElementType illuminatorElement)
Clears all illuminator characteristics
|
static void |
clearJamElementFrequencyRanges(JamElementType jamElement)
Clears all frequency range elements from an jam element
|
static void |
clearMarkElementMarkerCharacteristics(MarkElementType markElement)
Clears all characteristics from the marker child element
|
static void |
clearMarkElementTargets(MarkElementType markElement)
Clears all targets from the mark object
|
static void |
clearMarkerElementCharacteristics(MarkerElementType marker)
Clears all marker characteristics
|
static void |
clearMonitorTransmissionsElementFrequencyRanges(MonitorTransmissionsElementType monitorTransmissionsElement)
Clears all frequency range elements from an jam element
|
static void |
clearPatrolElementQualifiers(PatrolElementType patrolElement)
Clears all of the patrol element qualifiers
|
static void |
clearRendezvousElementQualifiers(RendezvousElementType rendezvousElement)
Clears all of the rendezvous element qualifiers
|
static void |
clearRepositionElementRouting(RepositionElementType repositionElement)
Clears any routing currently associated with a Reposition element
|
static void |
clearSampleEnvironmentElementContaminants(SampleEnvironmentElementType sampleEnvironment)
Clears all contaminants from an decontaminate element
|
static AbsoluteTimingElementType |
createAbsoluteTimingElement(double start,
double stop,
String description)
Creates an absolute timing element
|
static AgendaConstraintListType |
createAgendaConstraintList()
Creates a constraint list element
|
static AgendaGoalListType |
createAgendaGoalList()
Creates a goal list element
|
static AreaElementType |
createAreaElement(int areaType,
int pointType,
List<double[]> points,
double areaParameter1,
double areaParameter2,
double areaParameter3,
int verticalType,
double verticalValue1,
double verticalValue2,
String description)
Creates an operating area element
|
static Object |
createAvoidAreaElement()
Creates an avoid area element
|
static AgendaGoalElementType |
createGoalElement(String goalID,
int timingType,
double startTime,
double durationEndTime,
boolean alert,
String description)
Creates a goal element
Does not create the goal-type-specific child element
Does not set the "nextOnSucceed" or "nextOnFail" attributes
|
static AbsoluteHorizontalPositionElementType |
createLaunchPositionElement(double xPosition,
double yPosition,
int positionType,
String description)
Creates a launch position element
|
static PositiveScalarElementType |
createMaxTimeElement(double maxTime,
String description)
Creates a goal maximum time element
|
static AbsoluteHorizontalPositionElementType |
createRecoveryPositionElement(double xPosition,
double yPosition,
int positionType,
String description)
Creates a recovery position element
|
static RouteElementType |
createRouteElement(int pointType,
List<double[]> points,
int verticalType,
double verticalValue1,
double verticalValue2,
String description)
Creates a route element for use in specifying ingress or egress routing
|
static void |
deleteAttackElementTarget(AttackElementType attackElement,
ActionObjectElementType target)
Deletes a target element from an attack element
|
static void |
deleteAttackElementTarget(AttackElementType attackElement,
int index)
Deletes a target (specified by index) from an attack element
|
static void |
deleteConstraintAvoidArea(AgendaConstraintListType constraintList,
AreaElementType avoidArea)
Removes an avoid area from the agenda constraint list
|
static void |
deleteConstraintAvoidArea(AgendaConstraintListType constraintList,
int index)
Removes an avoid area (specified by index) from the agenda constraint list
|
static void |
deleteDecontaminateElementContaminant(DecontaminateElementType contaminantElement,
ContaminantElementType contaminantToRemove)
Deletes identified contaminant from a decontaminate element
|
static void |
deleteDecontaminateElementContaminant(DecontaminateElementType contaminantElement,
int index)
Deletes indexed contaminant from a decontaminate element
|
static void |
deleteDemolishElementTarget(DemolishElementType demolishElement,
ActionObjectElementType target)
Deletes a target element from an demolish element
|
static void |
deleteDemolishElementTarget(DemolishElementType demolishElement,
int index)
Deletes a target (specified by index) from an demolish element
|
static void |
deleteGoalReportingCriteria(AgendaGoalElementType goalElement,
int index)
Removes a reporting criteria element (specified by index) from the goal
|
static void |
deleteGoalReportingCriteria(AgendaGoalElementType goalElement,
ReportingCriteriaElementType criteria)
Removes a reporting criteria element from the goal
|
static void |
deleteIlluminateElementIlluminatorCharacteristic(IlluminateElementType illuminateElement,
int index)
Deletes an illuminator characteristic specified by an index from the illuminator child element
|
static void |
deleteIlluminateElementIlluminatorCharacteristic(IlluminateElementType illuminateElement,
StringElementType characteristic)
Deletes an illuminator characteristic from the illuminator child element
|
static void |
deleteIlluminatorElementCharacteristic(IlluminatorElementType illuminatorElement,
int index)
Deletes an illuminator characteristic (specified by index) from the illuminator element
|
static void |
deleteIlluminatorElementCharacteristic(IlluminatorElementType illuminatorElement,
StringElementType characteristic)
Deletes an illuminator characteristic from the illuminator element
|
static void |
deleteJamElementFrequencyRange(JamElementType jamElement,
FrequencyRangeElementType range)
Deletes a frequency range element from an jam element
|
static void |
deleteJamElementFrequencyRange(JamElementType jamElement,
int index)
Deletes a frequency range (specified by index) from an jam element
|
static void |
deleteMarkElementMarkerCharacteristic(MarkElementType markElement,
int index)
Deletes an marker characteristic specified by an index from the marker child element
|
static void |
deleteMarkElementMarkerCharacteristic(MarkElementType markElement,
Object characteristic)
Deletes a marker characteristic from the marker child element
|
static void |
deleteMarkElementTarget(MarkElementType markElement,
ActionObjectElementType target)
Deletes a target child element (specified by index) from the mark element
|
static void |
deleteMarkElementTarget(MarkElementType markElement,
int index)
Deletes a target child element (specified by index) from the mark element
|
static void |
deleteMarkerElementCharacteristic(MarkerElementType marker,
int index)
Deletes an marker characteristic (specified by index) from the marker element
|
static void |
deleteMarkerElementCharacteristic(MarkerElementType marker,
StringElementType characteristic)
Deletes an marker characteristic from the marker element
|
static void |
deleteMonitorTransmissionsElementFrequencyRange(MonitorTransmissionsElementType monitorTransmissionsElement,
FrequencyRangeElementType range)
Deletes a frequency range element from an jam element
|
static void |
deleteMonitorTransmissionsElementFrequencyRange(MonitorTransmissionsElementType monitorTransmissionsElement,
int index)
Deletes a frequency range (specified by index) from an jam element
|
static void |
deletePatrolElementQualifier(PatrolElementType patrolElement,
int index)
Deletes a patrol element qualifier specified by index
|
static void |
deletePatrolElementQualifier(PatrolElementType patrolElement,
StringElementType qualifier)
Deletes a patrol element qualifier
|
static void |
deleteRendezvousElementQualifier(RendezvousElementType rendezvousElement,
int index)
Deletes a rendezvous element qualifier specified by index
|
static void |
deleteRendezvousElementQualifier(RendezvousElementType rendezvousElement,
StringElementType qualifier)
Deletes a rendezvous element qualifier
|
static void |
deleteSampleEnvironmentElementContaminant(SampleEnvironmentElementType sampleEnvironment,
ContaminantElementType contaminant)
Deletes a target element from an attack element
|
static void |
deleteSampleEnvironmentElementContaminant(SampleEnvironmentElementType sampleEnvironment,
int index)
Deletes a target (specified by index) from an attack element
|
static void |
deleteSearchElementTarget(SearchElementType searchElement,
ActionObjectElementType target)
Removes a target (specified by index) from the search
|
static void |
deleteSearchElementTarget(SearchElementType searchElement,
int index)
Removes a target (specified by index) from the search
|
static AttackElementType |
generateAttackElement(String weaponStatus,
boolean singleTarget,
boolean disableOnly,
String description)
Generates an Attack element to define the intent of a goal
|
static DecontaminateElementType |
generateDecontaminateElement(String description)
Generates a Decontaminate element to define the intent of a goal
|
static DemolishElementType |
generateDemolishElement(boolean permanentDisable,
boolean singleTarget,
String description)
Generates an Demolish element to define the intent of a goal
|
static IlluminateElementType |
generateIlluminateElement(String illumType,
String description)
Generates an Illuminate element to define the intent of a goal
|
static JamElementType |
generateJamElement(String description)
Generates an Jam element to define the intent of a goal
|
static MarkElementType |
generateMarkElement(String markerType,
String description)
Generates an Mark element to define the intent of a goal
|
static MonitorTransmissionsElementType |
generateMonitorTransmissionsElement(String description)
Generates an MonitorTransmissions element to define the intent of a goal
|
static PatrolElementType |
generatePatrolElement(String description)
Generates an Patrol element to define the intent of a goal
|
static RendezvousElementType |
generateRendezvousElement(int target,
String description)
Generates an Rendezvous element to define the intent of a goal
|
static RepositionElementType |
generateRepositionElement(String description)
Generates a Reposition element to define the intent of a goal
|
static SampleEnvironmentElementType |
generateSampleEnvironmentElement(String description)
Generates an SampleEnvironment element to define the intent of a goal
|
static SearchElementType |
generateSearchElement(DatumTypeType datumType,
double pd,
boolean singleTarget,
String description)
Generates an Search element to define the intent of a goal
|
static String |
getAbsoluteTimingDescription(AbsoluteTimingElementType absoluteTiming)
Returns the value of the description attribute of the absolute timing element
|
static double |
getAbsoluteTimingStart(AbsoluteTimingElementType absoluteTiming)
Returns the start time of the absolute timing element
|
static double |
getAbsoluteTimingStop(AbsoluteTimingElementType absoluteTiming)
Returns the stop time of the absolute timing element
|
static String |
getActionObjectDescription(ActionObjectElementType actionObject)
Returns the description attribute value of the action object element
|
static String |
getActionObjectName(ActionObjectElementType actionObject)
Returns the name of the object to which the goal pertains
|
static AgendaConstraintListType |
getAgendaConstraintList(AgendaMissionElementType agendaElement)
Returns a reference to the constraint list
|
static AgendaGoalListType |
getAgendaGoalList(AgendaMissionElementType agendaElement)
Returns a reference to the goal list
|
static String |
getAreaDescription(AreaElementType area)
Returns the value of the description attribute of the area
|
static Object |
getAreaGeometry(AreaElementType area)
Returns the geometric type of the area
|
static int |
getAreaGeometryType(AreaElementType area)
Returns the enumeration for the type of geometric area represented
|
static double |
getAreaVerticalMax(AreaElementType area)
Returns the maximum vertical control value (no value if single value control)
|
static double |
getAreaVerticalMin(AreaElementType area)
Returns the vertical control value (minimum if an altitude block)
|
static int |
getAreaVerticalType(AreaElementType area)
Returns the enumeration for the type of vertical control required by the area
|
static String |
getAttackElementDescription(AttackElementType attackElement)
Returns the description attribute of an attack element
|
static boolean |
getAttackElementDisableOnly(AttackElementType attackElement)
Returns the attack element disableOnly attribute value
|
static int |
getAttackElementNumTargets(AttackElementType attackElement)
Returns the number of target child elements
|
static boolean |
getAttackElementSingleTarget(AttackElementType attackElement)
Returns the attack element singleTarget attribute value
|
static String |
getAttackElementTarget(AttackElementType attackElement,
int index)
Returns the target element specified by an index
|
static String |
getAttackElementWeaponStatus(AttackElementType attackElement)
Returns the weapons status property of the attack element
|
static double[] |
getCircleElementCenter(CircleElementType circle)
Returns a 1 x 2 array with the center point of the circle
|
static int |
getCircleElementCenterPointType(CircleElementType circle)
Returns the enumeration for how the center of the circle is specified
|
static String |
getCircleElementDescription(CircleElementType circle)
Returns the description attribute of the circle
|
static double |
getCircleElementRadius(CircleElementType circle)
Returns the radius of the circle
|
static AreaElementType |
getConstraintAvoidArea(AgendaConstraintListType constraintList,
int index)
Returns the constraint avoid area specified by the index
|
static int |
getConstraintAvoidAreaIndex(AgendaConstraintListType constraintList,
AreaElementType avoidArea)
Returns the index of a specific avoid area
|
static List<AreaElementType> |
getConstraintAvoidAreas(AgendaConstraintListType constraintList)
Returns the agenda's avoid areas list
|
static int |
getConstraintNumberOfAvoidAreas(AgendaConstraintListType constraintList)
Returns the number of avoid areas in the agenda mission
|
static String |
getContaminantElementDescription(ContaminantElementType contaminantElement)
Returns the description attribute value of the contaminant element
|
static String |
getContaminantElementType(ContaminantElementType contaminantElement)
Returns the type of contaminant
|
static String |
getDecontaminateElementContaminant(DecontaminateElementType contaminantElement,
int index)
Returns the contaminant element specified by an index
|
static String |
getDecontaminateElementDescription(DecontaminateElementType contaminantElement)
Returns the description attribute of an Decontaminate element
|
static int |
getDecontaminateElementNumContaminants(DecontaminateElementType contaminantElement)
Returns the number of contaminant child elements
|
static String |
getDemolishElementDescription(DemolishElementType demolishElement)
Returns the description attribute of an demolish element
|
static int |
getDemolishElementNumTargets(DemolishElementType demolishElement)
Returns the number of target child elements
|
static boolean |
getDemolishElementPermanentDisable(DemolishElementType demolishElement)
Returns the demolish element
permanentDisable attribute value |
static boolean |
getDemolishElementSingleTarget(DemolishElementType demolishElement)
Returns the demolish element single target attribute value
|
static String |
getDemolishElementTarget(DemolishElementType demolishElement,
int index)
Returns the target element specified by an index
|
static double |
getDepthOrAltitude(PositiveScalarElementType depthOrAltitudeBlock)
Returns the value of the depth or altitude element
|
static String |
getDepthOrAltitudeDescription(PositiveScalarElementType depthOrAltitudeBlock)
Returns the value of the description attribute of the depth or altitude element
|
static String |
getFrequencyRangeDescription(FrequencyRangeElementType frequencyRange)
Returns the description attribute value of the action object element
|
static double |
getFrequencyRangeMaximum(FrequencyRangeElementType frequencyRange)
Returns the minimum frequency of the range
|
static double |
getFrequencyRangeMinimum(FrequencyRangeElementType frequencyRange)
Returns the minimum frequency of the range
|
static AgendaGoalElementType |
getGoal(AgendaGoalListType goalList,
int index)
Returns the agenda goal specified by the index
|
static String |
getGoalActionObject(AgendaGoalElementType goalElement,
int index)
Returns the action object of a goal specified by the index parameter
|
static String |
getGoalDescription(AgendaGoalElementType goalElement)
Returns the value of the description attribute of the goal element
|
static double |
getGoalDuration(AgendaGoalElementType goalElement)
Returns the agenda goal duration/time out
|
static String |
getGoalId(AgendaGoalElementType goalElement)
Returns the successor on goal success of a goal in the finite state machine
|
static int |
getGoalIndex(AgendaGoalListType goalList,
AgendaGoalElementType goalElement)
Returns the index of a specific dependence
|
static boolean |
getGoalIsAlert(AgendaGoalElementType goalElement)
Returns true if the goal is an alert (be ready to do it, but don't until ordered)
|
static String |
getGoalListDescription(AgendaGoalListType goalList)
Returns the description attribute of the goal list
|
static int |
getGoalListSize(AgendaGoalListType goalList)
Returns the number of goals in the agenda
|
static String |
getGoalName(AgendaGoalElementType goalElement)
Returns name for the type of goal contained in a goal element
|
static AgendaGoalElementType |
getGoalNextOnFail(AgendaGoalElementType goalElement)
Returns the successor on goal failure of a goal in the finite state machine
|
static AgendaGoalElementType |
getGoalNextOnSucceed(AgendaGoalElementType goalElement)
Returns the successor on goal success of a goal in the finite state machine
|
static int |
getGoalNumActionObjects(AgendaGoalElementType goalElement)
Returns the number of action objects of the goal
|
static int |
getGoalNumReportingCriteria(AgendaGoalElementType goalElement)
Returns the number of reporting criteria child elements in the goal
|
static AreaElementType |
getGoalOperatingArea(AgendaGoalElementType goalElement)
Returns the operating area child element of the goal
|
static ReportingCriteriaElementType |
getGoalReportingCriteria(AgendaGoalElementType goalElement,
int index)
Returns the agenda goal's ReportingCriteria dependence specified by the index
|
static int |
getGoalReportingCriteriaIndex(AgendaGoalElementType goalElement,
ReportingCriteriaElementType reportingCriteria)
Returns the index of a specific reporting criteria element
|
static double |
getGoalStartTime(AgendaGoalElementType goalElement)
Returns the agenda goal start time
|
static double |
getGoalStopTime(AgendaGoalElementType goalElement)
Returns the agenda goal end time
|
static int |
getGoalType(AgendaGoalElementType goalElement)
Returns an enumeration for the type of goal contained in a goal element
|
static String |
getIlluminateElementDescription(IlluminateElementType illuminateElement)
Returns the description attribute of an Illuminate element
|
static String |
getIlluminateElementIlluminatorCharacteristic(IlluminateElementType illuminateElement,
int index)
Returns the number of illuminator characteristics of the illuminator element
|
static String |
getIlluminateElementIlluminatorDescription(IlluminateElementType illuminateElement)
Returns the illuminator description of the illuminate element
|
static String |
getIlluminateElementIlluminatorType(IlluminateElementType illuminateElement)
Returns the type of illuminator called for by the illuminate element
|
static int |
getIlluminateElementNumIlluminatorCharacteristics(IlluminateElementType illuminateElement)
Returns the number of illuminator characteristics of the illuminator element
|
static String |
getIlluminatorCharacteristicElementDescription(StringElementType illuminatorCharacteristic)
Returns the description attribute value of the illuminator characteristic element
|
static String |
getIlluminatorCharacteristicElementValue(StringElementType illuminatorCharacteristic)
Returns the string value of the illuminator characteristic element
|
static StringElementType |
getIlluminatorElementCharacteristic(IlluminatorElementType illuminatorElement,
int index)
Returns the illuminator characteristic element specified by the index
|
static String |
getIlluminatorElementDescription(IlluminatorElementType illuminatorElement)
Returns the value of the description attribute of the illuminator element
|
static int |
getIlluminatorElementNumberOfCharacteristics(IlluminatorElementType illuminatorElement)
Returns the number of illuminator characteristic child elements of the illuminator element
|
static String |
getIlluminatorElementType(IlluminatorElementType illuminatorElement)
Returns the type of illuminator specified by the illuminator element
|
static String |
getJamElementDescription(JamElementType jamElement)
Returns the description attribute of an Jam element
|
static FrequencyRangeElementType |
getJamElementFrequencyRange(JamElementType jamElement,
int index)
Returns the frequency range element specified by the index
|
static int |
getJamElementNumberOfFrequencyRanges(JamElementType jamElement)
Returns the number of frequency range child elements
|
static JAXBElement<?> |
getJAXBElementAgendaAvoidArea(AreaElementType value) |
static JAXBElement<?> |
getJAXBElementAgendaGoal(AgendaGoalElementType value) |
static JAXBElement<?> |
getJAXBElementAgendaLaunchPosition(AbsoluteHorizontalPositionElementType ahpet)
Retrieve an AbsoluteHorizontalPositionElementType as an agenda
launch position
|
static JAXBElement<?> |
getJAXBElementAgendaRecoveryPosition(AbsoluteHorizontalPositionElementType ahpet)
Retrieve an AbsoluteHorizontalPositionElementType as an agenda
recovery position
|
static String |
getLaunchPositionElementDescription(AbsoluteHorizontalPositionElementType positionElement)
Returns the description attribute value of the launch position element
|
static int |
getLaunchPositionElementPositionType(AbsoluteHorizontalPositionElementType positionElement)
Returns an enumeration defining how the position is specified in the launch position element
|
static double |
getLaunchPositionElementXPosition(AbsoluteHorizontalPositionElementType positionElement)
Returns the X or Latitude coordinate of the launch position element
|
static double |
getLaunchPositionElementYPosition(AbsoluteHorizontalPositionElementType positionElement)
Returns the Y or Longitude coordinate of the launch position element
|
static int |
getLimitingElementPointType(LimitingLineElementType limitingLine)
Returns the enumeration for how the points of the limit
|
static String |
getLimitingLineElementDescription(LimitingLineElementType limitingLine)
Returns the description attribute of the limiting line
|
static List |
getLimitingLineElementPoints(LimitingLineElementType limitingLine)
Returns the ordered List of points defining the limiting line
|
static double |
getLimitingLineElementPointX(LimitingLineElementType limitingLine,
int pointIndex)
Provide x value of limiting line of interest
|
static double |
getLimitingLineElementPointY(LimitingLineElementType limitingLine,
int pointIndex)
Provide y value of limiting line of interest
|
static String |
getMarkElementDescription(MarkElementType markElement)
Returns the description attribute of an Mark element
|
static String |
getMarkElementMarkerCharacteristic(MarkElementType markElement,
int index)
Returns the number of marker characteristics of the marker element
|
static String |
getMarkElementMarkerDescription(MarkElementType markElement)
Returns the marker description of the mark element
|
static String |
getMarkElementMarkerType(MarkElementType markElement)
Returns the type of marker called for by the mark element
|
static int |
getMarkElementNumMarkerCharacteristics(MarkElementType markElement)
Returns the number of marker characteristics of the marker element
|
static int |
getMarkElementNumTargets(MarkElementType markElement)
Returns the number of target child elements of the mark object
|
static String |
getMarkElementTarget(MarkElementType markElement,
int index)
Returns the target child element (specified by index) of the mark object
|
static String |
getMarkerCharacteristicElementDescription(StringElementType illuminatorCharacteristic)
Returns the description attribute value of the marker characteristic element
|
static String |
getMarkerCharacteristicElementValue(StringElementType illuminatorCharacteristic)
Returns the string value of the marker characteristic element
|
static StringElementType |
getMarkerElementCharacteristic(MarkerElementType marker,
int index)
Returns the marker characteristic element specified by the index
|
static String |
getMarkerElementDescription(MarkerElementType marker)
Returns the value of the description attribute of the marker element
|
static int |
getMarkerElementNumberOfCharacteristics(MarkerElementType marker)
Returns the number of marker characteristic child elements of the marker element
|
static String |
getMarkerElementType(MarkerElementType marker)
Returns the type of marker specified by the marker element
|
static String |
getMaxTimeDescription(PositiveScalarElementType maxTime)
Returns the value of the description attribute of the maximum time element
|
static double |
getMaxTimeValue(PositiveScalarElementType maxTime)
Returns the maximum time to devote to this goal once started
|
static String |
getMonitorTransmissionsElementDescription(MonitorTransmissionsElementType monitorTransmissionsElement)
Returns the description attribute of an MonitorTransmissions element
|
static FrequencyRangeElementType |
getMonitorTransmissionsElementFrequencyRange(MonitorTransmissionsElementType monitorTransmissionsElement,
int index)
Returns the frequency range element specified by the index
|
static int |
getMonitorTransmissionsElementNumFrequencyRanges(MonitorTransmissionsElementType monitorTransmissionsElement)
Returns the number of frequency range child elements
|
static String |
getPatrolElementDescription(PatrolElementType patrolElement)
Returns the description attribute of an Patrol element
|
static int |
getPatrolElementNumberOfQualifiers(PatrolElementType patrolElement)
Returns the number of qualifier child elements of a patrol element
|
static StringElementType |
getPatrolElementQualifier(PatrolElementType patrolElement,
int index)
Returns the qualifier child element specified by the index
|
static String |
getPatrolElementQualifierDescription(PatrolElementType patrolElement,
int index)
Returns the description of the qualifier specified by the index
|
static String |
getPatrolElementQualifierValue(PatrolElementType patrolElement,
int index)
Returns the value of the qualifier specified by the index
|
static String |
getPointElementDescription(AbsoluteHorizontalPositionElementType point)
Returns the description attribute of the point
|
static double[] |
getPointElementPoint(AbsoluteHorizontalPositionElementType point)
Returns a 1 x 2 array with the location of the point
|
static int |
getPointElementPointType(AbsoluteHorizontalPositionElementType point)
Returns the enumeration for how the location of the point is specified
|
static String |
getPolygonElementDescription(PolygonElementType polygon)
Returns the description attribute of the polygon
|
static int |
getPolygonElementNumPoints(PolygonElementType polygon)
Returns the number of vertices in the polygon
|
static double[] |
getPolygonElementPoint(PolygonElementType polygon,
int point)
Returns a double[2] with a requested vertex's coordinates
|
static List |
getPolygonElementPoints(PolygonElementType polygon)
Returns the ordered List of points defining the polygon
|
static int |
getPolygonElementPointType(PolygonElementType polygon)
Returns the enumeration for how the points of the polygon are specified
|
static double |
getPolygonElementPointX(PolygonElementType polygon,
int point)
Returns the X coordinate or latitude of a polygon vertex
|
static double |
getPolygonElementPointY(PolygonElementType polygon,
int point)
Returns the Y coordinate of a polygon vertex
|
static String |
getQualifierElementDescription(StringElementType qualifier)
Returns the description attribute value of the qualifier element
|
static String |
getQualifierElementValue(StringElementType qualifier)
Returns the string value of the qualifier element
|
static String |
getRecoveryPositionElementDescription(AbsoluteHorizontalPositionElementType positionElement)
Returns the description attribute value of the recovery position element
|
static int |
getRecoveryPositionElementPositionType(AbsoluteHorizontalPositionElementType positionElement)
Returns an enumeration defining how the position is specified in the recovery position element
|
static double |
getRecoveryPositionElementXPosition(AbsoluteHorizontalPositionElementType positionElement)
Returns the X or Latitude coordinate of the recovery position element
|
static double |
getRecoveryPositionElementYPosition(AbsoluteHorizontalPositionElementType positionElement)
Returns the Y or Longitude coordinate of the recovery position element
|
static String |
getRectangleElementDescription(RectangleElementType rectangle)
Returns the description attribute of the rectangle
|
static double |
getRectangleElementHeight(RectangleElementType rectangle)
Returns the height of the rectangle
|
static double[] |
getRectangleElementNorthwestCorner(RectangleElementType rectangle)
Returns a 1 x 2 array with the northwest corner point of the rectangle
|
static int |
getRectangleElementNorthwestCornerPointType(RectangleElementType rectangle)
Returns the enumeration for how the northwest corner of the rectangle is specified
|
static double |
getRectangleElementRotation(RectangleElementType rectangle)
Returns the height of the rectangle
|
static double |
getRectangleElementWidth(RectangleElementType rectangle)
Returns the width of the rectangle
|
static String |
getRendezvousElementDescription(RendezvousElementType rendezvousElement)
Returns the description attribute of an Rendezvous element
|
static int |
getRendezvousElementNumberOfQualifiers(RendezvousElementType rendezvousElement)
Returns the number of qualifier child elements of a rendezvous element
|
static int |
getRendezvousElementNumberOfTargetVehicles(RendezvousElementType rendezvousElement)
Returns the number of rendezvous target vehicles
|
static StringElementType |
getRendezvousElementQualifier(RendezvousElementType rendezvousElement,
int index)
Returns the qualifier child element specified by the index
|
static String |
getRendezvousElementQualifierDescription(RendezvousElementType rendezvousElement,
int index)
Returns the description of the qualifier specified by the index
|
static String |
getRendezvousElementQualifierValue(RendezvousElementType rendezvousElement,
int index)
Returns the value of the qualifier specified by the index
|
static int |
getRendezvousElementTargetVehicleID(RendezvousElementType rendezvousElement,
int index)
Returns a target vehicle ID of the rendezvous vehicle identified by the sequence in the list
|
static String |
getReportingCriteriaDescription(ReportingCriteriaElementType reportingCriteria)
Returns the value of the description attribute of the reporting criteria element
|
static double |
getReportingCriteriaPeriodicity(ReportingCriteriaElementType reportingCriteria)
Returns the time between periodic reports
|
static String |
getReportingCriteriaValue(ReportingCriteriaElementType reportingCriteria)
Returns the description of when a report is required
|
static String |
getRepositionElementDescription(RepositionElementType repositionElement)
Returns the description attribute of a Reposition element
|
static RouteElementType |
getRepositionElementRouting(RepositionElementType repositionElement)
Returns the routing element of the Reposition goal
|
static String |
getRouteDescription(RouteElementType route)
Returns the value of the description attribute of the route
|
static List |
getRoutePointList(RouteElementType route,
int pointType)
Returns the point list of the route
|
static int |
getRoutePointType(RouteElementType route)
Returns the enumeration for how the points are represented (x,y or lat,long)
|
static double |
getRoutePtX(Object positionElement)
Returns the X or latitude component of a route point
|
static double |
getRoutePtY(Object positionElement)
Returns the Y or longitude component of a route point
|
static double |
getRouteVerticalMax(RouteElementType route)
Returns the maximum vertical control value (no value if single value control)
|
static double |
getRouteVerticalMin(RouteElementType route)
Returns the vertical control value (minimum if an altitude block)
|
static int |
getRouteVerticalType(RouteElementType route)
Returns the enumeration for the type of vertical control required by the route
|
static String |
getSampleEnvironmentElementContaminant(SampleEnvironmentElementType sampleEnvironment,
int index)
Returns the contaminant element specified by an index
|
static String |
getSampleEnvironmentElementDescription(SampleEnvironmentElementType sampleEnvironment)
Returns the description attribute of an SampleEnvironment element
|
static int |
getSampleEnvironmentElementNumberOfContaminants(SampleEnvironmentElementType sampleEnvironment)
Returns the number of contaminant child elements
|
static String |
getSearchElementDatumType(SearchElementType searchElement)
Returns the type of datum (point or area) of the search
|
static String |
getSearchElementDescription(SearchElementType searchElement)
Returns the description attribute of an Search element
|
static int |
getSearchElementNumberOfTargets(SearchElementType searchElement)
Returns the number of search targets of the search element
|
static double |
getSearchElementRequiredPD(SearchElementType searchElement)
Returns the required probability of detection (Pd) of the search
|
static boolean |
getSearchElementSingleTarget(SearchElementType searchElement)
Returns the value of the singleTarget attribute
|
static String |
getSearchElementTarget(SearchElementType searchElement,
int index)
Returns the search target object specified by the index
|
static Object |
getSpecificGoal(AgendaGoalElementType goalElement)
Returns the child representing the actual goal
|
static String |
getVerticalBlockDescription(NumericalBlockElementType verticalBlock)
Returns the value of the description attribute of the vertical block
|
static double |
getVerticalBlockMax(NumericalBlockElementType verticalBlock)
Returns the maximum value of the vertical block
|
static double |
getVerticalBlockMin(NumericalBlockElementType verticalBlock)
Returns the minimum value of the vertical block
|
static void |
setAbsoluteTimingDescription(AbsoluteTimingElementType absoluteTiming,
String newDescription)
Sets the description attribute of the absolute timing element
|
static void |
setAbsoluteTimingStart(AbsoluteTimingElementType absoluteTiming,
double newStartTime)
Sets the start time of the absolute timing element
|
static void |
setAbsoluteTimingStop(AbsoluteTimingElementType absoluteTiming,
double newStopTime)
Sets the stop time of the absolute timing element
|
static void |
setActionObjectDescription(ActionObjectElementType actionObject,
String newDescription)
Sets the description attribute of the action object element
|
static void |
setActionObjectName(ActionObjectElementType actionObject,
String newName)
Sets the name of the object tow which the goal pertains
|
static void |
setAreaDescription(AreaElementType area,
String newDescription)
Sets the description attribute of the dependence element
|
static void |
setAreaGeometry(AreaElementType area,
Object geometry)
Sets the geometry of the area
|
static void |
setAreaVerticalControl(AreaElementType area,
int controlType,
double verticalValue1,
double verticalValue2)
Sets the area element's vertical control element
|
static void |
setAttackElementDescription(AttackElementType attackElement,
String description)
Sets the description attribute of an attack element
|
static void |
setAttackElementDisableOnly(AttackElementType attackElement,
boolean value)
Sets the disable only attribute of the attack attribute
|
static void |
setAttackElementSingleTarget(AttackElementType attackElement,
boolean value)
Sets the singleTarget attribute of the attack attribute
|
static void |
setAttackElementWeaponStatus(AttackElementType attackElement,
String status)
Sets the weapon status attribute of an attack element
|
static void |
setCircleElementDescription(CircleElementType circle,
String description)
Sets the description attribute of the circle
|
static void |
setConstraintRouting(AgendaConstraintListType constraintList,
int ingressEgress,
int pointType,
List<double[]> points,
int verticalType,
double verticalValue1,
double verticalValue2,
String description)
Sets the ingress or egress routing of the goal
|
static void |
setConstraintRoutingGeography(AgendaConstraintListType constraintList,
int ingressEgress,
int pointType,
List<double[]> points,
String description)
Sets the geographic route portion of the routing element
|
static void |
setConstraintRoutingVertical(AgendaConstraintListType constraintList,
int ingressEgress,
int verticalType,
double verticalValue1,
double verticalValue2,
String description)
Sets the vertical control portion of the constraint's ingress or egress routing
|
static void |
setContaminantElementDescription(ContaminantElementType contaminantElement,
String newDescription)
Sets the description attribute of the contaminant element
|
static void |
setContaminantElementType(ContaminantElementType contaminantElement,
String newValue)
Sets the type of contaminant
|
static void |
setDecontaminateElementDescription(DecontaminateElementType contaminantElement,
String description)
Sets the description attribute of an Decontaminate element
|
static void |
setDemolishElementDescription(DemolishElementType demolishElement,
String description)
Sets the description attribute of an demolish element
|
static void |
setDemolishElementPermanentDisable(DemolishElementType demolishElement,
boolean value)
Sets the permanent disable attribute of the demolish element
|
static void |
setDemolishElementSingleTarget(DemolishElementType demolishElement,
boolean value)
Sets the single target attribute of the demolish element
|
static void |
setDepthOrAltitude(PositiveScalarElementType depthOrAltitudeBlock,
double newValue)
Sets the minimum value of the vertical block
|
static void |
setDepthOrAltitudeDescription(PositiveScalarElementType depthOrAltitudeBlock,
String newDescription)
Sets the minimum value of the vertical block
|
static void |
setFrequencyRangeBounds(FrequencyRangeElementType frequencyRange,
double bound1,
double bound2)
Sets the minimum frequency of the range
|
static void |
setFrequencyRangeDescription(FrequencyRangeElementType frequencyRange,
String newDescription)
Sets the description attribute of the action object element
|
static void |
setFrequencyRangeMaximum(FrequencyRangeElementType frequencyRange,
double newValue)
Sets the maximum frequency of the range
|
static void |
setFrequencyRangeMinimum(FrequencyRangeElementType frequencyRange,
double newValue)
Sets the minimum frequency of the range
|
static void |
setGoalAttack(AgendaGoalElementType goalElement,
AttackElementType specificGoal)
Sets the goal element to be of type attack
|
static void |
setGoalDecontaminate(AgendaGoalElementType goalElement,
DecontaminateElementType specificGoal)
Sets the goal element to be of type decontaminate
|
static void |
setGoalDemolish(AgendaGoalElementType goalElement,
DemolishElementType specificGoal)
Sets the goal element to be of type demolish
|
static void |
setGoalDescription(AgendaGoalElementType goalElement,
String description)
Sets a goal element's description attribute
|
static void |
setGoalDuration(AgendaGoalElementType goalElement,
double duration)
Returns the agenda goal duration/time out
|
static void |
setGoalID(AgendaGoalElementType goalElement,
String newID)
Sets the ID attribute of an agenda goal element
|
static void |
setGoalIlluminate(AgendaGoalElementType goalElement,
IlluminateElementType specificGoal)
Sets the goal element to be of type illuminate
|
static void |
setGoalIsAlert(AgendaGoalElementType goalElement,
boolean alert)
Sets the value of the alert attribute of the goal (true if the goal is an alert, not execute)
|
static void |
setGoalJam(AgendaGoalElementType goalElement,
JamElementType specificGoal)
Sets the goal element to be of type jam
|
static void |
setGoalMark(AgendaGoalElementType goalElement,
MarkElementType specificGoal)
Sets the goal element to be of type mark
|
static void |
setGoalMonitorTransmissions(AgendaGoalElementType goalElement,
MonitorTransmissionsElementType specificGoal)
Sets the goal element to be of type monitor transmissions
|
static void |
setGoalNextOnFail(AgendaGoalElementType goalElement,
AgendaGoalElementType next)
Sets the goal element's successor on goal failure
|
static void |
setGoalNextOnSucceed(AgendaGoalElementType goalElement,
AgendaGoalElementType next)
Sets the goal element's successor on goal success
|
static void |
setGoalOpArea(AgendaGoalElementType goalElement,
AreaElementType area)
Sets the operating area child element of the goal
|
static void |
setGoalOpArea(AgendaGoalElementType goalElement,
int areaType,
int pointType,
List<double[]> points,
double areaParameter1,
double areaParameter2,
double areaParameter3,
int verticalType,
double verticalValue1,
double verticalValue2,
String description)
Sets the operating area of the goal
|
static void |
setGoalOpAreaGeometry(AgendaGoalElementType goalElement,
int areaType,
int pointType,
List<double[]> points,
double areaParameter1,
double areaParameter2,
double areaParameter3,
String description)
Sets the geometric area of the goal
|
static void |
setGoalOpAreaVertical(AgendaGoalElementType goalElement,
int verticalType,
double verticalValue1,
double verticalValue2,
String description)
Sets the vertical control in the operating area of the goal
|
static void |
setGoalPatrol(AgendaGoalElementType goalElement,
PatrolElementType specificGoal)
Sets the goal element to be of type patrol
|
static void |
setGoalRendezvous(AgendaGoalElementType goalElement,
RendezvousElementType specificGoal)
Sets the goal element to be of type rendezvous
|
static void |
setGoalReposition(AgendaGoalElementType goalElement,
RepositionElementType specifics)
Sets the goal element to be of type reposition
|
static void |
setGoalSampleEnvironment(AgendaGoalElementType goalElement,
SampleEnvironmentElementType specificGoal)
Sets the goal element to be of type sample environment
|
static void |
setGoalSearch(AgendaGoalElementType goalElement,
SearchElementType specificGoal)
Sets the goal element to be of type search
|
static void |
setGoalTiming(AgendaGoalElementType goalElement,
double startTime,
double durationEndTime)
Sets the goal's start and stop times
|
static void |
setIlluminateElementDescription(IlluminateElementType illuminateElement,
String description)
Sets the description attribute of an Illuminate element
|
static void |
setIlluminateElementIlluminator(IlluminateElementType illuminateElement,
String illuminatorType,
String description)
Sets the Illuminator element
|
static void |
setIlluminatorCharacteristicElementDescription(StringElementType illuminatorCharacteristic,
String description)
Sets the description attribute of the illuminator characteristic element
|
static void |
setIlluminatorCharacteristicElementValue(StringElementType illuminatorCharacteristic,
String value)
Sets the String value of the illuminator characteristic element
|
static void |
setIlluminatorElementDescription(IlluminatorElementType illuminatorElement,
String description)
Sets the description attribute of the illuminator element
|
static void |
setIlluminatorElementType(IlluminatorElementType illuminatorElement,
String type)
Sets the illuminator element type
|
static void |
setJamElementDescription(JamElementType jamElement,
String description)
Sets the description attribute of an Jam element
|
static void |
setLaunchPosition(AgendaMissionElementType agendaElement,
AbsoluteHorizontalPositionElementType newLaunchPositionElement)
Sets the launch position element of an agenda mission
|
static void |
setLaunchPosition(AgendaMissionElementType agendaElement,
double xPosition,
double yPosition,
int positionType,
String description)
Sets the launch position element of an agenda mission
|
static void |
setLaunchPositionElementDescription(AbsoluteHorizontalPositionElementType positionElement,
String description)
Sets the start position element description
|
static void |
setLaunchPositionElementPosition(AbsoluteHorizontalPositionElementType positionElement,
double xPosition,
double yPosition,
int positionType)
Sets the start position element location values
|
static void |
setLimitingLineElementDescription(LimitingLineElementType limitingLine,
String description)
Sets the description attribute of the limiting line
|
static void |
setMarkElementDescription(MarkElementType markElement,
String description)
Sets the description attribute of an Mark element
|
static void |
setMarkElementMarkerType(MarkElementType markElement,
String markerType,
String description)
Sets the Marker element
|
static void |
setMarkerCharacteristicElementDescription(StringElementType illuminatorCharacteristic,
String description)
Sets the description attribute of the marker characteristic element
|
static void |
setMarkerCharacteristicElementValue(StringElementType illuminatorCharacteristic,
String value)
Sets the String value of the marker characteristic element
|
static void |
setMarkerElementDescription(MarkerElementType marker,
String description)
Sets the description attribute of the marker element
|
static void |
setMarkerElementType(MarkerElementType marker,
String type)
Sets the marker element type
|
static void |
setMaxTimeDescription(PositiveScalarElementType maxTime,
String newDescription)
Sets the description attribute of the maximum time element
|
static void |
setMaxTimeValue(PositiveScalarElementType maxTime,
double newValue)
Sets the maximum time to devote to this goal once started
|
static void |
setMonitorTransmissionsElementDescription(MonitorTransmissionsElementType monitorTransmissionsElement,
String description)
Sets the description attribute of an MonitorTransmissions element
|
static void |
setPatrolElementDescription(PatrolElementType patrolElement,
String description)
Sets the description attribute of an Patrol element
|
static void |
setPointElementDescription(AbsoluteHorizontalPositionElementType point,
String description)
Sets the description attribute of the circle
|
static void |
setPolygonElementDescription(PolygonElementType polygon,
String description)
Sets the description attribute of the polygon
|
static void |
setQualifierElementDescription(StringElementType qualifier,
String description)
Sets the description attribute of the qualifier element
|
static void |
setQualifierElementValue(StringElementType qualifier,
String value)
Sets the String value of the qualifier element
|
static void |
setRecoveryPosition(AgendaMissionElementType agendaElement,
AbsoluteHorizontalPositionElementType recoveryPosition)
Sets the recovery position element of an agenda mission
|
static void |
setRecoveryPosition(AgendaMissionElementType agendaElement,
double xPosition,
double yPosition,
int positionType,
String description)
Sets the recovery position element of an agenda mission
|
static void |
setRecoveryPositionElementDescription(AbsoluteHorizontalPositionElementType positionElement,
String description)
Sets the recovery position element description
|
static void |
setRecoveryPositionElementPosition(AbsoluteHorizontalPositionElementType positionElement,
double xPosition,
double yPosition,
int positionType)
Sets the recovery position element location values
|
static void |
setRectangleElementDescription(RectangleElementType rectangle,
String description)
Sets the description attribute of the rectangle
|
static void |
setRendezvousElementDescription(RendezvousElementType rendezvousElement,
String description)
Sets the description attribute of an Rendezvous element
|
static void |
setReportingCriteriaDescription(ReportingCriteriaElementType reportingCriteria,
String newDescription)
Sets the description attribute of the reporting criteria element
|
static void |
setReportingCriteriaPeriodicity(ReportingCriteriaElementType reportingCriteria,
double newTimeInterval)
Sets the time between periodic reports
|
static void |
setReportingCriteriaValue(ReportingCriteriaElementType reportingCriteria,
String newValue)
Sets the value attribute (when reports are required) of the reporting criteria element
|
static void |
setRepositionElementDescription(RepositionElementType repositionElement,
String description)
Sets the description attribute of a Reposition element
|
static void |
setRepositionElementRouting(RepositionElementType repositionElement,
RouteElementType routing)
Sets the description attribute of a Reposition element
|
static void |
setRouteDescription(RouteElementType route,
String newDescription)
Sets the description attribute of the dependence element
|
static void |
setRoutePointList(RouteElementType route,
int pointType,
List<double[]> points)
Sets the route element's point list
|
static void |
setRouteVerticalControl(RouteElementType route,
int verticalType,
double verticalValue1,
double verticalValue2)
Sets the route element's vertical control element
|
static void |
setSampleEnvironmentElementDescription(SampleEnvironmentElementType sampleEnvironment,
String description)
Sets the description attribute of an SampleEnvironment element
|
static void |
setSearchElementDatumType(SearchElementType searchElement,
String datumType)
Sets the datum type (point or area) of the Search element
|
static void |
setSearchElementDescription(SearchElementType searchElement,
String description)
Sets the description attribute of an Search element
|
static void |
setSearchElementRequiredPD(SearchElementType searchElement,
double pd)
Sets the datum type (point or area) of the Search element
|
static void |
setSearchElementSingleTarget(SearchElementType searchElement,
boolean single)
Sets the datum type (point or area) of the Search element
|
static void |
setVerticalBlockDescription(NumericalBlockElementType verticalBlock,
String newDescription)
Sets the minimum value of the vertical block
|
static void |
setVerticalBlockMax(NumericalBlockElementType verticalBlock,
double newValue)
Sets the maximum value of the vertical block
|
static void |
setVerticalBlockMin(NumericalBlockElementType verticalBlock,
double newValue)
Sets the minimum value of the vertical block
|
public static void setLaunchPosition(AgendaMissionElementType agendaElement, double xPosition, double yPosition, int positionType, String description)
agendaElement
- AVCL agenda mission elementxPosition
- x or latitude position of the launchyPosition
- y or longitude position of the launchpositionType
- AvclMission.XYPOSITION
or AvclMission.LATLONGPOSITION
enumeration determining whether the position is (x, y) or latitude/longitudedescription
- further information about this elementpublic static void setLaunchPosition(AgendaMissionElementType agendaElement, AbsoluteHorizontalPositionElementType newLaunchPositionElement)
agendaElement
- AVCL agenda mission elementnewLaunchPositionElement
- AVCL agenda mission launch position elementpublic static AbsoluteHorizontalPositionElementType createLaunchPositionElement(double xPosition, double yPosition, int positionType, String description)
xPosition
- x or latitude position of the launchyPosition
- y or longitude position of the launchpositionType
- AvclMission.XYPOSITION
or AvclMission.LATLONGPOSITION
enumeration determining whether the position is (x, y) or latitude/longitudedescription
- further information about this elementAbsoluteHorizontalPositionElementType
public static int getLaunchPositionElementPositionType(AbsoluteHorizontalPositionElementType positionElement)
positionElement
- of AbsoluteHorizontalPositionElementType
the position to determine (x, y), or lat/lon typepublic static double getLaunchPositionElementXPosition(AbsoluteHorizontalPositionElementType positionElement)
positionElement
- the position to determine (x, y), or lat/lon typepublic static double getLaunchPositionElementYPosition(AbsoluteHorizontalPositionElementType positionElement)
positionElement
- of AbsoluteHorizontalPositionElementType
the position to determine (x, y), or lat/lon typepublic static String getLaunchPositionElementDescription(AbsoluteHorizontalPositionElementType positionElement)
positionElement
- the position to determine (x, y), or lat/lon typepublic static void setLaunchPositionElementPosition(AbsoluteHorizontalPositionElementType positionElement, double xPosition, double yPosition, int positionType)
positionElement
- AbsoluteHorizontalPositionElementType
start position elementxPosition
- x or latitude position of the launchyPosition
- y or longitude position of the launchpositionType
- AvclMission.XYPOSITION
or AvclMission.LATLONGPOSITION
enumeration determining whether the position is (x, y) or latitude/longitudepublic static void setLaunchPositionElementDescription(AbsoluteHorizontalPositionElementType positionElement, String description)
positionElement
- AbsoluteHorizontalPositionElementType
start position elementdescription
- further information about this elementpublic static void setRecoveryPosition(AgendaMissionElementType agendaElement, double xPosition, double yPosition, int positionType, String description)
agendaElement
- AVCL agenda mission elementxPosition
- x or latitude position of the launchyPosition
- y or longitude position of the launchpositionType
- AvclMission.XYPOSITION
or AvclMission.LATLONGPOSITION
enumeration determining whether the position is (x, y) or latitude/longitudedescription
- further information about this elementpublic static void setRecoveryPosition(AgendaMissionElementType agendaElement, AbsoluteHorizontalPositionElementType recoveryPosition)
agendaElement
- AVCL agenda mission elementrecoveryPosition
- AVCL agenda mission launch position elementpublic static AbsoluteHorizontalPositionElementType createRecoveryPositionElement(double xPosition, double yPosition, int positionType, String description)
xPosition
- x or latitude position of the launchyPosition
- y or longitude position of the launchpositionType
- AvclMission.XYPOSITION
or AvclMission.LATLONGPOSITION
enumeration determining whether the position is (x, y) or latitude/longitudedescription
- further information about this elementAbsoluteHorizontalPositionElementType
public static int getRecoveryPositionElementPositionType(AbsoluteHorizontalPositionElementType positionElement)
positionElement
- AbsoluteHorizontalPositionElementType
AvclMission.XYPOSITION
or AvclMission.LATLONGPOSITION
public static double getRecoveryPositionElementXPosition(AbsoluteHorizontalPositionElementType positionElement)
positionElement
- of AbsoluteHorizontalPositionElementType
public static double getRecoveryPositionElementYPosition(AbsoluteHorizontalPositionElementType positionElement)
positionElement
- of AbsoluteHorizontalPositionElementType
public static String getRecoveryPositionElementDescription(AbsoluteHorizontalPositionElementType positionElement)
positionElement
- of AbsoluteHorizontalPositionElementType
of AbsoluteHorizontalPositionElementType
public static void setRecoveryPositionElementPosition(AbsoluteHorizontalPositionElementType positionElement, double xPosition, double yPosition, int positionType)
positionElement
- of AbsoluteHorizontalPositionElementType
recovery position elementxPosition
- x or latitude position of the launchyPosition
- y or longitude position of the launchpositionType
- AvclMission.XYPOSITION
or AvclMission.LATLONGPOSITION
enumeration determining whether the position is (x, y) or latitude/longitudepublic static void setRecoveryPositionElementDescription(AbsoluteHorizontalPositionElementType positionElement, String description)
positionElement
- of AbsoluteHorizontalPositionElementType
recovery position elementdescription
- further information about this elementpublic static AgendaGoalListType createAgendaGoalList()
AgendaGoalListType
public static AgendaGoalListType getAgendaGoalList(AgendaMissionElementType agendaElement)
agendaElement
- AgendaGoalListType
public static JAXBElement<?> getJAXBElementAgendaGoal(AgendaGoalElementType value)
value
- the AgendaGoalElementType to wrap into a JAXBElementpublic static JAXBElement<?> getJAXBElementAgendaAvoidArea(AreaElementType value)
value
- the AreaElementType to wrap into a JAXBElementpublic static JAXBElement<?> getJAXBElementAgendaLaunchPosition(AbsoluteHorizontalPositionElementType ahpet)
ahpet
- AbsoluteHorizontalPositionElementType to return wrapped as a JAXBElement<?>public static JAXBElement<?> getJAXBElementAgendaRecoveryPosition(AbsoluteHorizontalPositionElementType ahpet)
ahpet
- AbsoluteHorizontalPositionElementType to return wrapped as a JAXBElement<?>public static int getGoalListSize(AgendaGoalListType goalList)
goalList
- List
of goals of AgendaGoalElementType
AgendaGoalListType
goals in listpublic static AgendaGoalElementType getGoal(AgendaGoalListType goalList, int index)
goalList
- list of goals of AgendaGoalElementType
index
- of goal contained in elementAgendaGoalElementType
public static int getGoalIndex(AgendaGoalListType goalList, AgendaGoalElementType goalElement)
goalList
- list of goals of AgendaGoalElementType
goalElement
- of AgendaGoalElementType
public static String getGoalListDescription(AgendaGoalListType goalList)
goalList
- List
of goals of AgendaGoalElementType
public static AgendaGoalElementType createGoalElement(String goalID, int timingType, double startTime, double durationEndTime, boolean alert, String description)
goalID
- unique identifier for this particular goaltimingType
- enumeration for the type of timing used, either absolute timing AvclMission.ABSOLUTE_TIMING
or duration timing AvclMission.DURATION_TIMING
)startTime
- start time (if absolute timing is used), in secondsdurationEndTime
- ending time (if absolute timing is used) or duration of goal execution, in secondsalert
- set to true if the goal is to set an alert as opposed to actually executingdescription
- further information about this elementAgendaGoalElementType
Object containing the generated goal elementpublic static Object getSpecificGoal(AgendaGoalElementType goalElement)
goalElement
- of AgendaGoalElementType
AttackElementType
, DecontaminateElementType
, DemolishElementType
, IlluminateElementType
, JamElementType
, MarkElementType
, MonitorTransmissionsElementType
, PatrolElementType
, RendezvousElementType
, RepositionElementType
, SampleEnvironmentElementType
, SearchElementType
public static int getGoalType(AgendaGoalElementType goalElement)
goalElement
- of AgendaGoalElementType
AvclMission.ATTACK
, AvclMission.DECONTAMINATE
, AvclMission.DEMOLISH
, AvclMission.ILLUMINATE
, AvclMission.JAM
, AvclMission.MARK
, AvclMission.MONITORTRANSMISSIONS
, AvclMission.PATROL
, AvclMission.RENDEZVOUS
, AvclMission.REPOSITION
, AvclMission.SAMPLEENVIRONMENT
or AvclMission.SEARCH
public static String getGoalName(AgendaGoalElementType goalElement)
goalElement
- of AgendaGoalElementType
AvclMission.GOAL_NAMES
or else "UnknownGoalType"public static int getGoalNumActionObjects(AgendaGoalElementType goalElement)
goalElement
- of AgendaGoalElementType
with goalType AvclMission.ATTACK
, AvclMission.DECONTAMINATE
, AvclMission.DEMOLISH
, AvclMission.ILLUMINATE
, AvclMission.JAM
, AvclMission.MARK
, AvclMission.MONITORTRANSMISSIONS
, AvclMission.PATROL
, AvclMission.RENDEZVOUS
, AvclMission.REPOSITION
, AvclMission.SAMPLEENVIRONMENT
or AvclMission.SEARCH
public static String getGoalActionObject(AgendaGoalElementType goalElement, int index)
goalElement
- of AgendaGoalElementType
with goal type AvclMission.ATTACK
, AvclMission.DECONTAMINATE
, AvclMission.DEMOLISH
, AvclMission.ILLUMINATE
, AvclMission.JAM
, AvclMission.MARK
, AvclMission.MONITORTRANSMISSIONS
, AvclMission.PATROL
, AvclMission.RENDEZVOUS
, AvclMission.REPOSITION
, AvclMission.SAMPLEENVIRONMENT
or AvclMission.SEARCH
index
- of action object contained by the given goalpublic static boolean getGoalIsAlert(AgendaGoalElementType goalElement)
goalElement
- of AgendaGoalElementType
AgendaGoalElementType
element has the AgendaGoalElementType.alert
attribute set truepublic static String getGoalId(AgendaGoalElementType goalElement)
goalElement
- of AgendaGoalElementType
public static AgendaGoalElementType getGoalNextOnSucceed(AgendaGoalElementType goalElement)
goalElement
- of AgendaGoalElementType
AgendaGoalElementType
following success of this goalpublic static AgendaGoalElementType getGoalNextOnFail(AgendaGoalElementType goalElement)
goalElement
- of AgendaGoalElementType
AgendaGoalElementType
following failure of this goalpublic static AreaElementType getGoalOperatingArea(AgendaGoalElementType goalElement)
goalElement
- of AgendaGoalElementType
AreaElementType
public static double getGoalStartTime(AgendaGoalElementType goalElement)
goalElement
- of AgendaGoalElementType
public static double getGoalStopTime(AgendaGoalElementType goalElement)
goalElement
- of AgendaGoalElementType
public static double getGoalDuration(AgendaGoalElementType goalElement)
goalElement
- of AgendaGoalElementType
public static int getGoalNumReportingCriteria(AgendaGoalElementType goalElement)
goalElement
- of AgendaGoalElementType
public static ReportingCriteriaElementType getGoalReportingCriteria(AgendaGoalElementType goalElement, int index)
goalElement
- of AgendaGoalElementType
index
- of criteria object contained by the given agenda goalReportingCriteriaElementType
public static int getGoalReportingCriteriaIndex(AgendaGoalElementType goalElement, ReportingCriteriaElementType reportingCriteria)
goalElement
- of AgendaGoalElementType
reportingCriteria
- of interestpublic static String getGoalDescription(AgendaGoalElementType goalElement)
goalElement
- of AgendaGoalElementType
public static void clearGoalSpecifics(AgendaGoalElementType goalElement)
goalElement
- of AgendaGoalElementType
public static void setGoalAttack(AgendaGoalElementType goalElement, AttackElementType specificGoal)
goalElement
- of AgendaGoalElementType
specificGoal
- the Attack element containing the goal specificspublic static void setGoalDecontaminate(AgendaGoalElementType goalElement, DecontaminateElementType specificGoal)
goalElement
- of AgendaGoalElementType
specificGoal
- the Decontaminate element of DecontaminateElementType
containing the goal specificspublic static void setGoalDemolish(AgendaGoalElementType goalElement, DemolishElementType specificGoal)
goalElement
- of AgendaGoalElementType
specificGoal
- the Demolish element containing the goal specificspublic static void setGoalIlluminate(AgendaGoalElementType goalElement, IlluminateElementType specificGoal)
goalElement
- of AgendaGoalElementType
specificGoal
- the Illuminate element containing the goal specificspublic static void setGoalJam(AgendaGoalElementType goalElement, JamElementType specificGoal)
goalElement
- of AgendaGoalElementType
specificGoal
- the Jam element containing the goal specificspublic static void setGoalMark(AgendaGoalElementType goalElement, MarkElementType specificGoal)
goalElement
- of AgendaGoalElementType
specificGoal
- the Mark element containing the goal specificspublic static void setGoalMonitorTransmissions(AgendaGoalElementType goalElement, MonitorTransmissionsElementType specificGoal)
goalElement
- of AgendaGoalElementType
specificGoal
- the MonitorTransmissions element containing the goal specificspublic static void setGoalPatrol(AgendaGoalElementType goalElement, PatrolElementType specificGoal)
goalElement
- of AgendaGoalElementType
specificGoal
- the Patrol element containing the goal specificspublic static void setGoalRendezvous(AgendaGoalElementType goalElement, RendezvousElementType specificGoal)
goalElement
- of AgendaGoalElementType
specificGoal
- the Rendezvous element containing the goal specificspublic static void setGoalReposition(AgendaGoalElementType goalElement, RepositionElementType specifics)
goalElement
- of AgendaGoalElementType
specifics
- the Reposition elementpublic static void setGoalSampleEnvironment(AgendaGoalElementType goalElement, SampleEnvironmentElementType specificGoal)
goalElement
- of AgendaGoalElementType
specificGoal
- the SampleEnvironment element containing the goal specificspublic static void setGoalSearch(AgendaGoalElementType goalElement, SearchElementType specificGoal)
goalElement
- of AgendaGoalElementType
specificGoal
- the Search element containing the goal specificspublic static void setGoalID(AgendaGoalElementType goalElement, String newID)
goalElement
- of AgendaGoalElementType
newID
- public static void setGoalTiming(AgendaGoalElementType goalElement, double startTime, double durationEndTime)
goalElement
- of AgendaGoalElementType
startTime
- when to begin, in secondsdurationEndTime
- ending time, in secondspublic static void setGoalDuration(AgendaGoalElementType goalElement, double duration)
goalElement
- of AgendaGoalElementType
duration
- duration of goal execution, in secondspublic static void setGoalIsAlert(AgendaGoalElementType goalElement, boolean alert)
goalElement
- of AgendaGoalElementType
alert
- public static void setGoalNextOnSucceed(AgendaGoalElementType goalElement, AgendaGoalElementType next)
goalElement
- of AgendaGoalElementType
next
- goal element that should be attempted next if this one succeedspublic static void setGoalNextOnFail(AgendaGoalElementType goalElement, AgendaGoalElementType next)
goalElement
- of AgendaGoalElementType
next
- goal element that should be attempted next if this one failspublic static void setGoalOpArea(AgendaGoalElementType goalElement, AreaElementType area)
goalElement
- of AgendaGoalElementType
area
- AreaElementType
operating area element to be assigned to this goalpublic static void setGoalOpArea(AgendaGoalElementType goalElement, int areaType, int pointType, List<double[]> points, double areaParameter1, double areaParameter2, double areaParameter3, int verticalType, double verticalValue1, double verticalValue2, String description)
goalElement
- of AgendaGoalElementType
areaType
- enumeration for the type of area (AvclMission.POINT
, AvclMission.CIRCLE
, AvclMission.RECTANGLE
, AvclMission.POLYGON
or AvclMission.LIMITING_LINE
)pointType
- AvclMission.XYPOSITION
or AvclMission.LATLONGPOSITION
points
- List
of 2x1 double-precision arrays each holding x,y or latitude,longitude valuesareaParameter1
- the first parameter required to specify the area if required (center or width)areaParameter2
- the second parameter required to specify the area if required (height)areaParameter3
- the third parameter required to specify the area if required (rotation)verticalType
- enumeration for the type of vertical requirement (AvclMission.DEPTH
, AvclMission.ALTITUDE_ABV_BTM
, AvclMission.ALTITUDE_MSL
, AvclMission.ALTITUDE_AGL
, AvclMission.DEPTH_BLK
, AvclMission.ALTITUDE_ABV_BTM_BLK
, AvclMission.ALTITUDE_AGL_BLK
, AvclMission.ALTITUDE_MSL_BLK
, AvclMission.ALTITUDE_AGL_MSL_BLK
or AvclMission.DEPTH_ALTITUDE_ABV_BTM_BLK
)verticalValue1
- the first parameter required to specify the vertical requirement (minimum altitude or minimum depth) for this verticalTypeverticalValue2
- the second parameter required to specify the vertical requirement (maximum altitude or maximum depth) for this verticalTypedescription
- further information about this elementpublic static void setGoalOpAreaGeometry(AgendaGoalElementType goalElement, int areaType, int pointType, List<double[]> points, double areaParameter1, double areaParameter2, double areaParameter3, String description)
goalElement
- of AgendaGoalElementType
areaType
- enumeration for the type of area (AvclMission.POINT
, AvclMission.CIRCLE
, AvclMission.RECTANGLE
, AvclMission.POLYGON
or AvclMission.LIMITING_LINE
)pointType
- AvclMission.XYPOSITION
or AvclMission.LATLONGPOSITION
points
- List
of 2x1 double-precision arrays each holding x,y or latitude,longitude valuesareaParameter1
- the first parameter required to specify the area if required (center or width)areaParameter2
- the second parameter required to specify the area if required (height)areaParameter3
- the third parameter required to specify the area if required (height)description
- further information about this elementpublic static void setGoalOpAreaVertical(AgendaGoalElementType goalElement, int verticalType, double verticalValue1, double verticalValue2, String description)
goalElement
- of AgendaGoalElementType
verticalType
- enumeration for the type of vertical requirement (AvclMission.DEPTH
, AvclMission.ALTITUDE_ABV_BTM
, AvclMission.ALTITUDE_MSL
, AvclMission.ALTITUDE_AGL
, AvclMission.DEPTH_BLK
, AvclMission.ALTITUDE_ABV_BTM_BLK
, AvclMission.ALTITUDE_AGL_BLK
, AvclMission.ALTITUDE_MSL_BLK
, AvclMission.ALTITUDE_AGL_MSL_BLK
or AvclMission.DEPTH_ALTITUDE_ABV_BTM_BLK
)verticalValue1
- the first parameter required to specify the vertical requirement (minimum altitude or minimum depth) for this verticalTypeverticalValue2
- the second parameter required to specify the vertical requirement (maximum altitude or maximum depth) for this verticalTypedescription
- further information about this elementpublic static void addGoalReportingCriteria(AgendaGoalElementType goalElement, ReportingCriteriaElementType newReportingCriteria)
goalElement
- of AgendaGoalElementType
newReportingCriteria
- public static void addGoalReportingCriteria(AgendaGoalElementType goalElement, String value, double periodicity, String description)
goalElement
- of AgendaGoalElementType
value
- Value used to identify when reports are required during goal accomplishmentperiodicity
- time between reports (only used if value = "periodic")description
- further information about this elementpublic static void deleteGoalReportingCriteria(AgendaGoalElementType goalElement, int index)
goalElement
- of AgendaGoalElementType
index
- of criteria object contained by the given agenda goalpublic static void deleteGoalReportingCriteria(AgendaGoalElementType goalElement, ReportingCriteriaElementType criteria)
goalElement
- of AgendaGoalElementType
criteria
- public static void setGoalDescription(AgendaGoalElementType goalElement, String description)
goalElement
- of AgendaGoalElementType
description
- further information about this elementpublic static AgendaConstraintListType getAgendaConstraintList(AgendaMissionElementType agendaElement)
agendaElement
- AgendaConstraintListType
public static AttackElementType generateAttackElement(String weaponStatus, boolean singleTarget, boolean disableOnly, String description)
weaponStatus
- "safe", "tight", or "free"singleTarget
- true if only one targetdisableOnly
- set to true if attack is to disable, not kill, targetsdescription
- further information about this elementAttackElementType
public static String getAttackElementWeaponStatus(AttackElementType attackElement)
attackElement
- of AttackElementType
public static boolean getAttackElementDisableOnly(AttackElementType attackElement)
attackElement
- of AttackElementType
AttackElementType
attack is intended to only disable
the targetpublic static boolean getAttackElementSingleTarget(AttackElementType attackElement)
attackElement
- of AttackElementType
AttackElementType
target is a single target
public static String getAttackElementDescription(AttackElementType attackElement)
attackElement
- of AttackElementType
public static int getAttackElementNumTargets(AttackElementType attackElement)
attackElement
- of AttackElementType
public static String getAttackElementTarget(AttackElementType attackElement, int index)
attackElement
- of AttackElementType
index
- of target object contained by the given agenda goalpublic static void setAttackElementWeaponStatus(AttackElementType attackElement, String status)
attackElement
- of AttackElementType
status
- "HOLD" = "SAFE" (@link WeaponStatusType#SAFE}, "FREE" WeaponStatusType.FREE
or (default) "TIGHT" WeaponStatusType.TIGHT
public static void setAttackElementSingleTarget(AttackElementType attackElement, boolean value)
attackElement
- of AttackElementType
value
- true means the attack is to disable, not kill, the targetspublic static void setAttackElementDisableOnly(AttackElementType attackElement, boolean value)
attackElement
- of AttackElementType
value
- true means the attack is to disable, not kill, the targetspublic static void setAttackElementDescription(AttackElementType attackElement, String description)
attackElement
- of AttackElementType
description
- further information about this elementpublic static void addAttackElementTarget(AttackElementType attackElement, String target, String description)
attackElement
- of AttackElementType
target
- type of target to be addeddescription
- further information about this elementpublic static void clearAttackElementTargets(AttackElementType attackElement)
attackElement
- of AttackElementType
public static void deleteAttackElementTarget(AttackElementType attackElement, int index)
attackElement
- of AttackElementType
index
- of target object contained by the given AttackElementType
elementpublic static void deleteAttackElementTarget(AttackElementType attackElement, ActionObjectElementType target)
attackElement
- of AttackElementType
target
- target element that is to be removed from the target listpublic static DecontaminateElementType generateDecontaminateElement(String description)
description
- further information about this elementDecontaminateElementType
affecting ContaminantType
public static int getDecontaminateElementNumContaminants(DecontaminateElementType contaminantElement)
contaminantElement
- containing decontaminate DecontaminateElementType
affecting ContaminantType
public static String getDecontaminateElementContaminant(DecontaminateElementType contaminantElement, int index)
contaminantElement
- containing decontaminate DecontaminateElementType
affecting ContaminantType
index
- of contaminant contained in elementContaminantType.NUCLEAR
, ContaminantType.BIOLOGICAL
, ContaminantType.CHEMICAL
, ContaminantType.EXPLOSIVE
of (default) ContaminantType.TOXIN
public static String getDecontaminateElementDescription(DecontaminateElementType contaminantElement)
contaminantElement
- containing decontaminate DecontaminateElementType
affecting ContaminantType
public static void setDecontaminateElementDescription(DecontaminateElementType contaminantElement, String description)
contaminantElement
- containing decontaminate DecontaminateElementType
affecting ContaminantType
description
- further information about this elementpublic static void addDecontaminateElementContaminate(DecontaminateElementType contaminantElement, String contaminantName, String description)
contaminantElement
- containing decontaminate DecontaminateElementType
affecting ContaminantType
contaminantName
- type of contaminant to be added: ContaminantType.NUCLEAR
, ContaminantType.BIOLOGICAL
, ContaminantType.CHEMICAL
, ContaminantType.EXPLOSIVE
of (default) ContaminantType.TOXIN
description
- public static void clearDecontaminateElementContaminants(DecontaminateElementType contaminantElement)
contaminantElement
- containing decontaminate DecontaminateElementType
affecting ContaminantType
public static void deleteDecontaminateElementContaminant(DecontaminateElementType contaminantElement, int index)
contaminantElement
- containing decontaminate DecontaminateElementType
affecting ContaminantType
index
- of contaminant contained in elementpublic static void deleteDecontaminateElementContaminant(DecontaminateElementType contaminantElement, ContaminantElementType contaminantToRemove)
contaminantElement
- containing decontaminate DecontaminateElementType
affecting ContaminantType
contaminantToRemove
- contaminate element that is to be removed from the target listpublic static DemolishElementType generateDemolishElement(boolean permanentDisable, boolean singleTarget, String description)
permanentDisable
- permanentDisable
set to true if targets are to be permanently disabledsingleTarget
- true if only one targetdescription
- further information about this elementDemolishElementType
public static boolean getDemolishElementPermanentDisable(DemolishElementType demolishElement)
permanentDisable
attribute valuedemolishElement
- of DemolishElementType
DemolishElementType
demolish element has permanentDisable
is set truepublic static boolean getDemolishElementSingleTarget(DemolishElementType demolishElement)
demolishElement
- of DemolishElementType
DemolishElementType
demolish element has DemolishElementType.singleTarget
is set truepublic static String getDemolishElementDescription(DemolishElementType demolishElement)
demolishElement
- of DemolishElementType
public static int getDemolishElementNumTargets(DemolishElementType demolishElement)
demolishElement
- of DemolishElementType
public static String getDemolishElementTarget(DemolishElementType demolishElement, int index)
demolishElement
- of DemolishElementType
index
- of target contained in elementActionObjectElementType
target namepublic static void setDemolishElementPermanentDisable(DemolishElementType demolishElement, boolean value)
demolishElement
- of DemolishElementType
value
- true means the targets are to be permanently disabledpublic static void setDemolishElementSingleTarget(DemolishElementType demolishElement, boolean value)
demolishElement
- of DemolishElementType
value
- true means the targets are to be permanently disabledpublic static void setDemolishElementDescription(DemolishElementType demolishElement, String description)
demolishElement
- of DemolishElementType
description
- further information about this elementpublic static void addDemolishElementTarget(DemolishElementType demolishElement, String target, String description)
demolishElement
- of DemolishElementType
target
- type of target to be addeddescription
- public static void clearDemolishElementTargets(DemolishElementType demolishElement)
demolishElement
- of DemolishElementType
public static void deleteDemolishElementTarget(DemolishElementType demolishElement, int index)
demolishElement
- of DemolishElementType
index
- of target
contained in elementpublic static void deleteDemolishElementTarget(DemolishElementType demolishElement, ActionObjectElementType target)
demolishElement
- of DemolishElementType
target
- target element that is to be removed from the target listpublic static IlluminateElementType generateIlluminateElement(String illumType, String description)
illumType
- String name of the type of illuminator called fordescription
- further information about this elementIlluminateElementType
public static String getIlluminateElementIlluminatorType(IlluminateElementType illuminateElement)
illuminateElement
- of IlluminatorElementType
IlluminatorType.PYROTECHNICS
, IlluminatorType.FLOODLIGHT
or IlluminatorType.SPOTLIGHT
public static int getIlluminateElementNumIlluminatorCharacteristics(IlluminateElementType illuminateElement)
illuminateElement
- of IlluminatorElementType
public static String getIlluminateElementIlluminatorCharacteristic(IlluminateElementType illuminateElement, int index)
illuminateElement
- of IlluminatorElementType
index
- of IlluminatorElementType
characteristic contained in elementpublic static String getIlluminateElementIlluminatorDescription(IlluminateElementType illuminateElement)
illuminateElement
- of IlluminatorElementType
public static String getIlluminateElementDescription(IlluminateElementType illuminateElement)
illuminateElement
- of IlluminatorElementType
public static void setIlluminateElementIlluminator(IlluminateElementType illuminateElement, String illuminatorType, String description)
illuminateElement
- of IlluminatorElementType
illuminatorType
- description
- further information about this elementpublic static void setIlluminateElementDescription(IlluminateElementType illuminateElement, String description)
illuminateElement
- of IlluminatorElementType
description
- further information about this elementpublic static void addIlluminateElementIlluminatorCharacteristic(IlluminateElementType illuminateElement, String newChar, String description)
illuminateElement
- of IlluminatorElementType
newChar
- String name of the characteristic to be addeddescription
- further information about this elementpublic static void clearIlluminateElementIlluminatorCharacteristics(IlluminateElementType illuminateElement)
illuminateElement
- of IlluminatorElementType
public static void deleteIlluminateElementIlluminatorCharacteristic(IlluminateElementType illuminateElement, int index)
illuminateElement
- of IlluminatorElementType
index
- of IlluminateElementType
characteristic contained in elementpublic static void deleteIlluminateElementIlluminatorCharacteristic(IlluminateElementType illuminateElement, StringElementType characteristic)
illuminateElement
- of IlluminatorElementType
characteristic
- illuminator characteristic object to be deletedpublic static JamElementType generateJamElement(String description)
description
- further information about this elementJamElementType
public static int getJamElementNumberOfFrequencyRanges(JamElementType jamElement)
jamElement
- of JamElementType
FrequencyRangeElementType
frequency rangespublic static FrequencyRangeElementType getJamElementFrequencyRange(JamElementType jamElement, int index)
jamElement
- of JamElementType
index
- of FrequencyRangeElementType
contained in elementFrequencyRangeElementType
public static String getJamElementDescription(JamElementType jamElement)
jamElement
- of JamElementType
public static void setJamElementDescription(JamElementType jamElement, String description)
jamElement
- of JamElementType
description
- further information about this elementpublic static void addJamElementFrequencyRange(JamElementType jamElement, double freq1, double freq2, String description)
jamElement
- of JamElementType
freq1
- first frequency defining the frequency rangefreq2
- second frequency defining the frequency rangedescription
- public static void clearJamElementFrequencyRanges(JamElementType jamElement)
jamElement
- of JamElementType
public static void deleteJamElementFrequencyRange(JamElementType jamElement, int index)
jamElement
- of JamElementType
index
- of JamElementType
contained in elementpublic static void deleteJamElementFrequencyRange(JamElementType jamElement, FrequencyRangeElementType range)
jamElement
- of JamElementType
range
- frequency range element that is to be removed from the frequencyRange listpublic static MarkElementType generateMarkElement(String markerType, String description)
markerType
- description
- further information about this elementMarkElementType
public static String getMarkElementMarkerType(MarkElementType markElement)
markElement
- of MarkElementType
public static int getMarkElementNumTargets(MarkElementType markElement)
markElement
- of MarkElementType
public static String getMarkElementTarget(MarkElementType markElement, int index)
markElement
- of MarkElementType
index
- of MarkElementType
contained in elementActionObjectElementType
target namepublic static int getMarkElementNumMarkerCharacteristics(MarkElementType markElement)
markElement
- of MarkElementType
public static String getMarkElementMarkerCharacteristic(MarkElementType markElement, int index)
markElement
- of MarkElementType
index
- of MarkElementType
characteristic contained in elementpublic static String getMarkElementMarkerDescription(MarkElementType markElement)
markElement
- of MarkElementType
public static String getMarkElementDescription(MarkElementType markElement)
markElement
- of MarkElementType
public static void setMarkElementMarkerType(MarkElementType markElement, String markerType, String description)
markElement
- of MarkElementType
markerType
- description
- further information about this elementpublic static void setMarkElementDescription(MarkElementType markElement, String description)
markElement
- of MarkElementType
description
- further information about this elementpublic static void addMarkElementTarget(MarkElementType markElement, String target, String description)
markElement
- of MarkElementType
target
- String name of the target to be addeddescription
- further information about this elementpublic static void clearMarkElementTargets(MarkElementType markElement)
markElement
- of MarkElementType
public static void deleteMarkElementTarget(MarkElementType markElement, int index)
markElement
- of MarkElementType
index
- of MarkElementType
contained in elementpublic static void deleteMarkElementTarget(MarkElementType markElement, ActionObjectElementType target)
markElement
- of MarkElementType
target
- public static void addMarkElementMarkerCharacteristic(MarkElementType markElement, String newChar, String description)
markElement
- of MarkElementType
newChar
- String name of the characteristic to be addeddescription
- further information about this elementpublic static void clearMarkElementMarkerCharacteristics(MarkElementType markElement)
markElement
- of MarkElementType
public static void deleteMarkElementMarkerCharacteristic(MarkElementType markElement, int index)
markElement
- of MarkElementType
index
- of MarkElementType
characteristic contained in elementpublic static void deleteMarkElementMarkerCharacteristic(MarkElementType markElement, Object characteristic)
markElement
- of MarkElementType
characteristic
- marker characteristic object to be deletedpublic static MonitorTransmissionsElementType generateMonitorTransmissionsElement(String description)
description
- further information about this elementMonitorTransmissionsElementType
public static int getMonitorTransmissionsElementNumFrequencyRanges(MonitorTransmissionsElementType monitorTransmissionsElement)
monitorTransmissionsElement
- of MonitorTransmissionsElementType
FrequencyRangeElementType
frequency rangespublic static FrequencyRangeElementType getMonitorTransmissionsElementFrequencyRange(MonitorTransmissionsElementType monitorTransmissionsElement, int index)
monitorTransmissionsElement
- of MonitorTransmissionsElementType
index
- of FrequencyRangeElementType
contained in elementFrequencyRangeElementType
public static String getMonitorTransmissionsElementDescription(MonitorTransmissionsElementType monitorTransmissionsElement)
monitorTransmissionsElement
- of MonitorTransmissionsElementType
public static void setMonitorTransmissionsElementDescription(MonitorTransmissionsElementType monitorTransmissionsElement, String description)
monitorTransmissionsElement
- of MonitorTransmissionsElementType
description
- further information about this elementpublic static void addMonitorTransmissionsElementFrequencyRange(MonitorTransmissionsElementType monitorTransmissionsElement, double freq1, double freq2, String description)
monitorTransmissionsElement
- of MonitorTransmissionsElementType
freq1
- first frequency defining the frequency rangefreq2
- second frequency defining the frequency rangedescription
- further information about this elementpublic static void clearMonitorTransmissionsElementFrequencyRanges(MonitorTransmissionsElementType monitorTransmissionsElement)
monitorTransmissionsElement
- of MonitorTransmissionsElementType
public static void deleteMonitorTransmissionsElementFrequencyRange(MonitorTransmissionsElementType monitorTransmissionsElement, int index)
monitorTransmissionsElement
- of MonitorTransmissionsElementType
index
- of MonitorTransmissionsElementType
contained in elementpublic static void deleteMonitorTransmissionsElementFrequencyRange(MonitorTransmissionsElementType monitorTransmissionsElement, FrequencyRangeElementType range)
monitorTransmissionsElement
- of MonitorTransmissionsElementType
range
- frequency range element that is to be removed from the frequencyRange listpublic static PatrolElementType generatePatrolElement(String description)
description
- further information about this elementPatrolElementType
public static int getPatrolElementNumberOfQualifiers(PatrolElementType patrolElement)
patrolElement
- of PatrolElementType
of PatrolElementType
public static StringElementType getPatrolElementQualifier(PatrolElementType patrolElement, int index)
patrolElement
- of PatrolElementType
index
- of PatrolElementType
contained in elementPatrolElementType
public static String getPatrolElementQualifierValue(PatrolElementType patrolElement, int index)
patrolElement
- of PatrolElementType
index
- of PatrolElementType
contained in elementPatrolElementType
valuepublic static String getPatrolElementQualifierDescription(PatrolElementType patrolElement, int index)
patrolElement
- of PatrolElementType
index
- of PatrolElementType
contained in elementpublic static String getPatrolElementDescription(PatrolElementType patrolElement)
patrolElement
- of PatrolElementType
public static void setPatrolElementDescription(PatrolElementType patrolElement, String description)
patrolElement
- of PatrolElementType
description
- further information about this elementpublic static void addPatrolElementQualifier(PatrolElementType patrolElement, String qualValue, String description)
patrolElement
- of PatrolElementType
qualValue
- String value of the qualifier to be addeddescription
- further information about this elementpublic static void clearPatrolElementQualifiers(PatrolElementType patrolElement)
patrolElement
- of PatrolElementType
public static void deletePatrolElementQualifier(PatrolElementType patrolElement, int index)
patrolElement
- of PatrolElementType
index
- of PatrolElementType
contained in elementpublic static void deletePatrolElementQualifier(PatrolElementType patrolElement, StringElementType qualifier)
patrolElement
- of PatrolElementType
qualifier
- object that is to be removed from the List
of qualifierspublic static RendezvousElementType generateRendezvousElement(int target, String description)
target
- Unique ID of the vehicle to be rendezvoused withdescription
- further information about this elementRendezvousElementType
public static int getRendezvousElementNumberOfTargetVehicles(RendezvousElementType rendezvousElement)
rendezvousElement
- of RendezvousElementType
public static int getRendezvousElementTargetVehicleID(RendezvousElementType rendezvousElement, int index)
rendezvousElement
- of RendezvousElementType
index
- of RendezvousElementType.targetVehicleID
contained in elementRendezvousElementType.targetVehicleID
valuepublic static int getRendezvousElementNumberOfQualifiers(RendezvousElementType rendezvousElement)
rendezvousElement
- of RendezvousElementType
public static StringElementType getRendezvousElementQualifier(RendezvousElementType rendezvousElement, int index)
rendezvousElement
- of RendezvousElementType
index
- of qualifier contained in RendezvousElementType
elementRendezvousElementType
Qualifierpublic static String getRendezvousElementQualifierValue(RendezvousElementType rendezvousElement, int index)
rendezvousElement
- of RendezvousElementType
index
- of RendezvousElementType.qualifier
contained in elementRendezvousElementType.qualifier
valuepublic static String getRendezvousElementQualifierDescription(RendezvousElementType rendezvousElement, int index)
rendezvousElement
- of RendezvousElementType
index
- of RendezvousElementType.qualifier
contained in elementRendezvousElementType.qualifier
descriptionpublic static String getRendezvousElementDescription(RendezvousElementType rendezvousElement)
rendezvousElement
- of RendezvousElementType
RendezvousElementType
descriptionpublic static void addRendezvousElementTargetVehicleID(RendezvousElementType rendezvousElement, int target)
rendezvousElement
- of RendezvousElementType
target
- public static void setRendezvousElementDescription(RendezvousElementType rendezvousElement, String description)
rendezvousElement
- of RendezvousElementType
description
- further information about this elementpublic static void addRendezvousElementQualifier(RendezvousElementType rendezvousElement, String qualValue, String description)
rendezvousElement
- of RendezvousElementType
qualValue
- String value of the qualifier to be addeddescription
- further information about this elementpublic static void clearRendezvousElementQualifiers(RendezvousElementType rendezvousElement)
rendezvousElement
- of RendezvousElementType
public static void deleteRendezvousElementQualifier(RendezvousElementType rendezvousElement, int index)
rendezvousElement
- of RendezvousElementType
index
- of RendezvousElementType.qualifier
contained in elementpublic static void deleteRendezvousElementQualifier(RendezvousElementType rendezvousElement, StringElementType qualifier)
rendezvousElement
- of RendezvousElementType
qualifier
- object that is to be removed from the List
of qualifierspublic static RepositionElementType generateRepositionElement(String description)
description
- further information about this elementRepositionElementType
public static RouteElementType getRepositionElementRouting(RepositionElementType repositionElement)
repositionElement
- of RepositionElementType
RouteElementType
public static String getRepositionElementDescription(RepositionElementType repositionElement)
repositionElement
- of RepositionElementType
public static void setRepositionElementRouting(RepositionElementType repositionElement, RouteElementType routing)
repositionElement
- of RepositionElementType
routing
- of RouteElementType
public static void clearRepositionElementRouting(RepositionElementType repositionElement)
repositionElement
- of RepositionElementType
public static void setRepositionElementDescription(RepositionElementType repositionElement, String description)
repositionElement
- of RepositionElementType
description
- further information about this elementpublic static SampleEnvironmentElementType generateSampleEnvironmentElement(String description)
description
- further information about this elementSampleEnvironmentElementType
public static int getSampleEnvironmentElementNumberOfContaminants(SampleEnvironmentElementType sampleEnvironment)
sampleEnvironment
- of SampleEnvironmentElementType
ContaminantElementType
contaminantspublic static String getSampleEnvironmentElementContaminant(SampleEnvironmentElementType sampleEnvironment, int index)
sampleEnvironment
- of SampleEnvironmentElementType
of ContaminantElementType
containing contaminantindex
- of SampleEnvironmentElementType.contaminant
contained in elementContaminantType.NUCLEAR
, ContaminantType.BIOLOGICAL
, ContaminantType.CHEMICAL
, ContaminantType.EXPLOSIVE
of (default) ContaminantType.TOXIN
public static String getSampleEnvironmentElementDescription(SampleEnvironmentElementType sampleEnvironment)
sampleEnvironment
- of SampleEnvironmentElementType
public static void setSampleEnvironmentElementDescription(SampleEnvironmentElementType sampleEnvironment, String description)
sampleEnvironment
- of SampleEnvironmentElementType
description
- further information about this elementpublic static void addSampleEnvironmentElementContaminate(SampleEnvironmentElementType sampleEnvironment, String contaminant, String description)
sampleEnvironment
- of SampleEnvironmentElementType
of ContaminantElementType
containing contaminantcontaminant
- type of contaminant to be added ContaminantType.NUCLEAR
, ContaminantType.BIOLOGICAL
, ContaminantType.CHEMICAL
, ContaminantType.EXPLOSIVE
of (default) ContaminantType.TOXIN
description
- further information about this elementpublic static void clearSampleEnvironmentElementContaminants(SampleEnvironmentElementType sampleEnvironment)
sampleEnvironment
- of SampleEnvironmentElementType
public static void deleteSampleEnvironmentElementContaminant(SampleEnvironmentElementType sampleEnvironment, int index)
sampleEnvironment
- of SampleEnvironmentElementType
index
- of SampleEnvironmentElementType.contaminant
contained in elementpublic static void deleteSampleEnvironmentElementContaminant(SampleEnvironmentElementType sampleEnvironment, ContaminantElementType contaminant)
sampleEnvironment
- of SampleEnvironmentElementType
contaminant
- contaminate element that is to be removed from the target listpublic static SearchElementType generateSearchElement(DatumTypeType datumType, double pd, boolean singleTarget, String description)
datumType
- DatumTypeType.POINT
or DatumTypeType.AREA
pd
- required probability of detection (Pd)singleTarget
- true if only searching for one target (search goal fails if not found), false if searching for multiple targets (search goal succeeds upon search completion)description
- further information about this elementSearchElementType
public static String getSearchElementDatumType(SearchElementType searchElement)
searchElement
- of SearchElementType
DatumTypeType.POINT
or DatumTypeType.AREA
public static double getSearchElementRequiredPD(SearchElementType searchElement)
searchElement
- of SearchElementType
public static boolean getSearchElementSingleTarget(SearchElementType searchElement)
searchElement
- of SearchElementType
SearchElementType
element has SearchElementType.singleTarget
set truepublic static int getSearchElementNumberOfTargets(SearchElementType searchElement)
searchElement
- of SearchElementType
ActionObjectElementType
targetspublic static String getSearchElementTarget(SearchElementType searchElement, int index)
searchElement
- of SearchElementType
index
- of ActionObjectElementType
contained in SearchElementType.singleTarget
elementActionObjectElementType
namepublic static String getSearchElementDescription(SearchElementType searchElement)
searchElement
- of SearchElementType
public static void setSearchElementDatumType(SearchElementType searchElement, String datumType)
searchElement
- of SearchElementType
datumType
- DatumTypeType.POINT
or DatumTypeType.AREA
public static void setSearchElementRequiredPD(SearchElementType searchElement, double pd)
searchElement
- of SearchElementType
pd
- public static void setSearchElementSingleTarget(SearchElementType searchElement, boolean single)
searchElement
- of SearchElementType
single
- set to true if the search is complete upon finding a single
instance of a search target, false otherwisepublic static void addSearchElementTarget(SearchElementType searchElement, Object target)
searchElement
- of SearchElementType
target
- public static void addSearchElementTarget(SearchElementType searchElement, String target, String description)
searchElement
- of SearchElementType
target
- type of object to search fordescription
- further information about this elementpublic static void deleteSearchElementTarget(SearchElementType searchElement, int index)
searchElement
- of SearchElementType
index
- of target contained in SearchElementType
elementpublic static void deleteSearchElementTarget(SearchElementType searchElement, ActionObjectElementType target)
searchElement
- of SearchElementType
target
- public static void setSearchElementDescription(SearchElementType searchElement, String description)
searchElement
- of SearchElementType
description
- further information about this elementpublic static AgendaConstraintListType createAgendaConstraintList()
AgendaConstraintListType
public static List<AreaElementType> getConstraintAvoidAreas(AgendaConstraintListType constraintList)
constraintList
- List
of AgendaConstraintListType
constraints List
of AreaElementType
constraintsList
of AreaElementType
objectspublic static int getConstraintNumberOfAvoidAreas(AgendaConstraintListType constraintList)
constraintList
- List
of AgendaConstraintListType
constraints List
of AreaElementType
constraintspublic static AreaElementType getConstraintAvoidArea(AgendaConstraintListType constraintList, int index)
constraintList
- List
of AgendaConstraintListType
constraintsindex
- of AgendaConstraintListType.avoidArea
contained in constraintsAreaElementType
public static int getConstraintAvoidAreaIndex(AgendaConstraintListType constraintList, AreaElementType avoidArea)
constraintList
- List
of AgendaConstraintListType
constraintsavoidArea
- public static void setConstraintRouting(AgendaConstraintListType constraintList, int ingressEgress, int pointType, List<double[]> points, int verticalType, double verticalValue1, double verticalValue2, String description)
constraintList
- of AgendaConstraintListType
ingressEgress
- enumeration for whether the route is for ingress or egresspointType
- AvclMission.XYPOSITION
or AvclMission.LATLONGPOSITION
points
- List
of 2x1 double-precision arrays each holding x,y or latitude,longitude valuesverticalType
- enumeration for the type of vertical requirement (dAvclMission.DEPTH
, AvclMission.ALTITUDE_ABV_BTM
, AvclMission.ALTITUDE_MSL
, AvclMission.ALTITUDE_AGL
, AvclMission.DEPTH_BLK
, AvclMission.ALTITUDE_ABV_BTM_BLK
, AvclMission.ALTITUDE_AGL_BLK
, AvclMission.ALTITUDE_MSL_BLK
, AvclMission.ALTITUDE_AGL_MSL_BLK
or AvclMission.DEPTH_ALTITUDE_ABV_BTM_BLK
)verticalValue1
- the first parameter required to specify the vertical requirement (minimum altitude or minimum depth) for this verticalTypeverticalValue2
- the second parameter required to specify the vertical requirement (maximum altitude or maximum depth) for this verticalTypedescription
- further information about this elementpublic static void setConstraintRoutingGeography(AgendaConstraintListType constraintList, int ingressEgress, int pointType, List<double[]> points, String description)
constraintList
- of AgendaConstraintListType
ingressEgress
- enumeration for whether the route is for ingress or egresspointType
- AvclMission.XYPOSITION
or AvclMission.LATLONGPOSITION
points
- List
of 2x1 double-precision arrays each holding x,y or latitude,longitude valuesdescription
- further information about this elementpublic static void setConstraintRoutingVertical(AgendaConstraintListType constraintList, int ingressEgress, int verticalType, double verticalValue1, double verticalValue2, String description)
constraintList
- of AgendaConstraintListType
ingressEgress
- enumeration for whether the route is for ingress or egressverticalType
- enumeration for the type of vertical requirement (AvclMission.DEPTH
, AvclMission.ALTITUDE_ABV_BTM
, AvclMission.ALTITUDE_MSL
, AvclMission.ALTITUDE_AGL
, AvclMission.DEPTH_BLK
, AvclMission.ALTITUDE_ABV_BTM_BLK
, AvclMission.ALTITUDE_AGL_BLK
, AvclMission.ALTITUDE_MSL_BLK
, AvclMission.ALTITUDE_AGL_MSL_BLK
or AvclMission.DEPTH_ALTITUDE_ABV_BTM_BLK
)verticalValue1
- the first parameter required to specify the vertical requirement (minimum altitude or minimum depth) for this verticalTypeverticalValue2
- the second parameter required to specify the vertical requirement (maximum altitude or maximum depth) for this verticalTypedescription
- further information about this elementpublic static void addConstraintAvoidArea(AgendaConstraintListType constraintList, int areaType, int pointType, List<double[]> points, double areaParameter1, double areaParameter2, double areaParameter3, int verticalType, double verticalValue1, double verticalValue2, String description)
constraintList
- List
of AgendaConstraintListType
constraintsareaType
- enumeration for the type of area (AvclMission.POINT
, AvclMission.CIRCLE
, AvclMission.RECTANGLE
, AvclMission.POLYGON
or AvclMission.LIMITING_LINE
)pointType
- AvclMission.XYPOSITION
or AvclMission.LATLONGPOSITION
points
- List
of 2x1 double-precision arrays each holding x,y or latitude,longitude valuesareaParameter1
- the first parameter required to specify the area if required (center or width)areaParameter2
- the second parameter required to specify the area if required (height)areaParameter3
- the third parameter required to specify the area if required (rotation)verticalType
- enumeration for the type of vertical requirement (AvclMission.DEPTH
, AvclMission.ALTITUDE_ABV_BTM
, AvclMission.ALTITUDE_MSL
, AvclMission.ALTITUDE_AGL
, AvclMission.DEPTH_BLK
, AvclMission.ALTITUDE_ABV_BTM_BLK
, AvclMission.ALTITUDE_AGL_BLK
, AvclMission.ALTITUDE_MSL_BLK
, AvclMission.ALTITUDE_AGL_MSL_BLK
or AvclMission.DEPTH_ALTITUDE_ABV_BTM_BLK
)verticalValue1
- the first parameter required to specify the vertical requirement (minimum altitude or minimum depth) for this verticalTypeverticalValue2
- the second parameter required to specify the vertical requirement (maximum altitude or maximum depth) for this verticalTypedescription
- further information about this elementpublic static void addConstraintAvoidArea(AgendaConstraintListType constraintList, AreaElementType avoidArea)
constraintList
- List
of AgendaConstraintListType
constraintsavoidArea
- public static void deleteConstraintAvoidArea(AgendaConstraintListType constraintList, int index)
constraintList
- List
of AgendaConstraintListType
constraints List
of AreaElementType
constraintsindex
- of AgendaConstraintListType
avoidance area contained in elementpublic static void deleteConstraintAvoidArea(AgendaConstraintListType constraintList, AreaElementType avoidArea)
constraintList
- List
of AgendaConstraintListType
constraints List
of AreaElementType
constraintsavoidArea
- public static Object createAvoidAreaElement()
public static AreaElementType createAreaElement(int areaType, int pointType, List<double[]> points, double areaParameter1, double areaParameter2, double areaParameter3, int verticalType, double verticalValue1, double verticalValue2, String description)
areaType
- enumeration for the type of area (AvclMission.POINT
, AvclMission.CIRCLE
, AvclMission.RECTANGLE
, AvclMission.POLYGON
or AvclMission.LIMITING_LINE
)pointType
- AvclMission.XYPOSITION
or AvclMission.LATLONGPOSITION
points
- List
of 2x1 double-precision arrays each holding x,y or latitude,longitude valuesareaParameter1
- the first parameter required to specify the area if required (center or width)areaParameter2
- the second parameter required to specify the area if required (height)areaParameter3
- the third parameter required to specify the area if required (height)verticalType
- enumeration for the type of vertical requirement (AvclMission.DEPTH
, AvclMission.ALTITUDE_ABV_BTM
, AvclMission.ALTITUDE_MSL
, AvclMission.ALTITUDE_AGL
, AvclMission.DEPTH_BLK
, AvclMission.ALTITUDE_ABV_BTM_BLK
, AvclMission.ALTITUDE_AGL_BLK
, AvclMission.ALTITUDE_MSL_BLK
, AvclMission.ALTITUDE_AGL_MSL_BLK
or AvclMission.DEPTH_ALTITUDE_ABV_BTM_BLK
)verticalValue1
- the first parameter required to specify the vertical requirement (minimum altitude or minimum depth) for this verticalTypeverticalValue2
- the second parameter required to specify the vertical requirement (maximum altitude or maximum depth) for this verticalTypedescription
- further information about this elementAreaElementType
public static int getAreaGeometryType(AreaElementType area)
area
- AreaElementType
AvclMission.POINT
, AvclMission.CIRCLE
, AvclMission.RECTANGLE
, AvclMission.POLYGON
or AvclMission.LIMITING_LINE
public static Object getAreaGeometry(AreaElementType area)
area
- AreaElementType
AbsoluteHorizontalPositionElementType
, CircleElementType
, RectangleElementType
, PolygonElementType
or LimitingLineElementType
public static int getAreaVerticalType(AreaElementType area)
area
- AreaElementType
AvclMission.DEPTH
, AvclMission.ALTITUDE_ABV_BTM
, AvclMission.ALTITUDE_MSL
, AvclMission.ALTITUDE_AGL
,
AvclMission.DEPTH_BLK
, AvclMission.ALTITUDE_ABV_BTM_BLK
, AvclMission.ALTITUDE_AGL_BLK
, AvclMission.ALTITUDE_MSL_BLK
,
AvclMission.ALTITUDE_AGL_MSL_BLK
or AvclMission.DEPTH_ALTITUDE_ABV_BTM_BLK
public static double getAreaVerticalMin(AreaElementType area)
area
- AreaElementType
public static double getAreaVerticalMax(AreaElementType area)
area
- AreaElementType
public static String getAreaDescription(AreaElementType area)
area
- AreaElementType
public static void setAreaGeometry(AreaElementType area, Object geometry)
area
- AreaElementType
geometry
- object AbsoluteHorizontalPositionElementType
, CircleElementType
, RectangleElementType
, PolygonElementType
or LimitingLineElementType
public static void setAreaVerticalControl(AreaElementType area, int controlType, double verticalValue1, double verticalValue2)
area
- AreaElementType
controlType
- AvclMission.DEPTH
, AvclMission.ALTITUDE_ABV_BTM
, AvclMission.ALTITUDE_MSL
, AvclMission.ALTITUDE_AGL
, AvclMission.DEPTH_BLK
, AvclMission.ALTITUDE_ABV_BTM_BLK
, AvclMission.ALTITUDE_AGL_BLK
, AvclMission.ALTITUDE_MSL_BLK
, AvclMission.ALTITUDE_AGL_MSL_BLK
or AvclMission.DEPTH_ALTITUDE_ABV_BTM_BLK
verticalValue2
- the second parameter required to specify the vertical requirement (maximum altitude or maximum depth) for this verticalTypeverticalValue1
- the first parameter required to specify the vertical requirement (minimum altitude or minimum depth) for this verticalTypepublic static void setAreaDescription(AreaElementType area, String newDescription)
area
- AreaElementType
newDescription
- public static String getIlluminatorElementType(IlluminatorElementType illuminatorElement)
illuminatorElement
- of IlluminatorElementType
public static int getIlluminatorElementNumberOfCharacteristics(IlluminatorElementType illuminatorElement)
illuminatorElement
- of IlluminatorElementType
containing characteristic valuespublic static StringElementType getIlluminatorElementCharacteristic(IlluminatorElementType illuminatorElement, int index)
illuminatorElement
- of IlluminatorElementType
containing characteristic valuesindex
- of IlluminatorElementType
with characteristic values that is contained in elementIlluminatorElementType
characteristicpublic static String getIlluminatorElementDescription(IlluminatorElementType illuminatorElement)
illuminatorElement
- of IlluminatorElementType
public static void setIlluminatorElementType(IlluminatorElementType illuminatorElement, String type)
illuminatorElement
- of IlluminatorElementType
type
- kind of illuminator (IlluminatorType.PYROTECHNICS
, IlluminatorType.SPOTLIGHT
or IlluminatorType.FLOODLIGHT
)public static void setIlluminatorElementDescription(IlluminatorElementType illuminatorElement, String description)
illuminatorElement
- of IlluminatorElementType
description
- further information about this elementpublic static void addIlluminatorElementCharacteristic(IlluminatorElementType illuminatorElement, String newCharacteristic, String description)
illuminatorElement
- of IlluminatorElementType
newCharacteristic
- String value of the characteristic to be addeddescription
- further information about this elementpublic static void clearIlluminatorElementCharacteristics(IlluminatorElementType illuminatorElement)
illuminatorElement
- of IlluminatorElementType
public static void deleteIlluminatorElementCharacteristic(IlluminatorElementType illuminatorElement, int index)
illuminatorElement
- of IlluminatorElementType
index
- of IlluminatorElementType
characteristic contained in elementpublic static void deleteIlluminatorElementCharacteristic(IlluminatorElementType illuminatorElement, StringElementType characteristic)
illuminatorElement
- of IlluminatorElementType
characteristic
- IlluminatorElementType characteristic to be removedpublic static String getMarkerElementType(MarkerElementType marker)
marker
- of MarkerElementType
MarkerType.LASER
, MarkerType.SMOKE
or MarkerType.DYE_MARKER
public static int getMarkerElementNumberOfCharacteristics(MarkerElementType marker)
marker
- of MarkerElementType
public static StringElementType getMarkerElementCharacteristic(MarkerElementType marker, int index)
marker
- of MarkerElementType
index
- of MarkerElementType
characteristic contained in elementpublic static String getMarkerElementDescription(MarkerElementType marker)
marker
- of MarkerElementType
public static void setMarkerElementType(MarkerElementType marker, String type)
marker
- of MarkerElementType
type
- kind of marker (IlluminatorType.PYROTECHNICS
, IlluminatorType.FLOODLIGHT
or IlluminatorType.SPOTLIGHT
)public static void setMarkerElementDescription(MarkerElementType marker, String description)
marker
- of MarkerElementType
description
- further information about this elementpublic static void addMarkerElementCharacteristic(MarkerElementType marker, String newChar, String description)
marker
- of MarkerElementType
newChar
- String value of the characteristic to be addeddescription
- further information about this elementpublic static void clearMarkerElementCharacteristics(MarkerElementType marker)
marker
- of MarkerElementType
public static void deleteMarkerElementCharacteristic(MarkerElementType marker, int index)
marker
- of MarkerElementType
index
- of MarkerElementType
characteristic contained in elementpublic static void deleteMarkerElementCharacteristic(MarkerElementType marker, StringElementType characteristic)
marker
- of MarkerElementType
characteristic
- characteristic object to be removedpublic static String getQualifierElementValue(StringElementType qualifier)
qualifier
- of StringElementType
public static String getQualifierElementDescription(StringElementType qualifier)
qualifier
- of StringElementType
public static void setQualifierElementValue(StringElementType qualifier, String value)
qualifier
- of StringElementType
value
- public static void setQualifierElementDescription(StringElementType qualifier, String description)
qualifier
- of StringElementType
description
- further information about this elementpublic static String getIlluminatorCharacteristicElementValue(StringElementType illuminatorCharacteristic)
illuminatorCharacteristic
- of StringElementType
public static String getIlluminatorCharacteristicElementDescription(StringElementType illuminatorCharacteristic)
illuminatorCharacteristic
- of StringElementType
public static void setIlluminatorCharacteristicElementValue(StringElementType illuminatorCharacteristic, String value)
illuminatorCharacteristic
- of StringElementType
value
- public static void setIlluminatorCharacteristicElementDescription(StringElementType illuminatorCharacteristic, String description)
illuminatorCharacteristic
- of StringElementType
description
- further information about this elementpublic static String getMarkerCharacteristicElementValue(StringElementType illuminatorCharacteristic)
illuminatorCharacteristic
- of StringElementType
public static String getMarkerCharacteristicElementDescription(StringElementType illuminatorCharacteristic)
illuminatorCharacteristic
- of StringElementType
public static void setMarkerCharacteristicElementValue(StringElementType illuminatorCharacteristic, String value)
illuminatorCharacteristic
- of StringElementType
value
- public static void setMarkerCharacteristicElementDescription(StringElementType illuminatorCharacteristic, String description)
illuminatorCharacteristic
- of StringElementType
description
- further information about this elementpublic static String getActionObjectName(ActionObjectElementType actionObject)
actionObject
- action object ActionObjectElementType
public static String getActionObjectDescription(ActionObjectElementType actionObject)
actionObject
- action object ActionObjectElementType
public static void setActionObjectName(ActionObjectElementType actionObject, String newName)
actionObject
- action object ActionObjectElementType
newName
- public static void setActionObjectDescription(ActionObjectElementType actionObject, String newDescription)
actionObject
- action object ActionObjectElementType
newDescription
- public static double getFrequencyRangeMinimum(FrequencyRangeElementType frequencyRange)
frequencyRange
- of FrequencyRangeElementType
public static double getFrequencyRangeMaximum(FrequencyRangeElementType frequencyRange)
frequencyRange
- of FrequencyRangeElementType
public static String getFrequencyRangeDescription(FrequencyRangeElementType frequencyRange)
frequencyRange
- of FrequencyRangeElementType
public static void setFrequencyRangeMinimum(FrequencyRangeElementType frequencyRange, double newValue)
frequencyRange
- of FrequencyRangeElementType
newValue
- public static void setFrequencyRangeMaximum(FrequencyRangeElementType frequencyRange, double newValue)
frequencyRange
- of FrequencyRangeElementType
newValue
- public static void setFrequencyRangeBounds(FrequencyRangeElementType frequencyRange, double bound1, double bound2)
frequencyRange
- of FrequencyRangeElementType
bound1
- bound2
- public static void setFrequencyRangeDescription(FrequencyRangeElementType frequencyRange, String newDescription)
frequencyRange
- of FrequencyRangeElementType
newDescription
- public static String getContaminantElementType(ContaminantElementType contaminantElement)
contaminantElement
- of ContaminantElementType
containing contaminantContaminantType.NUCLEAR
, ContaminantType.BIOLOGICAL
, ContaminantType.CHEMICAL
, ContaminantType.EXPLOSIVE
of (default) ContaminantType.TOXIN
public static String getContaminantElementDescription(ContaminantElementType contaminantElement)
contaminantElement
- of ContaminantElementType
containing contaminantpublic static void setContaminantElementType(ContaminantElementType contaminantElement, String newValue)
contaminantElement
- of ContaminantElementType
containing contaminantnewValue
- ContaminantType.NUCLEAR
, ContaminantType.BIOLOGICAL
, ContaminantType.CHEMICAL
, ContaminantType.EXPLOSIVE
of (default) ContaminantType.TOXIN
public static void setContaminantElementDescription(ContaminantElementType contaminantElement, String newDescription)
contaminantElement
- of ContaminantElementType
containing contaminantnewDescription
- ContaminantType.NUCLEAR
, ContaminantType.BIOLOGICAL
, ContaminantType.CHEMICAL
, ContaminantType.EXPLOSIVE
of (default) ContaminantType.TOXIN
public static String getReportingCriteriaValue(ReportingCriteriaElementType reportingCriteria)
reportingCriteria
- of ReportingCriteriaElementType
public static double getReportingCriteriaPeriodicity(ReportingCriteriaElementType reportingCriteria)
reportingCriteria
- of ReportingCriteriaElementType
public static String getReportingCriteriaDescription(ReportingCriteriaElementType reportingCriteria)
reportingCriteria
- of ReportingCriteriaElementType
public static void setReportingCriteriaValue(ReportingCriteriaElementType reportingCriteria, String newValue)
reportingCriteria
- of ReportingCriteriaElementType
newValue
- public static void setReportingCriteriaPeriodicity(ReportingCriteriaElementType reportingCriteria, double newTimeInterval)
reportingCriteria
- newTimeInterval
- public static void setReportingCriteriaDescription(ReportingCriteriaElementType reportingCriteria, String newDescription)
reportingCriteria
- newDescription
- public static AbsoluteTimingElementType createAbsoluteTimingElement(double start, double stop, String description)
start
- start time of the goalstop
- end time of the goaldescription
- further information about this elementAbsoluteTimingElementType
public static double getAbsoluteTimingStart(AbsoluteTimingElementType absoluteTiming)
absoluteTiming
- public static double getAbsoluteTimingStop(AbsoluteTimingElementType absoluteTiming)
absoluteTiming
- public static String getAbsoluteTimingDescription(AbsoluteTimingElementType absoluteTiming)
absoluteTiming
- public static void setAbsoluteTimingStart(AbsoluteTimingElementType absoluteTiming, double newStartTime)
absoluteTiming
- newStartTime
- public static void setAbsoluteTimingStop(AbsoluteTimingElementType absoluteTiming, double newStopTime)
absoluteTiming
- newStopTime
- public static void setAbsoluteTimingDescription(AbsoluteTimingElementType absoluteTiming, String newDescription)
absoluteTiming
- newDescription
- public static PositiveScalarElementType createMaxTimeElement(double maxTime, String description)
maxTime
- the maximum amount of time to devote to this goal once starteddescription
- further information about this elementPositiveScalarElementType
public static double getMaxTimeValue(PositiveScalarElementType maxTime)
maxTime
- public static String getMaxTimeDescription(PositiveScalarElementType maxTime)
maxTime
- public static void setMaxTimeValue(PositiveScalarElementType maxTime, double newValue)
maxTime
- newValue
- public static void setMaxTimeDescription(PositiveScalarElementType maxTime, String newDescription)
maxTime
- newDescription
- public static double getVerticalBlockMin(NumericalBlockElementType verticalBlock)
verticalBlock
- public static double getVerticalBlockMax(NumericalBlockElementType verticalBlock)
verticalBlock
- public static String getVerticalBlockDescription(NumericalBlockElementType verticalBlock)
verticalBlock
- public static void setVerticalBlockMin(NumericalBlockElementType verticalBlock, double newValue)
verticalBlock
- newValue
- public static void setVerticalBlockMax(NumericalBlockElementType verticalBlock, double newValue)
verticalBlock
- newValue
- public static void setVerticalBlockDescription(NumericalBlockElementType verticalBlock, String newDescription)
verticalBlock
- newDescription
- public static double getDepthOrAltitude(PositiveScalarElementType depthOrAltitudeBlock)
depthOrAltitudeBlock
- public static String getDepthOrAltitudeDescription(PositiveScalarElementType depthOrAltitudeBlock)
depthOrAltitudeBlock
- public static void setDepthOrAltitude(PositiveScalarElementType depthOrAltitudeBlock, double newValue)
depthOrAltitudeBlock
- newValue
- public static void setDepthOrAltitudeDescription(PositiveScalarElementType depthOrAltitudeBlock, String newDescription)
depthOrAltitudeBlock
- newDescription
- public static RouteElementType createRouteElement(int pointType, List<double[]> points, int verticalType, double verticalValue1, double verticalValue2, String description)
pointType
- enumerated position type (x y, or latitude longitude)points
- List
of 2x1 double-precision arrays each holding x,y or latitude,longitude valuesverticalType
- enumerated vertical requirements (AvclMission.DEPTH
, AvclMission.ALTITUDE_ABV_BTM
, AvclMission.ALTITUDE_MSL
, AvclMission.ALTITUDE_AGL
, AvclMission.DEPTH_BLK
, AvclMission.ALTITUDE_ABV_BTM_BLK
, AvclMission.ALTITUDE_AGL_BLK
, AvclMission.ALTITUDE_MSL_BLK
, AvclMission.ALTITUDE_AGL_MSL_BLK
or AvclMission.DEPTH_ALTITUDE_ABV_BTM_BLK
) on routeverticalValue1
- the first parameter required to specify the vertical requirement (minimum altitude or minimum depth) for this verticalTypeverticalValue2
- the second parameter required to specify the vertical requirement (maximum altitude or maximum depth) for this verticalTypedescription
- further information about this elementRouteElementType
public static int getRoutePointType(RouteElementType route)
route
- of RouteElementType
AvclMission.XYPOSITION
or AvclMission.LATLONGPOSITION
public static List getRoutePointList(RouteElementType route, int pointType)
route
- of RouteElementType
pointType
- AvclMission.XYPOSITION
or AvclMission.LATLONGPOSITION
List
of either AvclMission.XYPOSITION
(type XyElementType
) or AvclMission.LATLONGPOSITION
(type LatitudeLongitudeElementType
) valuespublic static double getRoutePtX(Object positionElement)
positionElement
- of XyElementType
of LatitudeLongitudeElementType
public static double getRoutePtY(Object positionElement)
positionElement
- of XyElementType
of LatitudeLongitudeElementType
public static int getRouteVerticalType(RouteElementType route)
route
- of RouteElementType
AvclMission.DEPTH
, AvclMission.ALTITUDE_ABV_BTM
, AvclMission.ALTITUDE_MSL
, AvclMission.ALTITUDE_AGL
, AvclMission.DEPTH_BLK
, AvclMission.ALTITUDE_ABV_BTM_BLK
, AvclMission.ALTITUDE_AGL_BLK
, AvclMission.ALTITUDE_MSL_BLK
, AvclMission.ALTITUDE_AGL_MSL_BLK
or AvclMission.DEPTH_ALTITUDE_ABV_BTM_BLK
public static double getRouteVerticalMin(RouteElementType route)
route
- public static double getRouteVerticalMax(RouteElementType route)
route
- of RouteElementType
public static String getRouteDescription(RouteElementType route)
route
- public static void setRoutePointList(RouteElementType route, int pointType, List<double[]> points)
route
- pointType
- AvclMission.XYPOSITION
or AvclMission.LATLONGPOSITION
points
- List
of 2x1 double-precision arrays each holding x,y or latitude,longitude valuespublic static void setRouteVerticalControl(RouteElementType route, int verticalType, double verticalValue1, double verticalValue2)
route
- verticalType
- AvclMission.DEPTH
, AvclMission.ALTITUDE_ABV_BTM
, AvclMission.ALTITUDE_MSL
, AvclMission.ALTITUDE_AGL
, AvclMission.DEPTH_BLK
, AvclMission.ALTITUDE_ABV_BTM_BLK
, AvclMission.ALTITUDE_AGL_BLK
, AvclMission.ALTITUDE_MSL_BLK
, AvclMission.ALTITUDE_AGL_MSL_BLK
or AvclMission.DEPTH_ALTITUDE_ABV_BTM_BLK
verticalValue1
- the first parameter required to specify the vertical requirement (minimum altitude or minimum depth) for this verticalTypeverticalValue2
- the second parameter required to specify the vertical requirement (maximum altitude or maximum depth) for this verticalTypepublic static void setRouteDescription(RouteElementType route, String newDescription)
route
- newDescription
- public static int getPointElementPointType(AbsoluteHorizontalPositionElementType point)
point
- of AbsoluteHorizontalPositionElementType
AvclMission.XYPOSITION
or AvclMission.LATLONGPOSITION
public static double[] getPointElementPoint(AbsoluteHorizontalPositionElementType point)
point
- of AbsoluteHorizontalPositionElementType
public static String getPointElementDescription(AbsoluteHorizontalPositionElementType point)
point
- public static void setPointElementDescription(AbsoluteHorizontalPositionElementType point, String description)
point
- of AbsoluteHorizontalPositionElementType
description
- further information about this elementpublic static int getCircleElementCenterPointType(CircleElementType circle)
circle
- AvclMission.XYPOSITION
or AvclMission.LATLONGPOSITION
public static double[] getCircleElementCenter(CircleElementType circle)
circle
- public static double getCircleElementRadius(CircleElementType circle)
circle
- public static String getCircleElementDescription(CircleElementType circle)
circle
- public static void setCircleElementDescription(CircleElementType circle, String description)
circle
- description
- further information about this elementpublic static int getRectangleElementNorthwestCornerPointType(RectangleElementType rectangle)
rectangle
- that provides northwest coordinate informationpublic static double[] getRectangleElementNorthwestCorner(RectangleElementType rectangle)
rectangle
- an area to derive a NW corner frompublic static double getRectangleElementWidth(RectangleElementType rectangle)
rectangle
- public static double getRectangleElementHeight(RectangleElementType rectangle)
rectangle
- public static double getRectangleElementRotation(RectangleElementType rectangle)
rectangle
- public static String getRectangleElementDescription(RectangleElementType rectangle)
rectangle
- public static void setRectangleElementDescription(RectangleElementType rectangle, String description)
rectangle
- description
- further information about this elementpublic static int getPolygonElementPointType(PolygonElementType polygon)
polygon
- of PolygonElementType
AvclMission.XYPOSITION
or AvclMission.LATLONGPOSITION
public static List getPolygonElementPoints(PolygonElementType polygon)
polygon
- of PolygonElementType
List
of either AvclMission.XYPOSITION
(type XyElementType
) or AvclMission.LATLONGPOSITION
(type LatitudeLongitudeElementType
) valuespublic static int getPolygonElementNumPoints(PolygonElementType polygon)
polygon
- of PolygonElementType
public static double[] getPolygonElementPoint(PolygonElementType polygon, int point)
polygon
- of PolygonElementType
point
- of AbsoluteHorizontalPositionElementType
public static double getPolygonElementPointX(PolygonElementType polygon, int point)
polygon
- of PolygonElementType
point
- of AbsoluteHorizontalPositionElementType
public static double getPolygonElementPointY(PolygonElementType polygon, int point)
polygon
- of PolygonElementType
point
- of AbsoluteHorizontalPositionElementType
public static String getPolygonElementDescription(PolygonElementType polygon)
polygon
- of PolygonElementType
public static void setPolygonElementDescription(PolygonElementType polygon, String description)
polygon
- of PolygonElementType
description
- further information about this elementpublic static int getLimitingElementPointType(LimitingLineElementType limitingLine)
limitingLine
- public static List getLimitingLineElementPoints(LimitingLineElementType limitingLine)
limitingLine
- List
of LimitingLineElementType
public static String getLimitingLineElementDescription(LimitingLineElementType limitingLine)
limitingLine
- public static double getLimitingLineElementPointX(LimitingLineElementType limitingLine, int pointIndex)
limitingLine
- of LimitingLineElementType
pointIndex
- index of point of interestpublic static double getLimitingLineElementPointY(LimitingLineElementType limitingLine, int pointIndex)
limitingLine
- of LimitingLineElementType
pointIndex
- index of point of interestpublic static void setLimitingLineElementDescription(LimitingLineElementType limitingLine, String description)
limitingLine
- description
- further information about this element