Packages
package	ext
package	k10
	Indexes for k10 motor group messages.
Classes
interface	AccessControlState
	AccessControlState is a recurring message type that provides information about who has control of a specified Agent and who has requested control of that Agent. More...
interface	Ack
	Ack is a Message that sends an acknowledgement of commands received. More...
interface	AssetConfig
	AssetConfig. More...
interface	AssetState
	AssetState message sends low-frequency updates of the state of a specific Agent. More...
union	ParameterUnion
	Arguments for commands will be specified with these types. More...
struct	KeyTypePair
	KeyTypePair defines a key with data type only. More...
struct	KeyTypeValueTriple
	KeyTypeValueTriple defines a key, its data type and its value. More...
struct	Transform3D
	Transform3D defines an x,y,z cartesian location with a rotation matrix. More...
struct	NamedFloatSequence
	Sequence of floats with an identifier. More...
struct	FloatRange
	Two foating point numbers defining a range with minimum and maximum values. More...
struct	FloatRangeValue
	A min, max range plus current value. More...
struct	OptionSetValue
	A set of options plus the index of the current value. More...
struct	NamedFloatRangeValue
	A named range value (min,max and current value). More...
struct	NamedOptionSetValue
	A named option set (sequence of options and current option). More...
interface	Command
	Command is a message used to send directives to an Agent. More...
struct	CommandDef
	A command definition. More...
struct	SubsystemType
struct	Subsystem
interface	CommandConfig
	Message that sets up the possible commands an Agent can send and any arguments needed to perform said command. More...
interface	FileAnnounce
	Holds information about a file that could be transferred to the ground from the robot. More...
struct	ChannelConfig
	The file queue channel configuration. More...
interface	FileQueueConfig
	Holds information about a file that could be transferred to the ground from the robot. More...
interface	FileQueueEntryState
	Holds information about a file that could be transferred to the ground from the robot. More...
interface	FileQueueReceiverSample
	Holds information about a file that could be transferred to the ground from the robot. More...
interface	FileQueueSample
	Holds information about a file that could be transferred to the ground from the robot. More...
struct	ChannelState
interface	FileQueueState
	Holds information about a file that could be transferred to the ground from the robot. More...
struct	FrameDef
	Frame Definition. More...
interface	FrameStoreConfig
	FrameConfig. More...
struct	Header
	Header of all messages. More...
struct	ImageMetadata
	Holds status information for an image sensor - typically a camera, but could be a laser scanner, gpr, or any sensor that can pack a data sample into a 2D array. More...
interface	ImageSensorSample
	Image sensor information, plus payload. More...
interface	ImageSensorState
	Holds status information for an image sensor - typically a camera, but could be a laser scanner, gpr, or any sensor that can pack a data sample into a 2D array. More...
struct	JointDef
	JointDef defines the frame and DOF for a specific Agent's joints. More...
interface	JointConfig
	Joint configuration of a kinematic chain. More...
interface	JointSample
	JointSample delivers joint data at a high frequency. More...
interface	Message
	Definition of message, which is the foundation of all other message types. More...
interface	PointCloudConfig
	PointCloudConfig message sets up the configuration of a PointCloudSample message for a specific Agent. More...
struct	PointSample
	PointSample describes the position and attributes of a point in the cloud. More...
interface	PointCloudSample
	PointCloudSample message sends data in point cloud format. More...
interface	PositionConfig
	PositionConfig message sets up configuration for PositionSample messages. More...
interface	PositionSample
	PositionSample message delivers the position of the Agent. More...
interface	CommandRecord
	CommandRecord holds a command, its status and its result. More...
struct	SingleQueue
	SingleQueue holds a sequence of CommandRecords. More...
interface	QueueState
	QueueState is a message that holds single queues of pending, active, completed and sent commands. More...
interface	TextMessage
	TextMessage is a message that allows RAPID application users to chat with each other or for logging-style activities. More...
Typedefs
typedef sequence< octet >	OctetSequence
typedef sequence< octet, 1024 >	OctetSequence1K
typedef sequence< octet, 2048 >	OctetSequence2K
typedef sequence< octet, 4096 >	OctetSequence4K
typedef sequence< octet, 131072 >	OctetSequence128K
typedef sequence< short >	ShortSequence
typedef sequence< short, 32 >	ShortSequence32
typedef sequence< short, 64 >	ShortSequence64
typedef sequence< short, 128 >	ShortSequence128
typedef sequence< short, 1024 >	ShortSequence1K
typedef sequence< short, 2048 >	ShortSequence2K
typedef sequence< short, 4096 >	ShortSequence4K
typedef sequence< short, 131072 >	ShortSequence128K
typedef sequence< long >	LongSequence
typedef sequence< long long >	LongLongSequence
typedef sequence< float >	FloatSequence
typedef sequence< float, 64 >	FloatSequence64
typedef sequence< double >	DoubleSequence
typedef string< 16 >	String16
typedef string< 32 >	String32
typedef string< 64 >	String64
typedef string< 128 >	String128
typedef string< 256 >	String256
typedef string< 1024 >	String1K
typedef string< 2048 >	String2K
typedef sequence< String16 >	String16Sequence
typedef sequence< String32 >	String32Sequence
typedef sequence< String128 >	String128Sequence
typedef double	Vec2d [2]
typedef double	Vec3d [3]
typedef float	Vec2f [2]
typedef float	Vec3f [3]
typedef float	Mat33f [9]
typedef sequence < ParameterUnion, 16 >	ParameterSequence16
typedef sequence< String128, 64 >	ValueSequence64
	ValueSequence is used in telemetry types that have a corresponding Config message that defines the Key and Type.
typedef sequence< KeyTypePair, 16 >	KeyTypeSequence16
typedef sequence< KeyTypePair, 64 >	KeyTypeSequence64
typedef sequence < KeyTypeValueTriple, 8 >	KeyTypeValueSequence8
	Hash table interchange data structure with type information.
