/usr/include/Aria/ArSonarConnector.h is in libaria-dev 2.8.0+repack-1.2ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 | /*
Adept MobileRobots Robotics Interface for Applications (ARIA)
Copyright (C) 2004, 2005 ActivMedia Robotics LLC
Copyright (C) 2006, 2007, 2008, 2009, 2010 MobileRobots Inc.
Copyright (C) 2011, 2012, 2013 Adept Technology
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
If you wish to redistribute ARIA under different terms, contact
Adept MobileRobots for information about a commercial version of ARIA at
robots@mobilerobots.com or
Adept MobileRobots, 10 Columbia Drive, Amherst, NH 03031; +1-603-881-7960
*/
#ifndef ARSONARCONNECTOR_H
#define ARSONARCONNECTOR_H
#include "ariaTypedefs.h"
#include "ArSerialConnection.h"
#include "ArTcpConnection.h"
#include "ArArgumentBuilder.h"
#include "ArArgumentParser.h"
#include "ariaUtil.h"
#include "ArRobotConnector.h"
class ArSonarMTX;
class ArRobot;
/// Connect to sonar based on robot parameters and command-line arguments
/**
ArSonarConnector makes a sonar connection either through a serial port
connection.
When you create your ArSonarConnector, pass it command line parameters via
either the argc and argv variables from main(), or pass it an
ArArgumentBuilder or ArArgumentParser object. (ArArgumentBuilder
is able to obtain command line parameters from a Windows program
that uses WinMain() instead of main()).
ArSonarConnector registers a callback with the global Aria class. Use
Aria::parseArgs() to parse all command line parameters to the program, and
Aria::logOptions() to print out information about all registered command-line parameters.
The following command-line arguments are checked:
@verbinclude ArSonarConnector_options
To connect to any sonars that were set up in the robot parameter file or
via command line arguments, call connectSonars(). If successful,
connectSonars() will return true and add an entry for each sonar connected
in the ArRobot object's list of sonars. These ArSonarMTX objects can be
accessed from your ArRobot object via ArRobot::findSonar() or ArRobot::getSonarMap().
@since 2.8.0
**/
class ArSonarConnector
{
public:
/// Constructor that takes argument parser
AREXPORT ArSonarConnector(
ArArgumentParser *parser,
ArRobot *robot, ArRobotConnector *robotConnector,
bool autoParseArgs = true,
ArLog::LogLevel infoLogLevel = ArLog::Verbose,
ArRetFunctor1<bool, const char *> *turnOnPowerOutputCB = NULL,
ArRetFunctor1<bool, const char *> *turnOffPowerOutputCB = NULL);
/// Destructor
AREXPORT ~ArSonarConnector(void);
/// Connects all the sonars the robot has that should be auto connected
AREXPORT bool connectSonars(
bool continueOnFailedConnect = false,
bool addConnectedSonarsToRobot = true,
bool addAllSonarsToRobot = false,
bool turnOnSonars = true,
bool powerCycleSonarOnFailedConnect = true);
// Connects all the sonars in replay mode
AREXPORT bool connectReplaySonars(
bool continueOnFailedConnect = false,
bool addConnectedSonarsToRobot = true,
bool addAllSonarsToRobot = false,
bool turnOnSonars = true,
bool powerCycleSonarOnFailedConnect = true);
/// Sets up a sonar to be connected
AREXPORT bool setupSonar(ArSonarMTX *sonar,
int sonarNumber = 1);
/// Connects the sonar synchronously (will take up to a minute)
AREXPORT bool connectSonar(ArSonarMTX *sonar,
int sonarNumber = 1,
bool forceConnection = true);
/// Adds a sonar so parsing will get it
AREXPORT bool addSonar(ArSonarMTX *sonar,
int sonarNumber = 1);
/// Function to parse the arguments given in the constructor
AREXPORT bool parseArgs(void);
/// Function to parse the arguments given in an arbitrary parser
AREXPORT bool parseArgs(ArArgumentParser *parser);
/// Log the options the simple connector has
AREXPORT void logOptions(void) const;
/// Internal function to get the sonar (only useful between parseArgs and connectSonars)
AREXPORT ArSonarMTX *getSonar(int sonarNumber);
/// Internal function to replace the sonar (only useful between parseArgs and connectSonars) but not the sonar data
AREXPORT bool replaceSonar(ArSonarMTX *sonar, int sonarNumber);
protected:
/// Class that holds information about the sonar data
class SonarData
{
public:
SonarData (int number, ArSonarMTX *sonar) {
myNumber = number;
mySonar = sonar;
myConn = NULL;
myConnect = false; myConnectReallySet = false;
myPort = NULL;
myPortType = NULL;
myType = NULL;
myRemoteTcpPort = 0; myRemoteTcpPortReallySet = false;
myBaud = NULL;
myAutoConn = NULL;
}
virtual ~SonarData() {}
/// The number of this sonar
int myNumber;
/// The actual pointer to this sonar
ArSonarMTX *mySonar;
// our connection
ArDeviceConnection *myConn;
// if we want to connect the sonar
bool myConnect;
// if myConnect was really set
bool myConnectReallySet;
// the port we want to connect the sonar on
const char *myPort;
// the type of port we want to connect to the sonar on
const char *myPortType;
// sonar Type
const char *myType;
// wheather to auto conn
const char *myAutoConn;
// sonar tcp port if we're doing a remote host
int myRemoteTcpPort;
// if our remote sonar tcp port was really set
bool myRemoteTcpPortReallySet;
/// the baud we want to use
const char *myBaud;
};
/// Turns on the power for the specific board in the firmware
AREXPORT bool turnOnPower(SonarData *sonarData);
std::map<int, SonarData *> mySonars;
/// Parses the sonar arguments
AREXPORT bool parseSonarArgs(ArArgumentParser *parser,
SonarData *sonarData);
/// Logs the sonar command line option help text.
AREXPORT void logSonarOptions(SonarData *sonardata, bool header = true, bool metaOpts = true) const;
// Sets the sonar parameters
bool internalConfigureSonar(SonarData *sonarData);
std::string mySonarTypes;
// our parser
ArArgumentParser *myParser;
bool myOwnParser;
// if we should autoparse args or toss errors
bool myAutoParseArgs;
bool myParsedArgs;
ArRobot *myRobot;
ArRobotConnector *myRobotConnector;
// variables to hold if we're logging or not
bool mySonarLogPacketsReceived;
bool mySonarLogPacketsSent;
ArLog::LogLevel myInfoLogLevel;
ArRetFunctor1<bool, const char *> *myTurnOnPowerOutputCB;
ArRetFunctor1<bool, const char *> *myTurnOffPowerOutputCB;
ArRetFunctorC<bool, ArSonarConnector> myParseArgsCB;
ArConstFunctorC<ArSonarConnector> myLogOptionsCB;
};
#endif // ARLASERCONNECTOR_H
|