Aria  2.8.0
Important Classes

These classes are essential far all programs using Aria to control a robot. More...

Classes

class  ArArgumentBuilder
 This class is to build arguments for things that require argc and argv. More...
 
class  ArArgumentParser
 Parse and store program command-line arguments for use by other ARIA classes. More...
 
class  ArFunctor
 An object which allows storing a generalized reference to a method with an object instance to call later (used for callback functions) More...
 
class  Aria
 Contains global initialization, deinitialization and other global functions. More...
 
class  ArLaser
 Range device interface specialized for laser rangefinder sensors. More...
 
class  ArLaserConnector
 Create laser interface objects (for any kind of laser supported by ARIA) and connect to lasers based on parameters from robot parameter file and command-line arguments. More...
 
class  ArLog
 Logging utility class. More...
 
class  ArRangeDevice
 The base class for all sensing devices which return range information from the device (mounted on a robot) to an object in the environment. More...
 
class  ArRobot
 Central class for communicating with and operating the robot. More...
 
class  ArRobotConnector
 Connect to robot or simulator based on program command line parameters. More...
 
class  ArSonarDevice
 Keep track of recent sonar readings from a robot as an ArRangeDevice. More...
 
class  ArUtil
 Contains various utility functions, including cross-platform wrappers around common system functions. More...
 
class  ArLaserConnector::LaserData
 Class that holds information about the laser data. More...
 

Enumerations

enum  ArArgumentBuilder::ArgSeparatorType { SPACE = 1, SPECIAL = SPACE << 1, ANY_SPACE = SPACE | SPECIAL, QUOTE = SPECIAL << 1 }
 Characters that may be used to separate arguments; bitwise flags so QUOTE can be combined with spaces.
 
enum  ArUtil::BITS {
  ArUtil::BIT0 = 0x1, ArUtil::BIT1 = 0x2, ArUtil::BIT2 = 0x4, ArUtil::BIT3 = 0x8,
  ArUtil::BIT4 = 0x10, ArUtil::BIT5 = 0x20, ArUtil::BIT6 = 0x40, ArUtil::BIT7 = 0x80,
  ArUtil::BIT8 = 0x100, ArUtil::BIT9 = 0x200, ArUtil::BIT10 = 0x400, ArUtil::BIT11 = 0x800,
  ArUtil::BIT12 = 0x1000, ArUtil::BIT13 = 0x2000, ArUtil::BIT14 = 0x4000, ArUtil::BIT15 = 0x8000
}
 Values for the bits from 0 to 16. More...
 
enum  ArLog::LogLevel { ArLog::Terse, ArLog::Normal, ArLog::Verbose }
 
enum  ArLog::LogType {
  ArLog::StdOut, ArLog::StdErr, ArLog::File, ArLog::Colbert,
  ArLog::None
}
 
enum  ArUtil::REGKEY {
  ArUtil::REGKEY_CLASSES_ROOT, ArUtil::REGKEY_CURRENT_CONFIG, ArUtil::REGKEY_CURRENT_USER, ArUtil::REGKEY_LOCAL_MACHINE,
  ArUtil::REGKEY_USERS
}
 These are for passing into getStringFromRegistry. More...
 
enum  Aria::SigHandleMethod { Aria::SIGHANDLE_SINGLE, Aria::SIGHANDLE_THREAD, Aria::SIGHANDLE_NONE }
 

Detailed Description

These classes are essential far all programs using Aria to control a robot.

Enumeration Type Documentation

Values for the bits from 0 to 16.

Enumerator
BIT0 

value of BIT0

BIT1 

value of BIT1

BIT2 

value of BIT2

BIT3 

value of BIT3

BIT4 

value of BIT4

BIT5 

value of BIT5

BIT6 

value of BIT6

BIT7 

value of BIT7

BIT8 

value of BIT8

BIT9 

value of BIT9

BIT10 

value of BIT10

BIT11 

value of BIT11

BIT12 

value of BIT12

BIT13 

value of BIT13

BIT14 

value of BIT14

BIT15 

value of BIT15

Enumerator
Terse 

Use terse logging.

Normal 

Use normal logging.

Verbose 

Use verbose logging.

Enumerator
StdOut 

Use stdout for logging.

StdErr 

Use stderr for logging.

File 

Use a file for logging.

Colbert 

Use a Colbert stream for logging.

None 

Disable logging.

These are for passing into getStringFromRegistry.

Enumerator
REGKEY_CLASSES_ROOT 

use HKEY_CLASSES_ROOT

REGKEY_CURRENT_CONFIG 

use HKEY_CURRENT_CONFIG

REGKEY_CURRENT_USER 

use HKEY_CURRENT_USER

REGKEY_LOCAL_MACHINE 

use HKEY_LOCAL_MACHINE

REGKEY_USERS 

use HKEY_USERS

Enumerator
SIGHANDLE_SINGLE 

Setup signal handlers in a global, non-thread way.

SIGHANDLE_THREAD 

Setup a dedicated signal handling thread.

SIGHANDLE_NONE 

Do no signal handling.