avcl

Interface ScriptCommandGenerator

public interface ScriptCommandGenerator

Interface used by classes that are capable of generating a series of AVCL script commands. Used primarily by planners that break down high level, or abstract, goals into a sequence of task-level commands

Author:

dtdavis

Method Summary

Methods

Modifier and Type	Method and Description
List	generateAvclScript(int vehicleType, int gpsFrequency, double vertical, int verticalMode, double speed, int speedMode) Generates a set of AVCL task-level commands relevant to the implementing object's purpose (e.g., a series of script commands that implement a planner object's computed plan)

Method Detail

generateAvclScript

List generateAvclScript(int vehicleType,
                      int gpsFrequency,
                      double vertical,
                      int verticalMode,
                      double speed,
                      int speedMode)

Generates a set of AVCL task-level commands relevant to the implementing object's purpose (e.g., a series of script commands that implement a planner object's computed plan)

Parameters:

vehicleType - enumeration for the type of vehicle (AUV, UAV, etc.)

gpsFrequency - number of waypoints between GPS fixes (only relevant for UUVs)

vertical - altitude or depth of command (only relevant for UUVs and UAVs)

verticalMode - enumeration specifying depth, altitude, MSL altitude, or AGL altitude

speed - knots, meters per second, or percent of propeller rpm (AUV) setting

speedMode - enumeration for knots or meters per second (not relevant for AUVs)

Returns:

ArrayList of AVCL script command objects (JAXB)