Loadable Module: Guidance

The GuidanceModule provides Behavior instances that can be used in a mission script to direct the vehicle. More...

Namespaces
	AltitudeEnvelopeIF
	Specifies the interface details for the AltitudeEnvelope component in the GuidanceModule.
	BuoyancyIF
	Specifies the interface details for the Buoyancy component in the GuidanceModule.
	CircleIF
	Specifies the interface details for the Circle component in the GuidanceModule.
	DepthEnvelopeIF
	Specifies the interface details for the DepthEnvelope component in the GuidanceModule.
	DepthServoIF
	Specifies the interface details for the DepthServo component in the GuidanceModule.
	ExecuteIF
	Specifies the interface details for the Execute component in the GuidanceModule.
	GoToSurfaceIF
	Specifies the interface details for the GoToSurface component in the GuidanceModule.
	KeepStationIF
	Specifies the interface details for the KeepStation component in the GuidanceModule.
	LaneIF
	Specifies the interface details for the Lane component in the GuidanceModule.
	OffshoreEnvelopeIF
	Specifies the interface details for the OffshoreEnvelope component in the GuidanceModule.
	PitchIF
	Specifies the interface details for the Pitch component in the GuidanceModule.
	PitchServoIF
	Specifies the interface details for the PitchServo component in the GuidanceModule.
	PointIF
	Specifies the interface details for the Point component in the GuidanceModule.
	PrepareToDiveIF
	Specifies the interface details for the PrepareToDive component in the GuidanceModule.
	SetSpeedIF
	Specifies the interface details for the SetSpeed component in the GuidanceModule.
	StopMissionIF
	Specifies the interface details for the StopMission component in the GuidanceModule.
	WaitIF
	Specifies the interface details for the Wait component in the GuidanceModule.
	WaterDepthEnvelopeIF
	Specifies the interface details for the WaterDepthEnvelope component in the GuidanceModule.
	WaypointIF
	Specifies the interface details for the Waypoint component in the GuidanceModule.
	YoYoIF
	Specifies the interface details for the YoYo component in the GuidanceModule.
	ZigZagIF
	Specifies the interface details for the ZigZag component in the GuidanceModule.
	PeakDetectHorizontalIF
	Specifies the interface details for the PeakDetectHorizontal component in the GuidanceModule.
	PeakDetectVsDepthIF
	Specifies the interface details for the PeakDetectVsDepth component in the GuidanceModule.
	ValueDetectIF
	Specifies the interface details for the ValueDetect component in the GuidanceModule.

Classes
class	AltitudeEnvelope
	Contains the AltitudeEnvelope Behavior/Command If the vehicle's altitude is within the specified max/min envelope, the command is satisfied. More...
class	Buoyancy
	Contains the Buoyancy Command. More...
class	DepthEnvelope
	Contains the DepthEnvelope Behavior/Command If the vehicle's depth is within the specified max/min envelope, the command is satisfied. More...
class	DepthServo
	Contains the DepthServo Behavior/Command Uses depth, or the specified surrogate for depth to control the depth of the vehicle such that the vehicle stays at a constant depth, or other variable (if specified). More...
class	Execute
	Contains the Execute Command. More...
class	GoToSurface
	Contains the GoToSurface Behavior/Command. More...
class	GuidanceModule
	The GuidanceModule provides Behavior instances that can be used in a mission script to direct the vehicle. More...
class	KeepStation
	Contains the DepthEnvelope Behavior/Command If the vehicle's depth is within the specified max/min envelope, the command is satisfied. More...
class	OffshoreEnvelope
	Contains the OffshoreEnvelope Behavior/Command. More...
class	OffshoreEnvelope_Test
	Units tests for OffshoreEnvelope class. More...
class	Pitch
	Contains the Pitch Behavior/Command. More...
class	PitchServo
	Contains the PitchServo Behavior/Command Uses depth, or the specified surrogate for depth to control the depth of the vehicle such that the vehicle stays at a constant depth, or other variable (if specified). More...
class	Point
	Contains the Point Behavior/Command. More...
class	PrepareToDive
	Contains the PrepareToDive Behavior/Command. More...
class	SetSpeed
	Contains the SetSpeed Behavior/Command. More...
class	StopMission
	Contains the StopMission Command. More...
class	Wait
	Contains the Wait Command. More...
class	WaterDepthEnvelope
	Contains the WaterDepthEnvelope Behavior/Command. More...
class	YoYo
	Contains the YoYo Behavior. More...
class	ReadDataComponent
	Contains the ReadDataComponent Behavior/Command. More...
class	ValueDetect_Test
	Units tests for ValueDetect class. More...

Enumerations
enum	KeepStation::KeepStationMode { KeepStation::NOT_INITIALIZED = 0, KeepStation::REST = 1, KeepStation::GOTO_WAYPOINT = 2 }

Detailed Description

The GuidanceModule provides Behavior instances that can be used in a mission script to direct the vehicle.

These could be considered Behaviors or Commands.

Enumeration Type Documentation

enum KeepStation::KeepStationMode

protected

Enumerator
NOT_INITIALIZED
REST
GOTO_WAYPOINT