LRAUV  revA
Radio_Surface.h
Go to the documentation of this file.
1 
12 #ifndef Radio_Surface_H
13 #define Radio_Surface_H
14 
16 #include "data/StrValue.h"
17 #include "io/LoadControl.h"
18 #include "logger/Logger.h"
19 
21 
22 
30 {
31 public:
32 
33  Radio_Surface( const Module* module );
34 
35  virtual ~Radio_Surface();
36 
37  virtual void run();
38 
39  virtual void uninitialize();
40 
43  virtual RunState start();
44 
46  virtual RunState starting();
47 
49  virtual RunState pause();
50 
52  virtual RunState paused();
53 
55  virtual RunState resume();
56 
58  virtual RunState resuming();
59 
61  virtual RunState runnable();
62 
64  virtual RunState resetting()
65  {
66  return start();
67  }
68 
70  virtual RunState stop();
71 
72  virtual RunState stopping();
73 
75  virtual RunState stopped();
76 
78  virtual ConfigURI getConfigURI( ConfigOption configOption ) const;
79 
80 private:
81  // Note that the copy constructor below is private and not given a body.
82  // Any attempt to call it will return a compiler error.
83  Radio_Surface( const Radio_Surface& old ); // disallow copy constructor
84 
85  //*------------------- vehicle parameters --------------------------*/
88 
89  // returns true if data is requested from one of the readers
90  bool isDataRequested();
91 
92  // checks to see if we should be on
93  bool shouldBeOn();
94 
95  // Sends data to DataWriters
96  void writeData();
97 
98  // Power for the Radio
100 
103 
106 
109 
110  // Universal output. Used only to determine if we should power up.
111 // UniversalDataWriter* communicationsWriter_;
112 
113  // Slate inputs
116 
117  // Slate outputs
119 
122 
124  bool debug_;
125 
126  // Power is on (true) or off (false)
128 
129 };
130 #endif /*Radio_Surface_H*/
virtual RunState resume()
Resume from PAUSE.
Definition: Radio_Surface.cpp:121
Timestamp startTime_
Time data request started.
Definition: Radio_Surface.h:102
virtual RunState stopped()
Initial state – can be later followed by START.
Definition: Radio_Surface.cpp:219
virtual ~Radio_Surface()
Definition: Radio_Surface.cpp:54
Contains the LoadControl class declaration.
A DataAccessor that reads values from the Slate Contains a default dataValue that must not be NULL...
Definition: UniversalDataReader.h:26
float surfaceThreshold_
Definition: Radio_Surface.h:86
virtual ConfigURI getConfigURI(ConfigOption configOption) const
Should return [myNamespace]::SIMULATE_HARDWARE, or [myNamespace]::POWER, etc.
Definition: Radio_Surface.cpp:265
A DataAccessor that reads values from the Slate Contains a default dataValue that must not be NULL...
Definition: DataReader.h:30
bool radioPwrOn_
Definition: Radio_Surface.h:127
A DataAccessor that writes values to the Slate via its associated DataElement.
Definition: UniversalDataWriter.h:24
virtual RunState resetting()
Might occur in case of Error.
Definition: Radio_Surface.h:64
virtual void uninitialize()
Provide a space for uninitialization.
Definition: Radio_Surface.cpp:285
RunState
Definition: Component.h:115
Timespan timeout_
Timeout for powering down/up.
Definition: Radio_Surface.h:105
virtual RunState stop()
Initial state – can be later followed by START.
Definition: Radio_Surface.cpp:180
Timespan class, represents a delta of time.
Definition: Timestamp.h:248
Timespan pausePeriod_
How often to run the loop when paused.
Definition: Radio_Surface.h:108
LoadControl loadControl_
Definition: Radio_Surface.h:99
A DataAccessor that writes values to the Slate via its associated DataElement.
Definition: DataWriter.h:27
DataReader * verticalModeReader_
Definition: Radio_Surface.h:115
Definition: ElementURI.h:166
virtual RunState starting()
Might follow a STOP...START sequence.
Definition: Radio_Surface.cpp:88
Contains the StrValue class definition.
virtual RunState resuming()
Might follow a PAUSE...RESUME sequence.
Definition: Radio_Surface.cpp:127
virtual void run()
The actual "payload" of the component.
Definition: Radio_Surface.cpp:60
UniversalDataReader * depthReader_
Definition: Radio_Surface.h:114
Module is the abstract base class for a collection of Component objects that can be contained in a lo...
Definition: Module.h:45
virtual RunState pause()
Pause for a short period (indicated by pauseTime)
Definition: Radio_Surface.cpp:108
DataWriter * radioPwrWriter_
Definition: Radio_Surface.h:118
bool shouldBeOn()
Definition: Radio_Surface.cpp:236
This class allows one to control loads on a load controller channel.
Definition: LoadControl.h:24
Provides software interface to the Wetlabs puck.
Definition: Radio_Surface.h:29
Timespan resetFailTimeout_
Definition: Radio_Surface.h:105
Definition: ConfigReader.h:13
Abstract Base class for software components that run independently from the computation cycle...
Definition: AsyncComponent.h:20
virtual RunState stopping()
Might follow a STOP request.
Definition: Radio_Surface.cpp:199
Contains the Logger class definition.
virtual RunState paused()
Should eventually follow a PAUSE request: should set continueTime.
Definition: Radio_Surface.cpp:115
virtual RunState runnable()
Should eventually follow a START request or RESETTING.
Definition: Radio_Surface.cpp:134
Radio_Surface(const Module *module)
Definition: Radio_Surface.cpp:21
void writeData()
Definition: Radio_Surface.cpp:258
virtual RunState start()
Do what needs to be done to run Similar to initialize, in old init/run/uninit sequence.
Definition: Radio_Surface.cpp:67
ConfigOption
Definition: Component.h:456
bool isDataRequested()
Definition: Radio_Surface.cpp:278
bool debug_
Debugging outputs.
Definition: Radio_Surface.h:124
Represents absolute times.
Definition: Timestamp.h:31
ConfigReader * maxDepthCfgReader_
Configuration readers.
Definition: Radio_Surface.h:121
Contains the AsyncComponent class definition.