ControlParameterInterface.h File Reference

Types to allow remote access of control parameters, for use with LCM/Shared memory. More...

#include <map>
#include "ControlParameters.h"

Include dependency graph for ControlParameterInterface.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	ControlParameterRequest
struct	ControlParameterResponse

Enumerations
enum	ControlParameterRequestKind { ControlParameterRequestKind::GET_ROBOT_PARAM_BY_NAME, ControlParameterRequestKind::SET_ROBOT_PARAM_BY_NAME, ControlParameterRequestKind::GET_USER_PARAM_BY_NAME, ControlParameterRequestKind::SET_USER_PARAM_BY_NAME }

Functions
std::string	controlParameterRequestKindToString (ControlParameterRequestKind request)

Detailed Description

Types to allow remote access of control parameters, for use with LCM/Shared memory.

There are response/request messages. The robot receives request messages and responds with response messages The request messages either request setting a parameter or getting a parameter

Definition in file ControlParameterInterface.h.

Enumeration Type Documentation

enum ControlParameterRequestKind

strong

Enumerator
GET_ROBOT_PARAM_BY_NAME
SET_ROBOT_PARAM_BY_NAME
GET_USER_PARAM_BY_NAME
SET_USER_PARAM_BY_NAME

Definition at line 16 of file ControlParameterInterface.h.

                                       {
  GET_ROBOT_PARAM_BY_NAME,
  SET_ROBOT_PARAM_BY_NAME,
  GET_USER_PARAM_BY_NAME,
  SET_USER_PARAM_BY_NAME
};

Function Documentation

std::string controlParameterRequestKindToString

(

ControlParameterRequestKind

request

)

Definition at line 3 of file ControlParameterInterface.cpp.

References GET_ROBOT_PARAM_BY_NAME, GET_USER_PARAM_BY_NAME, SET_ROBOT_PARAM_BY_NAME, and SET_USER_PARAM_BY_NAME.

                                         {
  switch (request) {
    case ControlParameterRequestKind::GET_USER_PARAM_BY_NAME:
      return "get user";
    case ControlParameterRequestKind::SET_USER_PARAM_BY_NAME:
      return "set user";
    case ControlParameterRequestKind::GET_ROBOT_PARAM_BY_NAME:
      return "get robot";
    case ControlParameterRequestKind::SET_ROBOT_PARAM_BY_NAME:
      return "set robot";
    default:
      return "unknown";
  }
}