typedef sequence < KeyTypeValueTriple, 16 >	KeyTypeValueSequence16
typedef sequence < KeyTypeValueTriple, 32 >	KeyTypeValueSequence32
typedef sequence < KeyTypeValueTriple, 64 >	KeyTypeValueSequence64
typedef sequence < KeyTypeValueTriple, 128 >	KeyTypeValueSequence128
typedef sequence < NamedFloatSequence, 16 >	NFSeqSequence16
typedef sequence < NamedFloatSequence, 32 >	NFSeqSequence32
typedef sequence < NamedFloatRangeValue, 16 >	NamedFloatRangeValueSequence16
typedef sequence < NamedFloatRangeValue, 32 >	NamedFloatRangeValueSequence32
typedef sequence < NamedOptionSetValue, 16 >	NamedOptionSetValueSequence16
typedef sequence < NamedOptionSetValue, 32 >	NamedOptionSetValueSequence32
typedef sequence< CommandDef, 128 >	CommandDefSequence
typedef sequence< SubsystemType >	SubsystemTypeSequence
typedef sequence< Subsystem >	SubsystemSequence
typedef sequence < ChannelConfig, 8 >	ChannelConfigSequence
	Sequence of channel specifications.
typedef sequence< ChannelState >	ChannelStateSequence
typedef sequence< FrameDef, 256 >	FrameDefSequence
	A sequence of frame definitions.
typedef sequence< JointDef, 64 >	JointDefSequence
typedef sequence< PointSample, 8192 >	PointSampleSequence
Enumerations
enum	AckStatus { ACK_QUEUED, ACK_EXECUTING, ACK_COMPLETED }
	Status of the command paired with this Ack. More...
enum	AckCompletedStatus { ACK_COMPLETED_NOT, ACK_COMPLETED_OK, ACK_COMPLETED_BAD_SYNTAX, ACK_COMPLETED_EXEC_FAILED, ACK_COMPLETED_CANCELED }
	This status is sent along when it has completed. More...
enum	AgentType { ASTRONAUT, ATHLETE, CAMERA, CENTAUR, CRANE, HUMANOID, JSCROVER, K10, OPERATOR, SEQUENCER, SIMULATOR, NUM_AGENT_TYPES }
	AgentType specifies the agent's species. More...
enum	DataType { RAPID_BOOL, RAPID_DOUBLE, RAPID_FLOAT, RAPID_INT, RAPID_STRING, RAPID_VEC3d, RAPID_MAT33f }
	DataType is used in KeyTypeValue triples to describe the type of data contained in the string value. More...
enum	Priority { PRI_LOW, PRI_MEDIUM, PRI_HIGH, PRI_ASYNC }
	Priority denotes where on the queue this command should go. More...
enum	FileTransferStatus { RAPID_FILE_PREFETCH_PENDING, RAPID_FILE_PREFETCHING, RAPID_FILE_PENDING, RAPID_FILE_ACTIVE, RAPID_FILE_PAUSED, RAPID_FILE_DONE, RAPID_FILE_CANCELED, RAPID_FILE_ERROR }
enum	ChannelStatus { FILE_QUEUE_CHANNEL_ACTIVE, FILE_QUEUE_CHANNEL_PAUSED }
	ChannelStatus is used to indicate whether a RAPID File Queue (part of the RAPID File Transfer Service) is currently capable of transferring files (Active) or is temporarily refraining from transferring files (Paused). More...
enum	PointSampleXyzMode { PS_XYZ, PS_XYt, PS_Rae }
	PointSampleXyzMode denotes whether the values represent: More...
enum	PointSampleAttributeMode { PS_UNUSED, PS_INTENSITY, PS_LAYER, PS_ECHO, PS_LAYER4_ECHO4, PS_PULSE }
	PointSampleAttributeMode denotes the type of data contained in the attribute bytes. More...
enum	StatusType { Q_STATUS_INIT, Q_STATUS_OUTBOUND, Q_STATUS_LOST, Q_STATUS_INLINE, Q_STATUS_PREEMPTED, Q_STATUS_INPROCESS, Q_STATUS_PAUSED, Q_STATUS_CANCELED, Q_STATUS_SUCCEEDED, Q_STATUS_FAILED, Q_STATUS_ALIEN_PENDING, Q_STATUS_ALIEN_ACTIVE, Q_STATUS_ALIEN_COMPLETED, Q_STATUS_FORGOTTEN_BY_ROBOT }
enum	ResultType { Q_RESULT_INIT, Q_RESULT_SUCCEEDED, Q_RESULT_FAILED }
	ResultType describes the result of a command on the completed queue. More...
enum	MessageLevel { MSG_DEBUG, MSG_INFO, MSG_ATTENTION, MSG_WARN, MSG_ERROR, MSG_CRITICAL }
	Importance level of the message. More...
