Aria  2.8.0
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
oCAr3DPointBase class for points in 3 dimensional cartesian space
oCArActionBase class for actions
oCArActionAvoidFrontThis action does obstacle avoidance, controlling both trans and rot
oCArActionAvoidSideAction to avoid impacts by firening into walls at a shallow angle
oCArActionBumpersAction to deal with if the bumpers trigger
oCArActionColorFollowArActionColorFollow is an action that moves the robot toward the largest ACTS blob that appears in it's current field of view
oCArActionConstantVelocityAction for going straight at a constant velocity
oCArActionDeceleratingLimiterAction to limit the forwards motion of the robot based on range sensor readings
oCArActionDesiredContains values returned by ArAction objects expressing desired motion commands to resolver
oCArActionDesiredChannelClass used by ArActionDesired for each channel, internal
oCArActionDriveDistanceThis action goes to a given ArPose very naively
oCArActionGotoThis action goes to a given ArPose very naively
oCArActionGotoStraightThis action goes to a given ArPose very naively
oCArActionGroupGroup a set of ArAction objects together
oCArActionGroupColorFollowFollows a blob of color
oCArActionGroupInputAction group to use to drive the robot with input actions (keyboard, joystick, etc.)
oCArActionGroupRatioDriveUse keyboard and joystick input to to drive the robot, with Limiter actions to avoid obstacles
oCArActionGroupRatioDriveUnsafeUse keyboard and joystick input to to drive the robot, but without Limiter actions to avoid obstacles
oCArActionGroupStopAction group to stop the robot
oCArActionGroupTeleopAction group to teleopoperate the robot using ArActionJoydrive, and the Limiter actions to avoid collisions
oCArActionGroupUnguardedTeleopAction group to teleoperate the robot using ArActionJoydrive, but without any Limiter actions to avoid collisions
oCArActionGroupWanderAction group to make the robot wander, avoiding obstacles
oCArActionInputAction for taking input from outside to control the robot
oCArActionIRsAction to back up if short-range IR sensors trigger
oCArActionJoydriveThis action will use the joystick for input to drive the robot
oCArActionKeydriveThis action will use the keyboard arrow keys for input to drive the robot
oCArActionLimiterBackwardsAction to limit the backwards motion of the robot based on range sensor readings
oCArActionLimiterForwardsAction to limit the forwards motion of the robot based on range sensor readings
oCArActionLimiterRotAction to limit the forwards motion of the robot based on range sensor readings
oCArActionLimiterTableSensorAction to limit speed (and stop) based on whether the "table"-sensors see anything
oCArActionMovementParametersThis is a class for setting max velocities and accels and decels via ArConfig parameters (see addToConfig()) or manually (using setParameters())
oCArActionMovementParametersDebuggingThis is a class for setting max velocities and accels and decels via ArConfig parameters (see addToConfig());
oCArActionRatioInputAction that requests motion based on abstract ratios provided by diferent input sources
oCArActionRobotJoydriveThis action will use the joystick for input to drive the robot
oCArActionStallRecoverAction to recover from a stall
oCArActionStopAction for stopping the robot
oCArActionTriangleDriveToAction to drive up to a triangle target (e.g. docking station) found from an ArLineFinder
oCArActionTurnAction to turn when the behaviors with more priority have limited the speed
oCArACTS_1_2Communicate with ACTS
oCArACTSBlobA class for the acts blob
oCArAMPTUDriver for the AMPTU
oCArAMPTUCommandsA class with the commands for the AMPTU
oCArAMPTUPacketA class for for making commands to send to the AMPTU
oCArAnalogGyroUse onboard gyro to improve the heading in an ArRobot object's pose value
oCArArgArgument class, mostly for actions, could be used for other things
oCArArgumentBuilderThis class is to build arguments for things that require argc and argv
oCArArgumentBuilderCompareOpComparator that returns true if arg1's full string is less than arg2's
oCArArgumentParserParse and store program command-line arguments for use by other ARIA classes
oCArASyncTaskAsynchronous task (runs in its own thread)
oCArBasePacketBase packet class
oCArBatteryConnectorConnect to robot and battery based on run-time availablitily and command-line arguments
oCArBatteryMTX
oCArBumpersA class that treats the robot's bumpers as a range device
oCArCallbackListA class to hold a list of callbacks to call sequentially
oCArCallbackList1A class to hold a list of callbacks to call with an argument of type P1 The functors added to the list must be pointers to a subclass of ArFunctor1<P1>
oCArCameraCollectionMaintains information about all of the robot's cameras
oCArCameraCollectionItemInterface for items that add information to the camera collection
oCArCameraCommandsCommands that are supported by the camera (ArPTZ) and video classes
oCArCameraParameterSourceInterface for collection items that also access the camera's parameters
oCArColorA class for holding color information for ArDrawingData
oCArCommandsA class containing names for most robot microcontroller system commands
oCArCompassConnectorUse this class to create an instance of a TCM2 subclass and connect to the device based on program command line options
oCArConditionThreading condition wrapper class
oCArConfigStores configuration information which may be read to and from files or other sources
oCArConfigArgArgument class for ArConfig
oCArConfigGroupContainer for holding a group of ArConfigs
oCArConfigSectionRepresents a section in the configuration
oCArConstFunctor1CFunctor for a const member function with 1 parameter
oCArConstFunctor2CFunctor for a const member function with 2 parameters
oCArConstFunctor3CFunctor for a const member function with 3 parameters
oCArConstFunctor4CFunctor for a const member function with 4 parameters
oCArConstFunctor5CFunctor for a const member function with 5 parameters
oCArConstFunctorCSwig doesn't like the const functors
oCArConstRetFunctor1CFunctor for a const member function with return value and 1 parameter
oCArConstRetFunctor2CFunctor for a const member function with return value and 2 parameters
oCArConstRetFunctor3CFunctor for a const member function with return value and 3 parameters
oCArConstRetFunctor4CFunctor for a const member function with return value and 4 parameters
oCArConstRetFunctor5CFunctor for a const member function with return value and 5 parameters
oCArConstRetFunctorCFunctor for a const member function with return value
oCArDaemonizerSwitch to running the program as a background daemon (i.e
oCArDataLoggerThis class will log data, but you have to use it through an ArConfig right now
oCArDataTagCaseCmpOpComparator used to sort scan data types in a case-insensitive manner
oCArDeviceConnectionBase class for device connections
oCArDPPTUDriver for the DPPTU
oCArDPPTUCommandsInterface to Directed Perception pan/tilt unit, imprementing the ArPTZ interface
oCArDPPTUPacketA class for for making commands to send to the DPPTU
oCArDrawingDataDescribes general properties of a figure to be drawn on screen
oCArECEFCoordsEarth Centered Earth Fixed Coordinates
oCArENUCoordsEast North Up coordinates
oCArExitErrorSourceSmall interface for obtaining exit-on-error information
oCArFileParserClass for parsing files more easily
oCArForbiddenRangeDeviceClass that takes forbidden lines and turns them into range readings
oCArFunctorAn object which allows storing a generalized reference to a method with an object instance to call later (used for callback functions)
oCArFunctor1Base class for functors with 1 parameter
oCArFunctor1CFunctor for a member function with 1 parameter
oCArFunctor2Base class for functors with 2 parameters
oCArFunctor2CFunctor for a member function with 2 parameters
oCArFunctor3Base class for functors with 3 parameters
oCArFunctor3CFunctor for a member function with 3 parameters
oCArFunctor4Base class for functors with 4 parameters
oCArFunctor4CFunctor for a member function with 4 parameters
oCArFunctor5Base class for functors with 5 parameters
oCArFunctor5CFunctor for a member function with 5 parameters
oCArFunctorASyncTaskThis is like ArASyncTask, but instead of runThread it uses a functor to run
oCArFunctorCFunctor for a member function
oCArGenericCallbackListA class to hold a list of callbacks to call GenericFunctor must be a pointer to an ArFunctor or subclass
oCArGlobalFunctorFunctor for a global function with no parameters
oCArGlobalFunctor1Functor for a global function with 1 parameter
oCArGlobalFunctor2Functor for a global function with 2 parameters
oCArGlobalFunctor3Functor for a global function with 3 parameters
oCArGlobalFunctor4Functor for a global function with 4 parameters
oCArGlobalFunctor5Functor for a global function with 5 parameters
oCArGlobalRetFunctorFunctor for a global function with return value
oCArGlobalRetFunctor1Functor for a global function with 1 parameter and return value
oCArGlobalRetFunctor2Functor for a global function with 2 parameters and return value
oCArGlobalRetFunctor3Functor for a global function with 2 parameters and return value
oCArGlobalRetFunctor4Functor for a global function with 4 parameters and return value
oCArGlobalRetFunctor5Functor for a global function with 5 parameters and return value
oCArGPSGPS Device Interface
oCArGPSConnectorFactory for creating GPS interface object (for any kind of GPS supported by ARIA) based on robot parameter file and command-line arguments
oCArGripperProvides an interface to the Pioneer gripper device
oCArGripperCommandsContains gripper command numbers
oCArHasFileNameInterface to access an object's associated file name
oCAriaContains global initialization, deinitialization and other global functions
oCArInterpolationThis class takes care of storing in readings of position vs time, and then interpolating between them to find where the robot was at a particular point in time
oCArIrrfDeviceA class for connecting to a PB-9 and managing the resulting data
oCArIRsA class that treats a robot's infrared sensors as a range device
oCArJoyHandlerInterfaces to a computer joystick
oCArKeyHandlerPerform actions when keyboard keys are pressed
oCArLaserRange device interface specialized for laser rangefinder sensors
oCArLaserConnectorCreate 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
oCArLaserFilterRange device with data obtained from another range device and filtered
oCArLaserLoggerThis class can be used to create log files for the laser mapper
oCArLaserReflectorDeviceA class for keeping track of laser reflectors that we see right now
oCArLCDConnectorConnect to robot and lcd based on run-time availablitily and command-line arguments
oCArLCDMTXInterface to LCD interface panel on an MTX-type robot
oCArLineRepresents geometry of a line in two-dimensional space
oCArLineFinderThis class finds lines out of any range device with raw readings (lasers for instance)
oCArLineFinderSegmentClass for ArLineFinder to hold more info than an ArLineSegment
oCArLineSegmentRepresents a line segment in two-dimensional space
oCArLineSegmentCmpOpArLineSegment less than comparison for sets
oCArListPosHas enum for position in list
oCArLLACoordsLatitude, Longitude and Altitude Coordinates
oCArLMS1XX
oCArLMS1XXPacketReceiverGiven a device connection it receives packets from the sick through it
oCArLMS2xxInterface to a SICK LMS-200 laser range device
oCArLMS2xxPacketRepresents the packets sent to the LMS2xx as well as those received from it
oCArLMS2xxPacketReceiverGiven a device connection it receives packets from the sick through it
oCArLogLogging utility class
oCArLogFileConnectionFor connecting through a log file
oCArMapA map of a two-dimensional space the robot can navigate within, and which can be updated via the Aria config
oCArMapChangeDetailsHelper class used to track changes to an Aria map
oCArMapChangedHelperHelper class that stores and invokes the map changed callbacks
oCArMapFileLineEncapsulates the data regarding a text line in a map file
oCArMapFileLineCompareComparator used to sort ArMapFileLine objects
oCArMapFileLineGroupA group of map file lines which have a logical parent / child relationship
oCArMapFileLineGroupCompareComparator used to sort groups in order of ascending parent text
oCArMapFileLineGroupLineNumCompareComparator used to sort groups in order of ascending parent line number
oCArMapFileLineSetA set of map file line groups
oCArMapFileLineSetWriterFunctor that populates a specified ArMapFileLineSet
oCArMapGPSCoordsCoordinates based on a map with origin in LLA coords with conversion methods from LLA to ENU and from ENU to LLA coordinates
oCArMapIdEnapsulates the data used to uniquely identify an Aria map
oCArMapInfoA container for the various "info" tags in an Aria map
oCArMapInfoInterfaceMethods related to setting and retrieving the various "info" tags in an Aria map
oCArMapInterfaceArMapInterface defines the methods that are available on all Aria maps
oCArMapObjectA point or region of interest in an Aria map
oCArMapObjectCompareComparator for two pointers to map objects
oCArMapObjectsThe collection of map objects that are contained in an Aria map
oCArMapObjectsInterfaceMethods related to setting and retrieving the objects in an Aria map
oCArMapScanThe map data related to the sensable obstacles in the environment
oCArMapScanInterfaceMethods related to setting and retrieving the scan-related data in an Aria map
oCArMapSimpleSimple map that can be read from and written to a file
oCArMapSupplementSupplemental data associated with an Aria map
oCArMapSupplementInterfaceMethods related to miscellaneous extra data in an Aria map
oCArMathCommon math operations
oCArMD5CalculatorCalculates the MD5 checksum when reading or writing a text file using ArFunctors
oCArModeA class for different modes, mostly as related to keyboard input
oCArModeActsMode for following a color blob using ACTS
oCArModeCameraMode for controlling the camera
oCArModeConfigMode for requesting config packet
oCArModeGripperMode for controlling the gripper
oCArModeSonarMode for displaying the sonar
oCArModeTCM2Mode for following a color blob using ACTS
oCArModeTeleopMode for teleoping the robot with joystick + keyboard
oCArModeUnguardedTeleopMode for teleoping the robot with joystick + keyboard
oCArModeWanderMode for wandering around
oCArModuleDynamicly loaded module base class, read warning in more
oCArModuleLoaderDynamic ArModule loader
oCArMTXIOInterface to digital and analog I/O and switched power outputs on MTX core (used in Pioneer LX and other MTX-based robots)
oCArMutexCross-platform mutex wrapper class
oCArNetServerClass for running a simple net server to send/recv commands via text
oCArNMEAParserNMEA Parser
oCArNovatelGPSGPS subclass to support the NovAtel ProPak G2 and other NovAtel "OEM4" devices
oCArNovatelSPANGPS subclass to support the NovAtel SPAN GPS with integrated IMU
oCArP2ArmArP2Arm is the interface to the AROS/P2OS-based Pioneer 2 Arm servers, by means of which the robot microcontroller firmware can control the original 5-DOF Pioneer 2 Arm manipulator
oCArPixelDeviceHolds data from a sensor that provides data arranged in a 2d array
oCArPoseRepresents an x, y position with an orientation
oCArPoseCmpOpArPose less than comparison for sets
oCArPoseUtilClass for finding robot bounds from the basic measurements
oCArPoseWithTimeA subclass of ArPose that also stores a timestamp (ArTime)
oCArPriorityContains enumeration of four user-oriented priority levels (used primarily by ArConfig)
oCArPriorityResolver(Default resolver), takes the action list and uses the priority to resolve
oCArPTZBase class which handles the PTZ cameras
oCArPTZConnectorFactory for creating and configuring interfaces for pan/tilt units or camera pan/tilt/zoom control based on robot parameter file and command-line arguments
oCArPTZParamsStores a set of PTZ/PTU device parameters read from one of the PTZ sections of a robot parameter file
oCArRangeBufferThis class is a buffer that holds ranging information
oCArRangeDeviceThe base class for all sensing devices which return range information from the device (mounted on a robot) to an object in the environment
oCArRangeDeviceThreadedA range device which can run in its own thread
oCArRatioInputJoydriveUse computer joystick to control an ArActionRatioInput and drive the robot
oCArRatioInputKeydriveThis will use the keyboard arrow keys and the ArActionRatioInput to drive the robot
oCArRatioInputRobotJoydriveUse robot's joystick to control an ArActionRatioInput action and drive the robot
oCArRecurrentTaskRecurrent task (runs in its own thread)
oCArResolverResolves a list of actions and returns what to do
oCArRetFunctorBase class for functors with a return value
oCArRetFunctor1Base class for functors with a return value with 1 parameter
oCArRetFunctor1CFunctor for a member function with return value and 1 parameter
oCArRetFunctor2Base class for functors with a return value with 2 parameters
oCArRetFunctor2CFunctor for a member function with return value and 2 parameters
oCArRetFunctor3Base class for functors with a return value with 3 parameters
oCArRetFunctor3CFunctor for a member function with return value and 3 parameters
oCArRetFunctor4Base class for functors with a return value with 4 parameters
oCArRetFunctor4CFunctor for a member function with return value and 4 parameters
oCArRetFunctor5Base class for functors with a return value with 5 parameters
oCArRetFunctor5CFunctor for a member function with return value and 5 parameters
oCArRetFunctorCFunctor for a member function with return value
oCArRingQueueAn expanding ring queue
oCArRobotCentral class for communicating with and operating the robot
oCArRobotBatteryPacketReaderThis class will read a config packet from the robot
oCArRobotConfigClass for controlling robot movement parameters from config
oCArRobotConfigPacketReaderThis class will read a config packet from the robot
oCArRobotConnectorConnect to robot or simulator based on program command line parameters
oCArRobotJoyHandlerInterfaces to a joystick on the robot's microcontroller
oCArRobotPacketRepresents the packets sent to the robot as well as those received from it
oCArRobotPacketReceiverGiven a device connection it receives packets from the robot through it
oCArRobotPacketSenderGiven a device connection this sends commands through it to the robot
oCArRobotParamsStores parameters read from the robot's parameter files
oCArRootMeanSquareCalculatorThis is a class for computing a root mean square average of a number of elements
oCArRunningAverageUse for computing a running average of a number of elements
oCArRVisionPacketA class for for making commands to send to the RVision camera
oCArRVisionPTZControl the RVision camera pan tilt zoom unit
oCArS3Series
oCArS3SeriesPacketReceiverGiven a device connection it receives packets from the sick through it
oCArSectorsA class for keeping track of if a complete revolution has been attained
oCArSensorReadingA class to hold a sensor reading, should be one instance per sensor
oCArSerialConnectionUtility for connecting to and communicating with devices through a serial port
oCArSickCompatability class used to access SICK LMS-200 laser rangefinder device in versions of ARIA prior to 2.7.0; used alone or with ArSimpleConnector (also deprecated)
oCArSignalHandlerSignal handling class
oCArSimpleConnectorLegacy connector for robot and laser
oCArSimulatedGPS
oCArSimulatedLaserThis class is a subclass of ArRangeDeviceThreaded meant for any planar scanning lasers, like the SICK lasers, Hokoyo URG series lasers, etc
oCArSocketSocket communication wrapper
oCArSonarConnectorConnect to sonar based on robot parameters and command-line arguments
oCArSonarDeviceKeep track of recent sonar readings from a robot as an ArRangeDevice
oCArSonarMTXReceives sonar data from an MTX robot Use ArSonarConnector to establish the connection and create and initiate the ArSonarMTX thread
oCArSonyPacketA class for for making commands to send to the sony
oCArSonyPTZA class to use the sony pan tilt zoom unit
oCArSoundPlayerThis class provides a cross-platform interface for playing short sound samples
oCArSoundsQueueThis class manages a queue of items to play as WAV files or as text to speak using a speech synthesizer
oCArSpeechSynthAbstract interface to speech synthesis
oCArStrCaseCmpOpStrcasecmp for sets
oCArStringInfoGroupThis class takes callbacks from different classes that want this string information and then lets you just add the information here instead of to each individual class
oCArStringInfoHolderHolds information about ArStringInfo component strings (it's a helper class for other things)
oCArStringInfoHolderFunctionsThis class just holds some helper functions for the ArStringInfoHolder
oCArSyncTaskClass used internally to manage the tasks that are called every cycle
oCArSystemStatusUtility to get statistics about the host operating system (CPU usage, wireless link data, etc)
oCArSZSeries
oCArSZSeriesPacketReceiverGiven a device connection it receives packets from the sick through it
oCArTaskStateClass with the different states a task can be in
oCArTCM2Interface to the PNI TCM 2, TCM 2.5, and TCM 2.6 3-axis compass (magnetometer) that can sense absolute heading, as well as pitch, roll, and includes a temperature sensor
oCArTCMCompassDirectTalk to a compass directly over a computer serial port
oCArTCMCompassRobotInterface to a TCM 2/2.5/2.6 3-axis compass through the robot microcontroller
oCArTcpConnectionFor connecting to a device through a TCP network socket
oCArThreadPOSIX/WIN32 thread wrapper class
oCArTimeA class for time readings and measuring durations
oCArTransformPerform transforms between different coordinates
oCArTrimbleGPSGPS subclass to support the Trimble AgGPS and other Trimble GPS devices
oCArTypesContains platform independent sized variable types
oCArUrgHokuyo Urg laser range device
oCArUrg_2_0Hokuyo URG laser range device (SCIP 2.0)
oCArUtilContains various utility functions, including cross-platform wrappers around common system functions
oCArVCC4Control the pan, tilt, and zoom mechanisms of the Canon VC-C4 and VC-C50i cameras
oCArVCC4CommandsUsed by the ArVCC4 class
oCArVCC4PacketUsed by ArVCC4 to construct command packets
oCArVersalogicIOInterface to integrated digital and analog I/O interfaces on Versalogic VSBC8 and EBX-12 Cobra computers (digital IO on 2nd * gen
oCArVideoParamsStores a set of video device parameters read from one of the video sections of a robot parameter file
oCArWGS84All the constants defined by the World Geodetic System 1984
oCArZippableInterface to access and modify a specified zip file
\CP2ArmJointP2 Arm joint info