Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
_playerc_client_tClient object data
_playerc_device_tCommon device info
ConfigFileClass for loading configuration file information
DeviceEncapsulates a device (i.e., a driver bound to an interface)
DriverBase class for all drivers
MessageReference-counted message objects
MessageQueueA doubly-linked queue of messages
MessageQueueElementThis class is a helper for maintaining doubly-linked queues of Messages
MessageReplaceRuleWe keep a singly-linked list of (addr,type,subtype,replace) tuples
player_actarray_actuatorStructure containing a single actuator's information
player_actarray_actuatorgeomActuator geometry
player_actarray_brakes_configRequest/reply: Brakes
player_actarray_dataData: state (PLAYER_ACTARRAY_DATA_STATE)
player_actarray_geomRequest/reply: get geometry
player_actarray_home_cmdCommand: Joint home (PLAYER_ACTARRAY_HOME_CMD)
player_actarray_position_cmdCommand: Joint position control (PLAYER_ACTARRAY_POS_CMD)
player_actarray_power_configRequest/reply: Power
player_actarray_speed_cmdCommand: Joint speed control (PLAYER_ACTARRAY_SPEED_CMD)
player_actarray_speed_configRequest/reply: Speed
player_add_replace_rule_reqConfiguration request: Add client queue replace rule
player_aio_cmdCommand: state (PLAYER_AIO_CMD_STATE)
player_aio_dataData: state (PLAYER_AIO_DATA_STATE)
player_audio_cmdCommand: tone to emit
player_audio_dataData: tones detected
player_audiodsp_cmdCommand: tone / chirp to play
player_audiodsp_configRequest/reply : Get/set audio properties
player_audiodsp_dataData: detected tones (PLAYER_AUDIODSP_DATA_TONES)
player_audiomixer_cmdCommand: set level
player_audiomixer_configRequest/reply: Get levels
player_bboxA rectangular bounding box, used to define the size of an object
player_bbox3dA rectangular bounding box, used to define the size of an object
player_blinkenlight_cmdCommand: state (PLAYER_BLINKENLIGHT_CMD_STATE) This blinkenlight command sets the complete current state of the indicator light
player_blinkenlight_cmd_colorCommand: color (PLAYER_BLINKENLIGHT_CMD_COLOR) This blinkenlight command sets the color of the light
player_blinkenlight_cmd_dutycycleCommand: dutycycle (PLAYER_BLINKENLIGHT_CMD_DUTYCYCLE) This blinkenlight command sets the ratio of light-on to light-off time in one on/off blink cycle
player_blinkenlight_cmd_periodCommand: period (PLAYER_BLINKENLIGHT_CMD_PERIOD) This blinkenlight command sets the duration of one on/off blink cycle in seconds
player_blinkenlight_cmd_powerCommand: power (PLAYER_BLINKENLIGHT_CMD_POWER) This blinkenlight command turns the light on or off
player_blinkenlight_dataData: state (PLAYER_BLINKENLIGHT_DATA_STATE) The blinkenlight data provides the current state of the indicator light
player_blobfinder_blobStructure describing a single blob
player_blobfinder_color_configRequest/reply: Set tracking color
player_blobfinder_dataData: detected blobs (PLAYER_BLOBFINDER_DATA_BLOBS)
player_blobfinder_imager_configConfiguration request: Set imager params
player_boolA boolean variable, 0 for false anything else for true
player_bumper_dataData: state (PLAYER_BUMPER_DATA_GEOM)
player_bumper_defineThe geometry of a single bumper
player_bumper_geomData AND Request/reply: bumper geometry
player_camera_dataData: state (PLAYER_CAMERA_DATA_STATE)
player_colorA color descriptor
player_devaddrA device address
player_device_auth_reqConfiguration request: Authentication
player_device_data_reqConfiguration request: Get data
player_device_datamode_reqConfiguration request: Change data delivery mode
player_device_devlistRequest/reply: Get the list of available devices
player_device_driverinfoRequest/reply: Get the driver name for a particular device
player_device_nameservice_reqNameservice request
player_device_reqRequest/reply: (un)subscribe to a device
player_dio_cmdCommand: output values (PLAYER_DIO_CMD_VALUES)
player_dio_dataData: input values (PLAYER_DIO_DATA_VALUES)
player_energy_chargepolicy_configRequest/reply: set charging policy
player_energy_dataData: state (PLAYER_ENERGY_DATA_STATE)
player_fiducial_dataData: detected fiducials (PLAYER_FIDUCIAL_DATA_SCAN)
player_fiducial_fovRequest/reply: Get/set sensor field of view
player_fiducial_geomRequest/reply: Get geometry
player_fiducial_idRequest/reply: Get/set fiducial ID
player_fiducial_itemInfo on a single detected fiducial
player_gps_dataData: state (PLAYER_GPS_DATA_STATE)
player_graphics2d_cmd_pointsData: This interface produces no data
player_graphics2d_cmd_polygonCommand: Draw polygon (PLAYER_GRAPHICS2D_CMD_POLYGON) Draw a polygon
player_graphics2d_cmd_polylineCommand: Draw polyline (PLAYER_GRAPHICS2D_CMD_POLYLINE) Draw a series of straight line segments between a set of points
player_graphics3d_cmd_drawData: This interface produces no data
player_gripper_cmdCommand: state (PLAYER_GRIPPER_CMD_STATE)
player_gripper_dataData: state (PLAYER_GRIPPER_DATA_STATE)
player_gripper_geomRequest/reply: get geometry
player_ir_dataData: ranges (PLAYER_IR_DATA_RANGES)
player_ir_poseRequest/reply: get pose
player_ir_power_reqRequest/reply: set power
player_joystick_dataData: state (PLAYER_JOYSTICK_DATA_STATE)
player_laser_configRequest/reply: Get/set scan properties
player_laser_dataData: scan (PLAYER_LASER_DATA_SCAN)
player_laser_data_scanposeData: pose-stamped scan (PLAYER_LASER_DATA_SCANPOSE)
player_laser_geomRequest/reply: Get geometry
player_laser_power_configRequest/reply: Turn power on/off
player_limb_brakes_reqRequest/reply: Brakes
player_limb_dataData: state (PLAYER_LIMB_DATA)
player_limb_geom_reqRequest/reply: get geometry
player_limb_home_cmdCommand: home (PLAYER_LIMB_HOME_CMD)
player_limb_power_reqRequest/reply: Power
player_limb_setpose_cmdCommand: Set end effector pose (PLAYER_LIMB_SETPOSE_CMD)
player_limb_setposition_cmdCommand: Set end effector position (PLAYER_LIMB_SETPOSITION_CMD)
player_limb_speed_reqRequest/reply: Speed
player_limb_stop_cmdCommand: stop (PLAYER_LIMB_STOP_CMD)
player_limb_vecmove_cmdCommand: Vector move the end effector (PLAYER_LIMB_VECMOVE_CMD)
player_localize_dataData: hypotheses (PLAYER_LOCALIZE_DATA_HYPOTHS)
player_localize_get_particlesRequest/reply: Get particles
player_localize_hypothHypothesis format
player_localize_particleA particle
player_localize_set_poseRequest/reply: Set the robot pose estimate
player_log_get_stateRequest/reply: Get state
player_log_set_filenameRequest/reply: Set filename
player_log_set_read_rewindRequest/reply: Rewind playback
player_log_set_read_stateRequest/reply: Set playback state
player_log_set_write_stateRequest/reply: Set write state
player_map_dataRequest/reply: get grid map tile
player_map_data_vectorRequest/reply: get vector map
player_map_infoData AND Request/reply: Map information
player_mcom_configConfiguration request to the device
player_mcom_dataA piece of data
player_mcom_returnConfiguration reply from the device
player_msghdrGeneric message header
player_opaque_dataData
player_planner_cmdCommand: state (PLAYER_PLANNER_CMD_GOAL)
player_planner_dataData: state (PLAYER_PLANNER_DATA_STATE)
player_planner_enable_reqRequest/reply: Enable/disable robot motion
player_planner_waypoints_reqRequest/reply: Get waypoints
player_point_2dA point in the plane
player_point_3dA point in 3D space
player_poseA pose in the plane
player_pose3dA pose in space
player_position1d_cmd_posCommand: state (PLAYER_POSITION1D_CMD_POS)
player_position1d_cmd_velCommand: state (PLAYER_POSITION1D_CMD_VEL)
player_position1d_dataData: state (PLAYER_POSITION1D_DATA_STATE)
player_position1d_geomRequest/reply: Query geometry
player_position1d_position_modeRequest/reply: Change control mode
player_position1d_position_pidRequest/reply: Set position PID parameters
player_position1d_power_configRequest/reply: Motor power
player_position1d_reset_odom_configRequest/reply: Reset odometry
player_position1d_set_odomRequest/reply: Set odometry
player_position1d_speed_pidRequest/reply: Set velocity PID parameters
player_position1d_speed_profRequest/reply: Set linear speed profile parameters
player_position1d_velocity_mode_configRequest/reply: Change velocity control
player_position2d_cmd_carCommand: carlike (PLAYER_POSITION2D_CMD_CAR)
player_position2d_cmd_posCommand: position (PLAYER_POSITION2D_CMD_POS)
player_position2d_cmd_velCommand: velocity (PLAYER_POSITION2D_CMD_VEL)
player_position2d_dataData: state (PLAYER_POSITION2D_DATA_STATE)
player_position2d_geomData AND Request/reply: geometry
player_position2d_position_mode_reqRequest/reply: Change control mode
player_position2d_position_pid_reqRequest/reply: Set position PID parameters
player_position2d_power_configRequest/reply: Motor power
player_position2d_reset_odom_configRequest/reply: Reset odometry
player_position2d_set_odom_reqRequest/reply: Set odometry
player_position2d_speed_pid_reqRequest/reply: Set velocity PID parameters
player_position2d_speed_prof_reqRequest/reply: Set linear speed profile parameters
player_position2d_velocity_mode_configRequest/reply: Change velocity control
player_position3d_cmd_posCommand: position (PLAYER_POSITION3D_CMD_SET_POS)
player_position3d_cmd_velCommand: velocity (PLAYER_POSITION3D_CMD_SET_VEL)
player_position3d_dataData: state (PLAYER_POSITION3D_DATA_STATE)
player_position3d_geomRequest/reply: Query geometry
player_position3d_position_mode_reqRequest/reply: Change position control
player_position3d_position_pid_reqRequest/reply: Set position PID parameters
player_position3d_power_configRequest/reply: Motor power
player_position3d_reset_odom_configRequest/reply: Reset odometry
player_position3d_set_odom_reqRequest/reply: Set odometry
player_position3d_speed_pid_reqRequest/reply: Set velocity PID parameters
player_position3d_speed_prof_reqRequest/reply: Set speed profile parameters
player_position3d_velocity_mode_configRequest/reply: Change velocity control
player_power_chargepolicy_configRequest/reply: set charging policy
player_power_dataData: voltage (PLAYER_POWER_DATA_STATE)
player_ptz_cmdCommand: state (PLAYER_PTZ_CMD_STATE)
player_ptz_dataData: state (PLAYER_PTZ_DATA_STATE)
player_ptz_geomRequest/reply: Query geometry
player_ptz_req_control_modeRequest/reply: Control mode
player_ptz_req_genericRequest/reply: Generic request
player_rfid_cmdCommand
player_rfid_dataData
player_rfid_tagStructure describing a single RFID tag
player_segmentA line segment, used to construct vector-based maps
player_simulation_cmdCommand
player_simulation_dataData
player_simulation_pose2d_reqRequest/reply: get/set 2D pose of a named simulation object
player_simulation_property_float_reqRequest/reply: get/set floating-point property of a named simulation object
player_simulation_property_int_reqRequest/reply: get/set integer property of a named simulation object
player_simulation_property_string_reqRequest/reply: get/set string property of a named simulation object
player_sonar_dataData: ranges (PLAYER_SONAR_DATA_RANGES)
player_sonar_geomData AND Request/reply: geometry
player_sonar_power_configRequest/reply: Sonar power
player_sound_cmdCommand: play clip (PLAYER_SOUND_CMD_IDX)
player_speech_cmdCommand: say a string (PLAYER_SPEECH_CMD_SAY)
player_speech_recognition_dataData: recognized string (PLAYER_SPEECH_MAX_STRING_LEN)
player_truth_fiducial_idConfiguration request: Get/set fiducial ID number
player_truth_poseData
player_waveform_dataData: sample (PLAYER_WAVEFORM_DATA_SAMPLE)
player_wifi_dataData: state (PLAYER_WIFI_DATA_STATE)
player_wifi_iwspy_addr_reqRequest/reply:
player_wifi_linkLink information for one host
player_wifi_mac_reqRequest/reply:
player_wsn_cmdCommand: set device state (PLAYER_WSN_CMD_DEVSTATE) This wsn command sets the state of the node's indicator lights or its buzzer/sounder (if equipped with one)
player_wsn_dataData (PLAYER_WSN_DATA)
player_wsn_datafreq_configRequest/reply: Change data delivery frequency
player_wsn_datatype_configRequest/reply: change the data type to RAW or converted engineering units
player_wsn_node_dataStructure describing the WSN node's data packet
player_wsn_power_configRequest/reply: Put the node in sleep mode (0) or wake it up (1)
playerc_actarray_tActarray device data
playerc_aio_tAio proxy data
playerc_blobfinder_tBlobfinder device data
playerc_bumper_tBumper proxy data
playerc_camera_tCamera proxy data
playerc_device_info_tInfo about an available (but not necessarily subscribed) device
playerc_dio_tDio proxy data
playerc_fiducial_tFiducial finder data
playerc_gps_tGPS proxy data
playerc_graphics2d_tGraphics2d device data
playerc_graphics3d_tGraphics3d device data
playerc_gripper_tGripper device data
playerc_ir_tIr proxy data
playerc_laser_tLaser proxy data
playerc_limb_tLimb device data
playerc_localize_particleHypothesis data
playerc_localize_tLocalization device data
playerc_log_tLog proxy data
playerc_map_tMap proxy data
playerc_opaque_tOpaque device data
playerc_planner_tPlanner device data
playerc_position1d_tPosition1d device data
playerc_position2d_tPosition2d device data
playerc_position3d_tPosition3d device data
playerc_power_tPower device data
playerc_ptz_tPTZ device data
playerc_rfid_tRFID proxy data
playerc_rfidtag_tStructure describing a single RFID tag
playerc_simulation_tSimulation device proxy
playerc_sonar_tSonar proxy data
playerc_speech_tSpeech proxy data
playerc_speechrecognition_tSpeech recognition proxy data
playerc_wifi_link_tIndividual link info
playerc_wifi_tWifi device proxy
playerc_wsn_tNote: the structure describing the WSN node's data packet is declared in Player
PlayerCc::ActArrayProxyThe ActArrayProxy class is used to control a actarray device
PlayerCc::AioProxyThe AioProxy class is used to read from a aio (analog I/O) device
PlayerCc::BlobfinderProxyThe BlobfinderProxy class is used to control a blobfinder device
PlayerCc::BumperProxyThe BumperProxy class is used to read from a bumper device
PlayerCc::CameraProxyThe CameraProxy class can be used to get images from a camera device
PlayerCc::ClientProxyThe client proxy base class
PlayerCc::DioProxyThe DioProxy class is used to read from a dio (digital I/O) device
PlayerCc::FiducialProxyThe EnergyProxy class is used to read from an energy device
PlayerCc::GpsProxyThe GpsProxy class is used to control a gps device
PlayerCc::Graphics2dProxyThe Graphics2dProxy class is used to draw simple graphics into a rendering device provided by Player using the graphics2d interface
PlayerCc::Graphics3dProxyThe Graphics3dProxy class is used to draw simple graphics into a rendering device provided by Player using the graphics3d interface
PlayerCc::GripperProxyThe GripperProxy class is used to control a gripper device
PlayerCc::IrProxyThe IrProxy class is used to control an ir device
PlayerCc::LaserProxyThe LaserProxy class is used to control a laser device
PlayerCc::LimbProxyThe LimbProxy class is used to control a limb device
PlayerCc::LocalizeProxyThe LocalizeProxy class is used to control a localize device, which can provide multiple pose hypotheses for a robot
PlayerCc::LogProxyThe LogProxy proxy provides access to a log device
PlayerCc::MapProxyThe map proxy provides access to a map device
PlayerCc::OpaqueProxyThe OpaqueProxy proxy provides an interface to a generic opaque
PlayerCc::PlannerProxyThe PlannerProxy proxy provides an interface to a 2D motion planner
PlayerCc::PlayerClientThe PlayerClient is used for communicating with the player server
PlayerCc::PlayerErrorThe C++ exception class
PlayerCc::Position1dProxyThe Position1dProxy class is used to control a position1d device
PlayerCc::Position2dProxyThe Position2dProxy class is used to control a position2d device
PlayerCc::Position3dProxyThe Position3dProxy class is used to control a interface_position3d device
PlayerCc::PowerProxyThe PowerProxy class controls a power device
PlayerCc::PtzProxyThe PtzProxy class is used to control a ptz device
PlayerCc::RFIDProxyThe RFIDProxy class is used to control a rfid device
PlayerCc::SimulationProxyThe SimulationProxy proxy provides access to a simulation device
PlayerCc::SonarProxyThe SonarProxy class is used to control a sonar device
PlayerCc::SpeechProxyThe SoundProxy class is used to control a sound device, which allows you to play pre-recorded sound files on a robot
PlayerCc::SpeechRecognitionProxyThe SpeechRecognition proxy provides access to a speech_recognition device
PlayerCc::WiFiProxyThe WaveformProxy class is used to read raw digital waveforms from a waveform device
PlayerCc::WSNProxyThe WSNProxy class is used to control a wsn device

Last updated 12 September 2005 21:38:45