Variables
const long	ATHLETE_LEG_1 = 0
const long	ATHLETE_LEG_2 = 1
const long	ATHLETE_LEG_3 = 2
const long	ATHLETE_LEG_4 = 3
const long	ATHLETE_LEG_5 = 4
const long	ATHLETE_LEG_6 = 5
const long	ATHLETE_AUX_LEG_ID_INDEX = 0
const long	ATHLETE_AUX_MOTOR_ANGLE_INDEX = 1
const String32	ATHLETE_SUBSYS_NAME_EHA = "ATHLETE_EHA"
const String32	ATHLETE_SUBSYS_NAME_FORCE_TORQUE = "ATHLETE_FORCE_TORQUE"
const String32	ATHLETE_SUBSYS_NAME_BATT = "ATHLETE_BATTERY"
const String16	ATHLETE_HEADING_RAD_KEY = "ATHLETE_HEADING_RAD"
const String16	ATHLETE_BODY_TILT_KEY = "ATHLETE_BODY_TILT"
const String16	ATHLETE_BODY_ROLL_KEY = "ATHLETE_BODY_ROLL"
const String16	ATHLETE_BODY_PITCH_KEY = "ATHLETE_BODY_PITCH"
const String16	ATHLETE_ODOMETRY_KEY = "ATHLETE_ODOMETRY"
const String16	ATHLETE_HEADING_FLOAT = "ATHLETE_HEADING_RAD__FLOAT__"
const String16	ATHLETE_TILT_FLOAT = "ATHLETE_BODY_TILT__FLOAT__"
const String16	ATHLETE_ROLL_FLOAT = "ATHLETE_BODY_ROLL__FLOAT__"
const String16	ATHLETE_PITCH_FLOAT = "ATHLETE_BODY_PITCH__FLOAT__"
const String16	ATHLETE_ODOMETRY_FLOAT = "ATHLETE_ODOMETRY__FLOAT__"
const String16	ATHLETE_PROC_ID_INT = "ATHLETE_PROCESSOR_ID__INT__"
const String16	ATHLETE_CAM_REFP_X_FLOAT = "ATHLETE_CAM_REFP_X__FLOAT__"
const String16	ATHLETE_CAM_REFP_Y_FLOAT = "ATHLETE_CAM_REFP_Y__FLOAT__"
const String16	ATHLETE_CAM_REFP_Z_FLOAT = "ATHLETE_CAM_REFP_Z__FLOAT__"
const String16	ATHLETE_CAM_REFQ_P_FLOAT = "ATHLETE_CAM_REFQ_P__FLOAT__"
const String16	ATHLETE_CAM_REFQ_Y_FLOAT = "ATHLETE_CAM_REFQ_Y__FLOAT__"
const String16	ATHLETE_CAM_REFQ_R_FLOAT = "ATHLETE_CAM_REFQ_R__FLOAT__"
const String16	ATHLETE_CAM_REFQ_W_FLOAT = "ATHLETE_CAM_REFQ_W__FLOAT__"
const String16	ATHLETE_CAM_V2_FLOAT = "ATHLETE_CAM_V2__FLOAT__"
const String16	ATHLETE_CAM_IMG_ACQ_TIME_FLOAT = "ATHLETE_CAM_IMGACQTIM__FLOAT__"
const String16	ATHLETE_BATT1_INT = "ATHLETE_BATT1__INT__"
const String16	ATHLETE_BATT2_INT = "ATHLETE_BATT2__INT__"
const String16	ATHLETE_BATT3_INT = "ATHLETE_BATT3__INT__"
const String16	ATHLETE_BATT4_INT = "ATHLETE_BATT4__INT__"
const String16	ATHLETE_BATT5_INT = "ATHLETE_BATT5__INT__"
const String16	ATHLETE_BATT6_INT = "ATHLETE_BATT6__INT__"
const String16	ATHLETE_BATTV12_INT = "ATHLETE_BATTV12__INT__"
const String16	ATHLETE_BATTV24_INT = "ATHLETE_BATTV24__INT__"
const String16	ATHLETE_BATTV48_INT = "ATHLETE_BATTV48__INT__"
const String16	ATHLETE_BATTSOC_INT = "ATHLETE_BATTSOC__INT__"
const String32	ATHLETE_NUM_LEGS = "ATHLETE_NUM_LEGS"
const String32	ATHLETE_DRIVE_FACE = "ATHLETE_DRIVE_FACE"
const String32	ATHLETE_NUM_JOINTS = "ATHLETE_NUM_JOINTS"
const String32	ATHLETE_CAMERA_SET = "ATHLETE_CAMERA_SET"
const String32	ATHLETE_CAMERA_SELECTION = "ATHLETE_CAMERA_SELECTION"
const String32	ATHLETE_CAMERA_LEG = "ATHLETE_CAMERA_LEG"
const long	ATHLETE_ARTIC_JOINTDATA_INDEX_HIP_YAW = 0
	Articulation indexes for the JointData arrays.
const long	ATHLETE_ARTIC_JOINTDATA_INDEX_HIP_PITCH = 1
const long	ATHLETE_ARTIC_JOINTDATA_INDEX_THIGH_PITCH = 2
const long	ATHLETE_ARTIC_JOINTDATA_INDEX_KNEE_PITCH = 3
const long	ATHLETE_ARTIC_JOINTDATA_INDEX_KNEE_ROLL = 4
const long	ATHLETE_ARTIC_JOINTDATA_INDEX_ANKLE_PITCH = 5
const long	ATHLETE_ARTIC_JOINTDATA_INDEX_ANKLE_ROLL = 6
const long	ATHLETE_ARTIC_JOINTDATA_INDEX_GRIPPER = 7
const long	ATHLETE_ARTIC_JOINTDATA_INDEX_WHEEL = 8
const long	ATHLETE_ARTIC_JOINTDATA_INDEX_DOCK = 9
const String16	FLOAT_TYPE_KEY = "__FLOAT__"
const String16	INT_TYPE_KEY = "__INT__"
const String32	ADMIN = "Admin"
	The commands in the Admin Command Group provide high-level test functions and control parameters.
const String32	ADMIN_METHOD_ECHO = "echo"
	Echos the parameter text.
const String32	ADMIN_METHOD_ECHO_PARAM_ECHOTEXT = "echoText"
	Key for parameter used in reply by bridge.
const DataType	ADMIN_METHOD_ECHO_DTYPE_ECHOTEXT = RAPID_STRING
const String32	ADMIN_METHOD_SHUTDOWN = "shutdown"
	Terminate the bridge.
const String32	ADMIN_METHOD_NOOP = "noOp"
	No operation command.
const String32	ADMIN_METHOD_SETPOSITIONSAMPLEPUBLISHRATE = "setPositionSamplePublishRate"
	Publish Agent pose at given rate.
const String32	ADMIN_METHOD_SETPOSITIONSAMPLEPUBLISHRATE_PARAM_POSERATE = "positionSamplePublishRate"
	In Hz.
