LRAUV  revA
CircleIF.h
Go to the documentation of this file.
1 
13 #ifndef CIRCLEIF_H_
14 #define CIRCLEIF_H_
15 
16 #include "data/ElementURI.h"
17 
27 namespace CircleIF
28 {
31 static const NameURI NAME( "Circle", "Drives the vehicle in a circle at a set radius from a waypoint" );
32 
35 static const SettingURI ANGLE_SETTING( "angle", "Angle of the circle to proceed "
36  "through if running sequentially.", Units::RADIAN );
37 static const SettingURI EASTINGS_DELTA_SETTING( "eastingsDelta", "Desired change "
38  "in longitude to achieve, expressed as a distance", Units::METER );
39 static const SettingURI LATITUDE_SETTING( "latitude", "Desired waypoint "
40  "latitude", Units::DEGREE );
41 static const SettingURI LATITUDE_DELTA_SETTING( "latitudeDelta", "Desired "
42  "waypoint latitude delta from the current latitude", Units::DEGREE );
43 static const SettingURI LONGITUDE_SETTING( "longitude", "Desired waypoint "
44  "longitude", Units::DEGREE );
45 static const SettingURI LONGITUDE_DELTA_SETTING( "longitudeDelta", "Desired "
46  "waypoint latitude delta from the current latitude", Units::DEGREE );
47 static const SettingURI MAX_ERROR_SETTING( "maxError", "Maximum radial error: "
48  "if outside this range, drive straight to the circle perimeter", Units::METER );
49 static const SettingURI NORTHINGS_DELTA_SETTING( "northingsDelta", "Desired "
50  "change in latitude to achieve, expressed as a distance", Units::METER );
51 static const SettingURI RADIUS_SETTING( "radius", "radius of the circle", Units::METER );
52 static const SettingURI TURN_TO_PORT_SETTING( "turnToPort", "If true, vehicle "
53  "turns to port around the circle. Otherwise to starboard", Units::BOOL );
54 
55 }
56 
57 #endif /*CIRCLEIF_H_*/
Specifies the interface details for the Circle component in the GuidanceModule.
Definition: CircleIF.h:27
static const BaseUnit RADIAN
Definition: Units.h:60
Definition: ElementURI.h:268
Contains the ElementURI class definition.
Definition: ElementURI.h:242
static const Unit DEGREE
Definition: Units.h:132
static const BaseUnit BOOL
Definition: Units.h:227
static const BaseUnit METER
Definition: Units.h:42