LRAUV  revA
Pitch.h
Go to the documentation of this file.
1 
12 #ifndef PITCH_H_
13 #define PITCH_H_
14 
15 #include "component/Behavior.h"
16 
18 
28 class Pitch : public Behavior
29 {
30 public:
31 
32  Pitch( const Str& prefix, const Module* module );
33 
34  virtual ~Pitch();
35 
37  void initialize();
38 
39  // Reads in behavior settings
40  void readSettings();
41 
43  bool readParams();
44 
46  bool calcSatisfied();
47 
49  void run();
50 
52  bool isSatisfied();
53 
55  bool runIfUnsatisfied();
56 
58  void uninitialize();
59 
61  static Behavior* CreateBehavior( const Str& prefix, const Module* module );
62 
63 protected:
64 
65  // Slate input setting variables
66 
70 
75 
79 
83 
88 
93 
94  // Other slate inputs
95 
96  // Slate input measurements
97 
100 
101  // Slate output variables
102 
105 
108 
111 
114 
117 
120 
123 
124  // Setting Variables
125 
128 
131 
134 
137 
140 
143 
144  // Initial Variables
145 
148 
149  // Current Variables
150 
152  float depth_;
153 
156 
157 private:
158  // Note that the copy constructor below is private and not given a body.
159  // Any attempt to call it will return a compiler error.
160  Pitch( const Pitch& old ); // disallow copy constructor
161 
162 };
163 
164 #endif /*PITCH_H_*/
void initialize()
Initialize function.
Definition: Pitch.cpp:67
DataWriter * massPositionCmdWriter_
Sets the massPosition for Depth Control.
Definition: Pitch.h:116
UniversalDataReader * depthReader_
Current depth of the vehicle.
Definition: Pitch.h:99
A DataAccessor that reads values from the Slate Contains a default dataValue that must not be NULL...
Definition: UniversalDataReader.h:26
SettingReader * depthSettingReader_
Desired depth to direct the vehicle to.
Definition: Pitch.h:69
SettingReader * elevatorAngleSettingReader_
Desired elevator angle for the vehicle.
Definition: Pitch.h:78
SettingReader * depthRateSettingReader_
Desired depth rate for the vehicle.
Definition: Pitch.h:74
float elevatorAngleSetting_
Desired elevator angle of the vehicle.
Definition: Pitch.h:133
DataWriter * pitchCmdWriter_
Sets the specified pitch for Depth Control.
Definition: Pitch.h:119
bool initialized_
Have we learned all our initial settings?
Definition: Pitch.h:155
Behavior is the abstract base class for components that implement mission behaviors and commands...
Definition: Behavior.h:32
float pitchRateSetting_
Desired pitch rate of the vehicle.
Definition: Pitch.h:142
DataWriter * verticalModeWriter_
Sets the mode for Depth Control.
Definition: Pitch.h:104
bool isSatisfied()
Just do the satisfied: return true if envelope "satisfied".
Definition: Pitch.cpp:157
void readSettings()
Definition: Pitch.cpp:86
A DataAccessor that writes values to the Slate via its associated DataElement.
Definition: DataWriter.h:27
Pitch(const Str &prefix, const Module *module)
Definition: Pitch.cpp:19
Contains the Behavior class definition.
float massPositionSetting_
Desired massPosition of the vehicle.
Definition: Pitch.h:136
DataWriter * depthRateCmdWriter_
Sets the specified depth rate for Depth Control.
Definition: Pitch.h:110
bool readParams()
Read in the parameters for satisfied or runIfUnsatisfied: return true if OK.
Definition: Pitch.cpp:105
bool calcSatisfied()
Perform the satisfied: return true if envelope "satisfied".
Definition: Pitch.cpp:125
Module is the abstract base class for a collection of Component objects that can be contained in a lo...
Definition: Module.h:45
DataWriter * depthCmdWriter_
Sets the specified depth for Depth Control.
Definition: Pitch.h:107
virtual ~Pitch()
Definition: Pitch.cpp:63
void uninitialize()
Uninit function.
Definition: Pitch.cpp:252
Replacement for standard template class string.
Definition: Str.h:12
bool runIfUnsatisfied()
Do the run, and return true if envelope "satisfied".
Definition: Pitch.cpp:168
void run()
Just do the run: ignore the results of the satisfied.
Definition: Pitch.cpp:151
Reads values from mission settings.
Definition: SettingReader.h:26
static Behavior * CreateBehavior(const Str &prefix, const Module *module)
Mission Component factory interface.
Definition: Pitch.cpp:259
float pitchSetting_
Desired pitch of the vehicle.
Definition: Pitch.h:139
Contains the Pitch Behavior/Command.
Definition: Pitch.h:28
float depthSetting_
Desired depth of the vehicle.
Definition: Pitch.h:127
float depth_
Current depth of the vehicle.
Definition: Pitch.h:152
float depthRateSetting_
Desired depthRate of the vehicle.
Definition: Pitch.h:130
DataWriter * elevatorAngleCmdWriter_
Sets the elevator angle for Depth Control.
Definition: Pitch.h:113
DataWriter * pitchRateCmdWriter_
Sets the specified pitch for Depth Control.
Definition: Pitch.h:122
float initialDepth_
Initial depth of the vehicle.
Definition: Pitch.h:147
SettingReader * massPositionSettingReader_
Desired massPosition for the vehicle.
Definition: Pitch.h:82
SettingReader * pitchSettingReader_
Desired pitch of the vehicle.
Definition: Pitch.h:87
SettingReader * pitchRateSettingReader_
Desired pitch rate of the vehicle.
Definition: Pitch.h:92