const DataType	ADMIN_METHOD_SETPOSITIONSAMPLEPUBLISHRATE_DTYPE_POSERATE = RAPID_FLOAT
	Publish Agent articulation at given rate.
const String32	ADMIN_METHOD_SETJOINTSAMPLEPUBLISHRATE = "setJointSamplePublishRate"
	Publish Agent articulation at given rate.
const String32	ADMIN_METHOD_SETJOINTSAMPLEPUBLISHRATE_PARAM_JOINTSAMPLERATE = "jointSampleRate"
	Publish Agent articulation at given rate.
const DataType	ADMIN_METHOD_SETJOINTSAMPLEPUBLISHRATE_DTYPE_JOINTSAMPLERATE = RAPID_FLOAT
	Publish Agent articulation at given rate.
const String32	IMAGESENSOR = "ImageSensor"
	The commands in the ImageSensor Command Group are used to capture images from Agent-mounted cameras.
const String32	IMAGESENSOR_METHOD_REQSENSORSTATE = "reqSensorState"
	ImageSensorState message.
const String32	IMAGESENSOR_METHOD_REQSENSORSTATE_PARAM_SENSORNAME = "sensorName"
	Message.
const DataType	IMAGESENSOR_METHOD_REQSENSORSTATE_DTYPE_SENSORNAME = RAPID_STRING
	Message.
const String32	IMAGESENSOR_METHOD_IMAGEACQUIRE = "imageAcquire"
	Send image acquire command with this command, the ImageCommand attribute will be populated.
const String32	IMAGESENSOR_METHOD_IMAGEACQUIRE_PARAM_CAMERA_NAME = "cameraName"
const DataType	IMAGESENSOR_METHOD_IMAGEACQUIRE_DTYPE_CAMERA_NAME = RAPID_STRING
const String32	IMAGESENSOR_METHOD_IMAGEACQUIRE_PARAM_CAMERA_TYPE = "cameraType"
	IMAGESENSOR_CAMERA_TYPE_xxx.
const DataType	IMAGESENSOR_METHOD_IMAGEACQUIRE_DTYPE_CAMERA_TYPE = RAPID_STRING
const String32	IMAGESENSOR_METHOD_IMAGEACQUIRE_PARAM_CAMERA_MIME_TYPE = "mimeType"
	MIMETypeConstants.
const DataType	IMAGESENSOR_METHOD_IMAGEACQUIRE_DTYPE_CAMERA_MIME_TYPE = RAPID_STRING
const String32	IMAGESENSOR_METHOD_IMAGEACQUIRE_PARAM_PAN = "pan"
const DataType	IMAGESENSOR_METHOD_IMAGEACQUIRE_DTYPE_PAN = RAPID_FLOAT
const String32	IMAGESENSOR_METHOD_IMAGEACQUIRE_PARAM_TILT = "tilt"
const DataType	IMAGESENSOR_METHOD_IMAGEACQUIRE_DTYPE_TILT = RAPID_FLOAT
const String32	IMAGESENSOR_METHOD_IMAGEACQUIRE_PARAM_ZOOM = "zoom"
const DataType	IMAGESENSOR_METHOD_IMAGEACQUIRE_DTYPE_ZOOM = RAPID_FLOAT
const String32	IMAGESENSOR_METHOD_IMAGEACQUIRE_PARAM_HFOV = "hFOV"
const DataType	IMAGESENSOR_METHOD_IMAGEACQUIRE_DTYPE_HFOV = RAPID_FLOAT
const String32	IMAGESENSOR_METHOD_IMAGEACQUIRE_PARAM_VFOV = "vFOV"
const DataType	IMAGESENSOR_METHOD_IMAGEACQUIRE_DTYPE_VFOV = RAPID_FLOAT
const String32	IMAGESENSOR_METHOD_IMAGEACQUIRE_PARAM_COLORTYPE = "colorType"
	IMAGESENSOR_COLOR_TYPE_XXX.
const DataType	IMAGESENSOR_METHOD_IMAGEACQUIRE_DTYPE_COLORTYPE = RAPID_STRING
const String32	IMAGESENSOR_METHOD_IMAGEACQUIRE_PARAM_CAPTURE = "captureType"
	IMAGESENSOR_CAPTURE_XXX.
const DataType	IMAGESENSOR_METHOD_IMAGEACQUIRE_DTYPE_CAPTURE = RAPID_STRING
const String32	IMAGESENSOR_COLOR_TYPE_COLOR = "color"
const String32	IMAGESENSOR_COLOR_TYPE_GRAYSCALE = "grayscale"
const String32	IMAGESENSOR_CAPTURE_STREAMING = "streaming"
const String32	IMAGESENSOR_CAPTURE_SINGLE_SHOT = "singleImage"
const String32	IMAGESENSOR_CAPTURE_MULTI_SHOT = "multiImage"
const String32	IMAGESENSOR_CAMERA_TYPE_WEBCAM = "webcam"
const String32	IMAGESENSOR_CAMERA_TYPE_DSLR = "dslr"
const String32	IMAGESENSOR_CAMERA_TYPE_GIGAPAN = "gigapan"
const String32	MOBILITY = "Mobility"
	The commands in the Mobility Command Group controls the motion of navigable rovers over a surface.
const String32	MOBILITY_METHOD_STOPALLMOTION = "stopAllMotion"
	Stops all motion of the Agent, joints, wheels, etc.
