CSonarController is used to automate the firing of multiple sonar modules (sonar arrays).
More...
#include <sonarcont.h>
List of all members.
Public Member Functions |
| | CSonarController () |
| | default constructor.
|
| | CSonarController (unsigned int numSonar, CSonar *sonarArray[], unsigned int fireIntervalMs) |
| | This constructor takes the necessary arguments to set up a working sonar array.
|
| | ~CSonarController () |
| int | SetFiring (unsigned int numSonar, CSonar *sonarArray[], unsigned int fireIntervalMs) |
| | This method takes the necessary arguments to set up a working sonar array.
|
| int | EndFiring () |
| | Stops the firing of the sonar array.
|
| int | GetVals (int vals[]) |
| | Get the most recent sonar distance values in inches.
|
Detailed Description
CSonarController is used to automate the firing of multiple sonar modules (sonar arrays).
After setting up a sonar array, this class will automatically fire the sonar array in the order specified in the background. It will also collect the most recent distance readings of the array. See CSonar for single sonar methods.
Constructor & Destructor Documentation
| CSonarController::CSonarController |
( |
|
) |
|
| CSonarController::CSonarController |
( |
unsigned int |
numSonar, |
|
|
CSonar * |
sonarArray[], |
|
|
unsigned int |
fireIntervalMs | |
|
) |
| | |
This constructor takes the necessary arguments to set up a working sonar array.
- Parameters:
-
| numSonar | the number of sonars in the sonar array. |
| sonarArray | an array of pointers to CSonar instantiations. The order of the CSonar pointers determines the firing order of the sonar array. |
| fireIntervalMs | the amount of time in milliseconds to wait between subsequent sonar firings. This value should not be below 10 ms. |
- Returns:
- 0 if success -1 if error.
| CSonarController::~CSonarController |
( |
|
) |
|
Member Function Documentation
| int CSonarController::EndFiring |
( |
|
) |
|
Stops the firing of the sonar array.
- Returns:
- 0 if success -1 if error.
| int CSonarController::GetVals |
( |
int |
vals[] |
) |
|
Get the most recent sonar distance values in inches.
- Parameters:
-
| vals | the int array where the sonar distance values will be copied. |
- Returns:
- 0 if success, -1 if error.
| int CSonarController::SetFiring |
( |
unsigned int |
numSonar, |
|
|
CSonar * |
sonarArray[], |
|
|
unsigned int |
fireIntervalMs | |
|
) |
| | |
This method takes the necessary arguments to set up a working sonar array.
- Parameters:
-
| numSonar | the number of sonars in the sonar array. |
| sonarArray | an array of pointers to CSonar instantiations. The order of the CSonar pointers determines the firing order of the sonar array. |
| fireIntervalMs | the amount of time in milliseconds to wait between subsequent sonar firings. This value should not be below 10 ms. |
- Returns:
- 0 if success -1 if error.
The documentation for this class was generated from the following files:
