CommandConstants.idl

Go to the documentation of this file.

/*
 * Copyright (c) 2009 United States Government as represented by the
 * Administrator of the National Aeronautics and Space Administration.
 * All Rights Reserved.
 */

#include "BaseTypes.idl"

module rapid {

    //   For a sample command, define the command key:
    //
    //     const String32 COMMAND = "Command";
    //
    //   Next, define a method on the command:
    //
    //     const String32 COMMAND_METHOD_FOO = "foo";
    //
    //   Finally, define method parameters:
    //
    //     const String32 COMMMAND_METHOD_FOO_PARAM_BAR = "fooParam1";
    //     const String32 COMMMAND_METHOD_FOO_DTYPE_BAR = RAPID_FLOAT;

    const String32 ADMIN = "Admin";

    const String32 ADMIN_METHOD_ECHO = "echo";

    const String32 ADMIN_METHOD_ECHO_PARAM_ECHOTEXT = "echoText";
    const DataType ADMIN_METHOD_ECHO_DTYPE_ECHOTEXT = RAPID_STRING;

    const String32 ADMIN_METHOD_SHUTDOWN = "shutdown";

    const String32 ADMIN_METHOD_NOOP = "noOp";

    const String32 ADMIN_METHOD_SETPOSITIONSAMPLEPUBLISHRATE = "setPositionSamplePublishRate";

    const String32 ADMIN_METHOD_SETPOSITIONSAMPLEPUBLISHRATE_PARAM_POSERATE = "positionSamplePublishRate";

    const DataType ADMIN_METHOD_SETPOSITIONSAMPLEPUBLISHRATE_DTYPE_POSERATE = RAPID_FLOAT;

    const String32 ADMIN_METHOD_SETJOINTSAMPLEPUBLISHRATE = "setJointSamplePublishRate";

    const String32 ADMIN_METHOD_SETJOINTSAMPLEPUBLISHRATE_PARAM_JOINTSAMPLERATE = "jointSampleRate";

    const DataType ADMIN_METHOD_SETJOINTSAMPLEPUBLISHRATE_DTYPE_JOINTSAMPLERATE = RAPID_FLOAT;

    const String32 IMAGESENSOR = "ImageSensor";

    const String32 IMAGESENSOR_METHOD_REQSENSORSTATE = "reqSensorState";

    const String32 IMAGESENSOR_METHOD_REQSENSORSTATE_PARAM_SENSORNAME = "sensorName";

    const DataType IMAGESENSOR_METHOD_REQSENSORSTATE_DTYPE_SENSORNAME = RAPID_STRING;

    const String32 IMAGESENSOR_METHOD_IMAGEACQUIRE = "imageAcquire";

    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";
    const DataType IMAGESENSOR_METHOD_IMAGEACQUIRE_DTYPE_CAMERA_TYPE = RAPID_STRING;

    const String32 IMAGESENSOR_METHOD_IMAGEACQUIRE_PARAM_CAMERA_MIME_TYPE = "mimeType";
    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";
    const DataType IMAGESENSOR_METHOD_IMAGEACQUIRE_DTYPE_COLORTYPE = RAPID_STRING;

    const String32 IMAGESENSOR_METHOD_IMAGEACQUIRE_PARAM_CAPTURE = "captureType";
    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";

    const String32 MOBILITY_METHOD_STOPALLMOTION = "stopAllMotion";

    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";
    const DataType MOBILITY_METHOD_MOVE_DTYPE_END_LOCATION = RAPID_VEC3d;

    const String32 MOBILITY_METHOD_MOVE_PARAM_END_LOCATION_TOLERANCE = "xytTolerance";
    const DataType MOBILITY_METHOD_MOVE_DTYPE_END_LOCATION_TOLERANCE = RAPID_VEC3d;

    const String32 MOBILITY_METHOD_MOVE_PARAM_HINTED_SPEED = "hintedSpeed";
    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";
    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";
    const String32 NAV_ALGO_BLIND = "RAPID_NAV_BLIND";

    const String32 FRAME_NAME_UTM    = "RAPID_UTM_FRAME";
    const String32 FRAME_NAME_SITE   = "RAPID_SITE_FRAME";
    const String32 FRAME_NAME_ROVER  = "RAPID_ROVER_FRAME";

    const String32 QUEUE = "Queue";

    const String32 QUEUE_METHOD_CANCELCURRENTTASK = "cancelCurrentTask";

    const String32 QUEUE_METHOD_CANCELALL = "cancelAll";

    const String32 QUEUE_METHOD_DELETEALL = "deleteAll";

    const String32 QUEUE_METHOD_SUSPENDONCOMPLETE = "suspendOnCompletion";

    const String32 QUEUE_METHOD_RESUME = "resume";

    const String32 ACCESSCONTROL = "AccessControl";

    const String32 ACCESSCONTROL_METHOD_REQUESTCONTROL = "requestControl";

    const String32 ACCESSCONTROL_METHOD_GRABCONTROL = "grabControl";

    const String32 ACCESSCONTROL_METHOD_RELEASECONTROL = "releaseControl";

    const String32 ACCESSCONTROL_METHOD_TRANSFERCONTROL = "transferControl";

    const String32 ACCESSCONTROL_METHOD_TRANSFERCONTROL_PARAM_RECIPIENT = "controlRecipient";

    const DataType ACCESSCONTROL_METHOD_TRANSFERCONTROL_DTYPE_RECIPIENT = RAPID_STRING;

    const String32 RAFT = "RAFT";

    const String32 RAFT_METHOD_PARAM_UUID = "uuid";
    const DataType RAFT_METHOD_DTYPE_UUID = RAPID_STRING;

    const String32 RAFT_METHOD_PARAM_PRIORITY = "priority";
    const DataType RAFT_METHOD_DTYPE_PRIORITY = RAPID_FLOAT;

    const String32 RAFT_METHOD_PARAM_KEY = "key";
    const DataType RAFT_METHOD_DTYPE_KEY = RAPID_STRING;

    const String32 RAFT_METHOD_PARAM_VALUE = "value";
    const DataType RAFT_METHOD_DTYPE_VALUE = RAPID_STRING;

    const String32 RAFT_METHOD_PARAM_CHANNELID = "channelId";
    const DataType RAFT_METHOD_DTYPE_CHANNELID = RAPID_INT;

    const String32 RAFT_METHOD_PARAM_BANDWIDTHBPS = "bandwidthBps";
    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";

    const String32 RAFT_METHOD_PUTMATCHING = "putMatching";

    const String32 RAFT_METHOD_REMOVEFILE = "removeFile";

    const String32 RAFT_METHOD_PAUSE = "pause";

    const String32 RAFT_METHOD_RESUME = "resume";

    const String32 RAFT_METHOD_SETBANDWIDTH = "setBandwidth";

};