const String32	MOBILITY_METHOD_SIMPLEMOVE = "simpleMove"
const String32	MOBILITY_METHOD_SIMPLEMOVE_PARAM_FRAME_NAME = "frameName"
const DataType	MOBILITY_METHOD_SIMPLEMOVE_DTYPE_FRAME_NAME = RAPID_STRING
const String32	MOBILITY_METHOD_SIMPLEMOVE_PARAM_END_LOCATION = "xyz"
const DataType	MOBILITY_METHOD_SIMPLEMOVE_DTYPE_END_LOCATION = RAPID_VEC3d
const String32	MOBILITY_METHOD_SIMPLEMOVE_PARAM_END_LOCATION_TOLERANCE = "xyzTolerance"
const DataType	MOBILITY_METHOD_SIMPLEMOVE_DTYPE_END_LOCATION_TOLERANCE = RAPID_VEC3d
const String32	MOBILITY_METHOD_SIMPLEMOVE6DOF = "simpleMove6DOF"
const String32	MOBILITY_METHOD_SIMPLEMOVE6DOF_PARAM_FRAME_NAME = "frameName"
const DataType	MOBILITY_METHOD_SIMPLEMOVE6DOF_DTYPE_FRAME_NAME = RAPID_STRING
const String32	MOBILITY_METHOD_SIMPLEMOVE6DOF_PARAM_END_LOCATION = "xyz"
const DataType	MOBILITY_METHOD_SIMPLEMOVE6DOF_DTYPE_END_LOCATION = RAPID_VEC3d
const String32	MOBILITY_METHOD_SIMPLEMOVE6DOF_PARAM_END_LOCATION_TOLERANCE = "xyzTolerance"
const DataType	MOBILITY_METHOD_SIMPLEMOVE6DOF_DTYPE_END_LOCATION_TOLERANCE = RAPID_VEC3d
const String32	MOBILITY_METHOD_SIMPLEMOVE6DOF_PARAM_ROT = "rot"
const DataType	MOBILITY_METHOD_SIMPLEMOVE6DOF_DTYPE_ROT = RAPID_MAT33f
const String32	MOBILITY_METHOD_MOVE = "move"
const String32	MOBILITY_METHOD_MOVE_PARAM_FRAME_NAME = "frameName"
const DataType	MOBILITY_METHOD_MOVE_DTYPE_FRAME_NAME = RAPID_STRING
const String32	MOBILITY_METHOD_MOVE_PARAM_END_LOCATION = "xyt"
	Can be defined as a rotation about an axis.
const DataType	MOBILITY_METHOD_MOVE_DTYPE_END_LOCATION = RAPID_VEC3d
const String32	MOBILITY_METHOD_MOVE_PARAM_END_LOCATION_TOLERANCE = "xytTolerance"
	The x,y,theta tolerance for waypoint.
const DataType	MOBILITY_METHOD_MOVE_DTYPE_END_LOCATION_TOLERANCE = RAPID_VEC3d
const String32	MOBILITY_METHOD_MOVE_PARAM_HINTED_SPEED = "hintedSpeed"
	In meters/sec.
const DataType	MOBILITY_METHOD_MOVE_DTYPE_HINTED_SPEED = RAPID_FLOAT
const String32	MOBILITY_METHOD_MOVE_PARAM_NAV_ALGO = "navAlgo"
const DataType	MOBILITY_METHOD_MOVE_DTYPE_NAV_ALGO = RAPID_STRING
const String32	MOBILITY_METHOD_MOVE6DOF = "move6DOF"
const String32	MOBILITY_METHOD_MOVE6DOF_PARAM_FRAME_NAME = "frameName"
const DataType	MOBILITY_METHOD_MOVE6DOF_DTYPE_FRAME_NAME = RAPID_STRING
const String32	MOBILITY_METHOD_MOVE6DOF_PARAM_END_LOCATION = "xyz"
const DataType	MOBILITY_METHOD_MOVE6DOF_DTYPE_END_LOCATION = RAPID_VEC3d
const String32	MOBILITY_METHOD_MOVE6DOF_PARAM_END_LOCATION_TOLERANCE = "xyzTolerance"
const DataType	MOBILITY_METHOD_MOVE6DOF_DTYPE_END_LOCATION_TOLERANCE = RAPID_VEC3d
const String32	MOBILITY_METHOD_MOVE6DOF_PARAM_ROT = "rot"
const DataType	MOBILITY_METHOD_MOVE6DOF_DTYPE_ROT = RAPID_MAT33f
const String32	MOBILITY_METHOD_MOVE6DOF_PARAM_HINTED_SPEED = "hintedSpeed"
	In meters/sec.
const DataType	MOBILITY_METHOD_MOVE6DOF_DTYPE_HINTED_SPEED = RAPID_FLOAT
const String32	MOBILITY_METHOD_MOVE6DOF_PARAM_NAV_ALGO = "navAlgo"
const DataType	MOBILITY_METHOD_MOVE6DOF_DTYPE_NAV_ALGO = RAPID_STRING
const String32	NAV_ALGO_SAFE = "RAPID_NAV_SAFE"
	Navigation Algorithm for MobilityCommand.
const String32	NAV_ALGO_BLIND = "RAPID_NAV_BLIND"
const String32	FRAME_NAME_UTM = "RAPID_UTM_FRAME"
	Frame information for MobilityCommand and CameraCommand.
const String32	FRAME_NAME_SITE = "RAPID_SITE_FRAME"
const String32	FRAME_NAME_ROVER = "RAPID_ROVER_FRAME"
const String32	QUEUE = "Queue"
	The commands in the Queue command group control task execution within the Sequencer.
const String32	QUEUE_METHOD_CANCELCURRENTTASK = "cancelCurrentTask"
	To come.
const String32	QUEUE_METHOD_CANCELALL = "cancelAll"
	To come.
const String32	QUEUE_METHOD_DELETEALL = "deleteAll"
	To come.
const String32	QUEUE_METHOD_SUSPENDONCOMPLETE = "suspendOnCompletion"
	Complete and suspend until queue resume command received.
const String32	QUEUE_METHOD_RESUME = "resume"
	To come.
const String32	ACCESSCONTROL = "AccessControl"
	The commands in the AccessControl command group govern transfer of control of agents between operators.
const String32	ACCESSCONTROL_METHOD_REQUESTCONTROL = "requestControl"
	AccessControl method type for requesting control of an Agent.
const String32	ACCESSCONTROL_METHOD_GRABCONTROL = "grabControl"
	AccessControl method type for grabbing control of an Agent.
const String32	ACCESSCONTROL_METHOD_RELEASECONTROL = "releaseControl"
	AccessControl method type for release control of an Agent.
const String32	ACCESSCONTROL_METHOD_TRANSFERCONTROL = "transferControl"
	AccessControl method type for transferring control of an Agent.
const String32	ACCESSCONTROL_METHOD_TRANSFERCONTROL_PARAM_RECIPIENT = "controlRecipient"
const DataType	ACCESSCONTROL_METHOD_TRANSFERCONTROL_DTYPE_RECIPIENT = RAPID_STRING
const String32	RAFT = "RAFT"
	RAFT: RAPID Advanced File Transfer subsystem.
const String32	RAFT_METHOD_PARAM_UUID = "uuid"
	RAFT paramter: Uuid of file.
const DataType	RAFT_METHOD_DTYPE_UUID = RAPID_STRING
const String32	RAFT_METHOD_PARAM_PRIORITY = "priority"
	RAFT paramter: Priority of file.
const DataType	RAFT_METHOD_DTYPE_PRIORITY = RAPID_FLOAT
const String32	RAFT_METHOD_PARAM_KEY = "key"
	RAFT paramter: metaData key field name.
const DataType	RAFT_METHOD_DTYPE_KEY = RAPID_STRING
const String32	RAFT_METHOD_PARAM_VALUE = "value"
	RAFT paramter: value of the metaData key field.
const DataType	RAFT_METHOD_DTYPE_VALUE = RAPID_STRING
const String32	RAFT_METHOD_PARAM_CHANNELID = "channelId"
	RAFT paramter: Channel id.
const DataType	RAFT_METHOD_DTYPE_CHANNELID = RAPID_INT
const String32	RAFT_METHOD_PARAM_BANDWIDTHBPS = "bandwidthBps"
	RAFT paramter: Bandwidth.
const DataType	RAFT_METHOD_DTYPE_BANDWIDTHBPS = RAPID_INT
const String32	RAFT_METHOD_PARAM_PREFETCHKBANDWIDTHBPS = "prefetchBandwidthBps"
const DataType	RAFT_METHOD_DTYPE_PREFETCHKBANDWIDTHBPS = RAPID_INT
const String32	RAFT_METHOD_PUTFILE = "putFile"
	Put file into RAFT queue.
const String32	RAFT_METHOD_PUTMATCHING = "putMatching"
	Put data product files into RAFT queue.
const String32	RAFT_METHOD_REMOVEFILE = "removeFile"
	Remove file from RAFT queue.
const String32	RAFT_METHOD_PAUSE = "pause"
	Pause a RAFT queue.
const String32	RAFT_METHOD_RESUME = "resume"
	Resume a RAFT queue.
const String32	RAFT_METHOD_SETBANDWIDTH = "setBandwidth"
	Resume a RAFT queue.
const String32	IMG_V_FOV_KEY = "IMG_V_FOV"
const String32	IMG_H_FOV_KEY = "IMG_H_FOV"
const long	JOINT_ENABLED = 0x0000
	Flag values for joint status sequence.
const long	JOINT_DISABLED = 0x0001
	Joint is disabled.
const long	JOINT_FROZEN = 0x0003
	Joint is unable to move.
const long	JOINT_ESTOP = 0x0005
	Joint has been e-stopped.
const long	JOINT_FAILURE = 0x0100
	Joint has had a failure.
const long	JOINT_OVER_CURRENT = 0x0300
	Joint is drawing too much current.
const long	JOINT_POSITION_ERROR = 0x0500
	Joint is drawing too much current.
const String32	MIME_IMAGE_BMP = "image/bmp"
	MIME Types to use for ImageSensorSample, if appropriate.
const String32	MIME_IMAGE_CIS_COD = "image/cis-cod"
const String32	MIME_IMAGE_GIF = "image/gif"
const String32	MIME_IMAGE_IEF = "image/ief"
const String32	MIME_IMAGE_JPEG = "image/jpeg"
const String32	MIME_IMAGE_PIPEG = "image/pipeg"
const String32	MIME_IMAGE_SVG_XML = "image/svg+xml"
const String32	MIME_IMAGE_TIFF = "image/tiff"
const String32	MIME_IMAGE_CMU_RASTER = "image/x-cmu-raster"
const String32	MIME_IMAGE_CMX = "image/x-cmx"
const String32	MIME_IMAGE_ICON = "image/x-icon"
const String32	MIME_IMAGE_PNM = "image/x-portable-anymap"
const String32	MIME_IMAGE_PBM = "image/x-portable-bitmap"
const String32	MIME_IMAGE_PGM = "image/x-portable-graymap"
const String32	MIME_IMAGE_PPM = "image/x-portable-pixmap"
const String32	MIME_IMAGE_RGB = "image/x-rgb"
const String32	MIME_IMAGE_XBM = "image/x-xbitmap"
const String32	MIME_IMAGE_XPM = "image/x-xpixmap"
const String32	MIME_IMAGE_XWD = "image/x-xwindowdump"
const String32	MIME_IMAGE_EXR = "image/x-exr"
const String64	ACK_TOPIC = "rapid_ack"
	A list of commonly used topic names.
const String64	ASSET_CONFIG_TOPIC = "rapid_asset_config"
const String64	ASSET_STATE_TOPIC = "rapid_asset_state"
const String64	COMMAND_TOPIC = "rapid_command"
const String64	COMMAND_CONFIG_TOPIC = "rapid_command_config"
const String64	FILEANNOUNCE_TOPIC = "rapid_fileannounce"
const String64	FILEQUEUE_COMMAND_TOPIC = "rapid_filequeue_command"
const String64	FILEQUEUE_CONFIG_TOPIC = "rapid_filequeue_config"
const String64	FILEQUEUE_SAMPLE_TOPIC = "rapid_filequeue_sample"
const String64	FILEQUEUE_STATE_TOPIC = "rapid_filequeue_state"
const String64	FILEQUEUEENTRY_STATE_TOPIC = "rapid_filequeueentry_state"
const String64	FILEQUEUEENTRY_STATE_RECEIVER_TOPIC = "rapid_filequeueentry_state_receiver"
const String64	FILEQUEUERECEIVER_SAMPLE_TOPIC = "rapid_filequeuereceiver_stample"
const String64	FRAMESTORE_CONFIG_TOPIC = "rapid_framestore_config"
const String64	IMAGESENSOR_SAMPLE_TOPIC = "rapid_imagesensor_sample"
const String64	IMAGESENSOR_STATE_TOPIC = "rapid_imagesensor_state"
const String64	JOINT_CONFIG_TOPIC = "rapid_joint_config"
const String64	JOINT_SAMPLE_TOPIC = "rapid_joint_sample"
const String64	NAVMAP_CONFIG_TOPIC = "rapid_navmap_config"
const String64	NAVMAP_SAMPLE_TOPIC = "rapid_navmap_sample"
const String64	POINTCLOUD_CONFIG_TOPIC = "rapid_pointcloud_config"
const String64	POINTCLOUD_SAMPLE_TOPIC = "rapid_pointcloud_sample"
const String64	POSITION_CONFIG_TOPIC = "rapid_position_config"
const String64	POSITION_SAMPLE_TOPIC = "rapid_position_sample"
const String64	QUEUE_STATE_TOPIC = "rapid_queue_state"
const String64	RANGESCAN_CONFIG_TOPIC = "rapid_rangescan_config"
const String64	RANGESCAN_SAMPLE_TOPIC = "rapid_rangescan_sample"
const String64	SYSTEMINFO_CONFIG_TOPIC = "rapid_systeminfo_config"
const String64	SYSTEMINFO_SAMPLE_TOPIC = "rapid_systeminfo_sample"
const String64	TEXTMESSAGE_TOPIC = "rapid_textmessage"
const String64	ACCESSCONTROL_STATE_TOPIC = "rapid_accesscontrol_state"

Typedef Documentation

typedef sequence<ChannelConfig, 8> ChannelConfigSequence

typedef sequence<ChannelState> ChannelStateSequence

typedef sequence<CommandDef,128> CommandDefSequence

typedef sequence<double> DoubleSequence

typedef sequence<float> FloatSequence

typedef sequence<float, 64> FloatSequence64

typedef sequence<FrameDef, 256> FrameDefSequence

The frames are presented in depth-first pre-order. That is, any parent field of a FrameDefSequence entry denotes a frame with a smaller index in the sequence than the entry has.

typedef sequence<JointDef,64> JointDefSequence

typedef sequence<KeyTypePair, 16> KeyTypeSequence16

typedef sequence<KeyTypePair, 64> KeyTypeSequence64

typedef sequence<KeyTypeValueTriple,128> KeyTypeValueSequence128

typedef sequence<KeyTypeValueTriple, 16> KeyTypeValueSequence16

typedef sequence<KeyTypeValueTriple, 32> KeyTypeValueSequence32

typedef sequence<KeyTypeValueTriple, 64> KeyTypeValueSequence64

typedef sequence<KeyTypeValueTriple, 8> KeyTypeValueSequence8

typedef sequence<long long> LongLongSequence

typedef sequence<long> LongSequence

typedef float Mat33f[9]

typedef sequence<NamedFloatRangeValue,16> NamedFloatRangeValueSequence16

typedef sequence<NamedFloatRangeValue,32> NamedFloatRangeValueSequence32

typedef sequence<NamedOptionSetValue,16> NamedOptionSetValueSequence16

typedef sequence<NamedOptionSetValue,32> NamedOptionSetValueSequence32

typedef sequence<NamedFloatSequence,16> NFSeqSequence16

typedef sequence<NamedFloatSequence,32> NFSeqSequence32

typedef sequence<octet> OctetSequence

typedef sequence<octet, 131072> OctetSequence128K

typedef sequence<octet, 1024> OctetSequence1K

typedef sequence<octet, 2048> OctetSequence2K

typedef sequence<octet, 4096> OctetSequence4K

typedef sequence<ParameterUnion,16> ParameterSequence16

typedef sequence<PointSample,8192> PointSampleSequence

typedef sequence<short> ShortSequence

typedef sequence<short, 128> ShortSequence128

typedef sequence<short, 131072> ShortSequence128K

typedef sequence<short, 1024> ShortSequence1K

typedef sequence<short, 2048> ShortSequence2K

typedef sequence<short, 32> ShortSequence32

typedef sequence<short, 4096> ShortSequence4K

typedef sequence<short, 64> ShortSequence64

typedef string<128> String128

typedef sequence<String128> String128Sequence

typedef string<16> String16

typedef sequence<String16> String16Sequence

typedef string<1024> String1K

typedef string<256> String256

typedef string<2048> String2K

typedef string<32> String32

typedef sequence<String32> String32Sequence

typedef string<64> String64

typedef sequence<Subsystem> SubsystemSequence

typedef sequence<SubsystemType> SubsystemTypeSequence

typedef sequence<String128, 64> ValueSequence64

typedef double Vec2d[2]

typedef float Vec2f[2]

typedef double Vec3d[3]

typedef float Vec3f[3]

Enumeration Type Documentation

enum AckCompletedStatus

ACK_COMPLETED_NOT: Task has not completed yet.
ACK_COMPLETED_OK: Successful completion.
ACK_COMPLETED_BAD_SYNTAX: Command not recognized, bad parameters, etc.
ACK_COMPLETED_EXEC_FAILED: Failed to complete.
ACK_COMPLETED_CANCELED: Canceled from queue.

Enumerator:

ACK_COMPLETED_NOT
ACK_COMPLETED_OK
ACK_COMPLETED_BAD_SYNTAX
ACK_COMPLETED_EXEC_FAILED
ACK_COMPLETED_CANCELED

enum AckStatus

ACK_QUEUED: Sent by Sequencer when queueing Tasks.
ACK_EXECUTING: Command has been started by the Bridge.
ACK_COMPLETED: Sent when command is done.

Enumerator:

ACK_QUEUED
ACK_EXECUTING
ACK_COMPLETED

enum AgentType

NUM_AGENT_TYPES always denotes the number of possible agent. AgentType may be deprecated or changed because although it is a very useful concept, it is also not very well defined. For instance, should Robonaut2A be of type Robonaut, Robonaut2, or Humanoid?

ASTRONAUT:
ATHLETE:
CAMERA:
CENTAUR:
CRANE:
HUMANOID:
JSCROVER:
K10:
OPERATOR:
SEQUENCER:
SIMULATOR:
NUM_AGENT_TYPES:

Enumerator:

ASTRONAUT
ATHLETE
CAMERA
CENTAUR
CRANE
HUMANOID
JSCROVER
K10
OPERATOR
SEQUENCER
SIMULATOR
NUM_AGENT_TYPES

enum ChannelStatus

FILE_QUEUE_CHANNEL_ACTIVE: Capable of transferring files.
FILE_QUEUE_CHANNEL_PAUSED: Temporarily refraining from transferring files.

Enumerator:

FILE_QUEUE_CHANNEL_ACTIVE
FILE_QUEUE_CHANNEL_PAUSED

enum DataType

RAPID_BOOL:
RAPID_DOUBLE:
RAPID_FLOAT:
RAPID_INT:
RAPID_STRING:
RAPID_VEC3d:
RAPID_MAT33f:

Enumerator:

RAPID_BOOL
RAPID_DOUBLE
RAPID_FLOAT
RAPID_INT
RAPID_STRING
RAPID_VEC3d
RAPID_MAT33f

enum FileTransferStatus

RAPID_FILE_PREFETCH_PENDING:
RAPID_FILE_PREFETCHING:
RAPID_FILE_PENDING:
RAPID_FILE_ACTIVE:
RAPID_FILE_PAUSED:
RAPID_FILE_DONE:
RAPID_FILE_CANCELED:
RAPID_FILE_ERROR:

Enumerator:

RAPID_FILE_PREFETCH_PENDING
RAPID_FILE_PREFETCHING
RAPID_FILE_PENDING
RAPID_FILE_ACTIVE
RAPID_FILE_PAUSED
RAPID_FILE_DONE
RAPID_FILE_CANCELED
RAPID_FILE_ERROR

enum MessageLevel

MSG_DEBUG:
MSG_INFO:
MSG_ATTENTION: Important, but not in a bad way.
MSG_WARN: Something potentially bad happened.
MSG_ERROR: Something bad definitely happened.
MSG_CRITICAL: Something really bad happened.

Enumerator:

MSG_DEBUG
MSG_INFO
MSG_ATTENTION
MSG_WARN
MSG_ERROR
MSG_CRITICAL

enum PointSampleAttributeMode

PS_UNUSED
PS_INTENSITY: intensity of return. unsigned byte (0-255)
PS_LAYER: for multi-layer scanners. unsigned byte (0-255)
PS_ECHO: echo # for multiple returns. unsigned byte (0-255)
PS_LAYER4_ECHO4: first 4 bits are layer (0-15), second 4 bits are echo (0-15)
PS_PULSE: pulse index. unsigned byte (0-255)

Enumerator:

PS_UNUSED
PS_INTENSITY
PS_LAYER
PS_ECHO
PS_LAYER4_ECHO4
PS_PULSE

enum PointSampleXyzMode

PS_XYZ: x, y, z
PS_XYt: x, y, theta
PD_Rae: range, azimuth, elevation

Enumerator:

PS_XYZ
PS_XYt
PS_Rae

enum Priority

The default value is PRI_ASYNC, unless using the RAPID Sequencer.

PRI_LOW:
PRI_MEDIUM:
PRI_HIGH:
PRI_ASYNC:

Enumerator:

PRI_LOW
PRI_MEDIUM
PRI_HIGH
PRI_ASYNC

enum ResultType

Q_RESULT_INIT:
Q_RESULT_SUCCEEDED:
Q_RESULT_FAILED:

Enumerator:

Q_RESULT_INIT
Q_RESULT_SUCCEEDED
Q_RESULT_FAILED

enum StatusType

Q_STATUS_INIT:
Q_STATUS_OUTBOUND: SENT
Q_STATUS_LOST: SENT
Q_STATUS_INLINE: PENDING
Q_STATUS_PREEMPTED: PENDING
Q_STATUS_INPROCESS: ACTIVE
Q_STATUS_PAUSED: ACTIVE
Q_STATUS_CANCELED: COMPLETED
Q_STATUS_SUCCEEDED: COMPLETED
Q_STATUS_FAILED: COMPLETED
Q_STATUS_ALIEN_PENDING:
Q_STATUS_ALIEN_ACTIVE:
Q_STATUS_ALIEN_COMPLETED:
Q_STATUS_FORGOTTEN_BY_ROBOT:

Enumerator:

Q_STATUS_INIT
Q_STATUS_OUTBOUND
Q_STATUS_LOST
Q_STATUS_INLINE
Q_STATUS_PREEMPTED
Q_STATUS_INPROCESS
Q_STATUS_PAUSED
Q_STATUS_CANCELED
Q_STATUS_SUCCEEDED
Q_STATUS_FAILED
Q_STATUS_ALIEN_PENDING
Q_STATUS_ALIEN_ACTIVE
Q_STATUS_ALIEN_COMPLETED
Q_STATUS_FORGOTTEN_BY_ROBOT