ARCS SDK API  0.25.0
载入中...
搜索中...
未找到
arcs::common_interface 命名空间参考

class  AuboApi
 
class  AuboException
 自定义异常类 AuboException 更多...
 
class  AxisInterface
 外部轴API接口 更多...
 
struct  CircleParameters
 圆周运动参数定义 更多...
 
struct  Enveloping
 
class  ForceControl
 力控接口抽象类 更多...
 
class  IoControl
 IoControl类提供了一系列的接口对机器人标配的一些数字、模拟IO进行配置,输出状态设置、读取 更多...
 
class  Math
 
class  MotionControl
 MotionControl类 更多...
 
class  RegisterControl
 通用寄存器 更多...
 
class  RobotAlgorithm
 机器人算法相关的对外接口 更多...
 
class  RobotConfig
 
class  RobotInterface
 
class  RobotManage
 
struct  RobotMsg
 
struct  RobotSafetyParameterRange
 
class  RobotState
 
struct  RtdeRecipe
 RTDE菜单 更多...
 
class  RuntimeMachine
 The RuntimeMachine class 更多...
 
class  Serial
 
class  Socket
 
struct  SpiralParameters
 
class  SyncMove
 
class  SystemInfo
 
class  Trace
 提供给控制器扩展程序的日志记录系统 更多...
 
struct  TrajConfig
 用于负载辨识的轨迹配置 更多...
 

类型定义

using AuboApiPtr = std::shared_ptr< AuboApi >
 
using AxisInterfacePtr = std::shared_ptr< AxisInterface >
 
using MathPtr = std::shared_ptr< Math >
 
using RegisterControlPtr = std::shared_ptr< RegisterControl >
 
using ForceControlPtr = std::shared_ptr< ForceControl >
 
using IoControlPtr = std::shared_ptr< IoControl >
 
using MotionControlPtr = std::shared_ptr< MotionControl >
 
using RobotAlgorithmPtr = std::shared_ptr< RobotAlgorithm >
 
using RobotConfigPtr = std::shared_ptr< RobotConfig >
 
using RobotManagePtr = std::shared_ptr< RobotManage >
 
using RobotStatePtr = std::shared_ptr< RobotState >
 
using RobotInterfacePtr = std::shared_ptr< RobotInterface >
 
using RuntimeMachinePtr = std::shared_ptr< RuntimeMachine >
 
using SerialPtr = std::shared_ptr< Serial >
 
using SocketPtr = std::shared_ptr< Socket >
 
typedef std::unordered_set< std::string > TaskSet
 
using SyncMovePtr = std::shared_ptr< SyncMove >
 
using SystemInfoPtr = std::shared_ptr< SystemInfo >
 
using TracePtr = std::shared_ptr< Trace >
 
using Vector3d = std::array< double, 3 >
 
using Vector4d = std::array< double, 4 >
 
using Vector3f = std::array< float, 3 >
 
using Vector4f = std::array< float, 4 >
 
using Vector6f = std::array< float, 6 >
 
using ResultWithErrno = std::tuple< std::vector< double >, int >
 
using ResultWithErrno1 = std::tuple< std::vector< std::vector< double > >, int >
 
using Payload = std::tuple< double, std::vector< double >, std::vector< double >, std::vector< double > >
 
using ForceSensorCalibResult = std::tuple< std::vector< double >, std::vector< double >, double, std::vector< double > >
 
using ForceSensorCalibResultWithError = std::tuple< std::vector< double >, std::vector< double >, double, std::vector< double >, double >
 
using DynamicsModel = std::tuple< std::vector< double >, std::vector< double >, std::vector< double > >
 
using Box = std::vector< double >
 
using Cylinder = std::vector< double >
 
using Sphere = std::vector< double >
 
using RobotMsgVector = std::vector< RobotMsg >
 

枚举

enum  PathBufferType {
  PathBuffer_TOPPRA = 1 , PathBuffer_CubicSpline = 2 , PathBuffer_JointSpline = 3 , PathBuffer_JointSplineC = 4 ,
  PathBuffer_JointBSpline = 5 , PathBuffer_JointBSplineC = 6
}
 pathBuffer类型 更多...
 
enum  AuboErrorCodes : int { ENUM_AuboErrorCodes_DECLARES }
 
enum class  RuntimeState : int { ENUM_RuntimeState_DECLARES }
 
enum class  RobotModeType : int { ENUM_RobotModeType_DECLARES }
 
enum class  AxisModeType : int { ENUM_AxisModeType_DECLARES }
 
enum class  SafetyModeType : int { ENUM_SafetyModeType_DECLARES }
 安全状态: 更多...
 
enum class  OperationalModeType : int { ENUM_OperationalModeType_DECLARES }
 操作模式 更多...
 
enum class  RobotControlModeType : int { ENUM_RobotControlModeType_DECLARES }
 机器人控制模式 更多...
 
enum class  JointServoModeType : int { ENUM_JointServoModeType_DECLARES }
 关节伺服模式 更多...
 
enum class  JointStateType : int { ENUM_JointStateType_DECLARES }
 关节状态 更多...
 
enum class  StandardOutputRunState : int { ENUM_StandardOutputRunState_DECLARES }
 标准输出运行状态 更多...
 
enum class  StandardInputAction : int { ENUM_StandardInputAction_DECLARES }
 The StandardInputAction enum 更多...
 
enum class  SafetyInputAction : int { ENUM_SafetyInputAction_DECLARES }
 
enum class  SafetyOutputRunState : int { ENUM_SafetyOutputRunState_DECLARES }
 
enum  TaskFrameType { ENUM_TaskFrameType_DECLARES }
 
enum  EnvelopingShape : int { ENUM_EnvelopingShape_DECLARES }
 
enum  PayloadIdentifyMoveAxis : int { ENUM_PayloadIdentifyMoveAxis_DECLARES }
 
enum  TraceLevel { ENUM_TraceLevel_DECLARES }
 
enum  SafeguedStopType : int { ENUM_SafeguedStopType_DECLARES }
 
enum class  ForceControlState { Stopped , Starting , Stropping , Running }
 
enum class  RefFrameType { None , Tool , Path , Base }
 
enum  error_type {
  parse_error = -32700 , invalid_request = -32600 , method_not_found = -32601 , invalid_params = -32602 ,
  internal_error = -32603 , server_error , invalid
}
 异常类型 更多...
 
enum  ExceptionCode {
  EC_DISCONNECTED = -1 , EC_NOT_LOGINED = -2 , EC_INVAL_SOCKET = -3 , EC_REQUEST_BUSY = -4 ,
  EC_SEND_FAILED = -5 , EC_RECV_TIMEOUT = -6 , EC_RECV_ERROR = -7 , EC_PARSE_ERROR = -8 ,
  EC_INVALID_REQUEST = -9 , EC_METHOD_NOT_FOUND = -10 , EC_INVALID_PARAMS = -11 , EC_INTERNAL_ERROR = -12 ,
  EC_SERVER_ERROR = -13 , EC_INVALID = -14
}
 异常码 更多...
 

函数

std::ostream & operator<< (std::ostream &os, const RobotSafetyParameterRange &vd)
 
std::ostream & operator<< (std::ostream &os, CircleParameters p)
 
std::ostream & operator<< (std::ostream &os, SpiralParameters p)
 
std::ostream & operator<< (std::ostream &os, Enveloping p)
 
std::ostream & operator<< (std::ostream &os, TrajConfig p)
 
const char * returnValue2Str (int retval)
 

类型定义说明

◆ AuboApiPtr

using arcs::common_interface::AuboApiPtr = typedef std::shared_ptr<AuboApi>

在文件 aubo_api.h204 行定义.

◆ AxisInterfacePtr

using arcs::common_interface::AxisInterfacePtr = typedef std::shared_ptr<AxisInterface>

在文件 axis_interface.h192 行定义.

◆ Box

using arcs::common_interface::Box = typedef std::vector<double>

在文件 type_def.h688 行定义.

◆ Cylinder

using arcs::common_interface::Cylinder = typedef std::vector<double>

在文件 type_def.h695 行定义.

◆ DynamicsModel

using arcs::common_interface::DynamicsModel = typedef std::tuple<std::vector<double>, std::vector<double>, std::vector<double> >

在文件 type_def.h679 行定义.

◆ ForceControlPtr

using arcs::common_interface::ForceControlPtr = typedef std::shared_ptr<ForceControl>

在文件 force_control.h1186 行定义.

◆ ForceSensorCalibResult

using arcs::common_interface::ForceSensorCalibResult = typedef std::tuple<std::vector<double>, std::vector<double>, double, std::vector<double> >

在文件 type_def.h669 行定义.

◆ ForceSensorCalibResultWithError

using arcs::common_interface::ForceSensorCalibResultWithError = typedef std::tuple<std::vector<double>, std::vector<double>, double, std::vector<double>, double>

在文件 type_def.h674 行定义.

◆ IoControlPtr

using arcs::common_interface::IoControlPtr = typedef std::shared_ptr<IoControl>

在文件 io_control.h2091 行定义.

◆ MathPtr

using arcs::common_interface::MathPtr = typedef std::shared_ptr<Math>

在文件 math.h504 行定义.

◆ MotionControlPtr

using arcs::common_interface::MotionControlPtr = typedef std::shared_ptr<MotionControl>

在文件 motion_control.h2062 行定义.

◆ Payload

using arcs::common_interface::Payload = typedef std::tuple<double, std::vector<double>, std::vector<double>, std::vector<double> >

在文件 type_def.h665 行定义.

◆ RegisterControlPtr

在文件 register_control.h1572 行定义.

◆ ResultWithErrno

using arcs::common_interface::ResultWithErrno = typedef std::tuple<std::vector<double>, int>

在文件 type_def.h661 行定义.

◆ ResultWithErrno1

using arcs::common_interface::ResultWithErrno1 = typedef std::tuple<std::vector<std::vector<double> >, int>

在文件 type_def.h662 行定义.

◆ RobotAlgorithmPtr

在文件 robot_algorithm.h597 行定义.

◆ RobotConfigPtr

using arcs::common_interface::RobotConfigPtr = typedef std::shared_ptr<RobotConfig>

在文件 robot_config.h1556 行定义.

◆ RobotInterfacePtr

在文件 robot_interface.h207 行定义.

◆ RobotManagePtr

using arcs::common_interface::RobotManagePtr = typedef std::shared_ptr<RobotManage>

在文件 robot_manage.h718 行定义.

◆ RobotMsgVector

using arcs::common_interface::RobotMsgVector = typedef std::vector<RobotMsg>

在文件 type_def.h712 行定义.

◆ RobotStatePtr

using arcs::common_interface::RobotStatePtr = typedef std::shared_ptr<RobotState>

在文件 robot_state.h1291 行定义.

◆ RuntimeMachinePtr

在文件 runtime_machine.h699 行定义.

◆ SerialPtr

using arcs::common_interface::SerialPtr = typedef std::shared_ptr<Serial>

在文件 serial.h238 行定义.

◆ SocketPtr

using arcs::common_interface::SocketPtr = typedef std::shared_ptr<Socket>

在文件 socket.h344 行定义.

◆ Sphere

using arcs::common_interface::Sphere = typedef std::vector<double>

在文件 type_def.h700 行定义.

◆ SyncMovePtr

using arcs::common_interface::SyncMovePtr = typedef std::shared_ptr<SyncMove>

在文件 sync_move.h200 行定义.

◆ SystemInfoPtr

using arcs::common_interface::SystemInfoPtr = typedef std::shared_ptr<SystemInfo>

在文件 system_info.h182 行定义.

◆ TaskSet

typedef std::unordered_set<std::string> arcs::common_interface::TaskSet

在文件 sync_move.h36 行定义.

◆ TracePtr

using arcs::common_interface::TracePtr = typedef std::shared_ptr<Trace>

在文件 trace.h154 行定义.

◆ Vector3d

using arcs::common_interface::Vector3d = typedef std::array<double, 3>

在文件 type_def.h29 行定义.

◆ Vector3f

using arcs::common_interface::Vector3f = typedef std::array<float, 3>

在文件 type_def.h31 行定义.

◆ Vector4d

using arcs::common_interface::Vector4d = typedef std::array<double, 4>

在文件 type_def.h30 行定义.

◆ Vector4f

using arcs::common_interface::Vector4f = typedef std::array<float, 4>

在文件 type_def.h32 行定义.

◆ Vector6f

using arcs::common_interface::Vector6f = typedef std::array<float, 6>

在文件 type_def.h33 行定义.

枚举类型说明

◆ AuboErrorCodes

枚举值
ENUM_AuboErrorCodes_DECLARES 

在文件 type_def.h425 行定义.

◆ AxisModeType

enum class arcs::common_interface::AxisModeType : int
strong
枚举值
ENUM_AxisModeType_DECLARES 

在文件 type_def.h440 行定义.

◆ EnvelopingShape

枚举值
ENUM_EnvelopingShape_DECLARES 

在文件 type_def.h517 行定义.

◆ error_type

异常类型

枚举值
parse_error 

解析错误

invalid_request 

无效请求

method_not_found 

方法未找到

invalid_params 

无效参数

internal_error 

内部错误

server_error 

服务器错误

invalid 

无效

在文件 type_def.h725 行定义.

◆ ExceptionCode

异常码

枚举值
EC_DISCONNECTED 

断开连接

EC_NOT_LOGINED 

未登录

EC_INVAL_SOCKET 

无效套接字

EC_REQUEST_BUSY 

请求繁忙

EC_SEND_FAILED 

发送失败

EC_RECV_TIMEOUT 

接收超时

EC_RECV_ERROR 

接收错误

EC_PARSE_ERROR 

解析错误

EC_INVALID_REQUEST 

无效请求

EC_METHOD_NOT_FOUND 

方法未找到

EC_INVALID_PARAMS 

无效参数

EC_INTERNAL_ERROR 

内部错误

EC_SERVER_ERROR 

服务器错误

EC_INVALID 

无效

在文件 type_def.h737 行定义.

◆ ForceControlState

枚举值
Stopped 
Starting 
Stropping 
Running 

在文件 type_def.h577 行定义.

◆ JointServoModeType

关节伺服模式

枚举值
ENUM_JointServoModeType_DECLARES 

在文件 type_def.h473 行定义.

◆ JointStateType

enum class arcs::common_interface::JointStateType : int
strong

关节状态

枚举值
ENUM_JointStateType_DECLARES 

在文件 type_def.h481 行定义.

◆ OperationalModeType

操作模式

枚举值
ENUM_OperationalModeType_DECLARES 

在文件 type_def.h457 行定义.

◆ PathBufferType

pathBuffer类型

枚举值
PathBuffer_TOPPRA 

1: toppra 时间最优路径规划

PathBuffer_CubicSpline 

2: cubic_spline(录制的轨迹)

PathBuffer_JointSpline 

3: 关节B样条插值,最少三个点 废弃,建议用5替代,现在实际是关节空间 CUBIC_SPLINE

PathBuffer_JointSplineC 

4:关节B样条插值,最少三个点,但是传入的是笛卡尔空间位姿 废弃,建议用6替代,现在实际是关节空间 CUBIC_SPLINE

5: 关节B样条插值,最少三个点

PathBuffer_JointBSpline 
PathBuffer_JointBSplineC 

6:关节B样条插值,最少三个点,但是传入的是笛卡尔空间位姿

在文件 motion_control.h24 行定义.

◆ PayloadIdentifyMoveAxis

枚举值
ENUM_PayloadIdentifyMoveAxis_DECLARES 

在文件 type_def.h522 行定义.

◆ RefFrameType

枚举值
None 
Tool 

工具坐标系

Path 

轨迹坐标系

Base 

基坐标系

在文件 type_def.h585 行定义.

◆ RobotControlModeType

机器人控制模式

枚举值
ENUM_RobotControlModeType_DECLARES 

在文件 type_def.h465 行定义.

◆ RobotModeType

enum class arcs::common_interface::RobotModeType : int
strong
枚举值
ENUM_RobotModeType_DECLARES 

在文件 type_def.h435 行定义.

◆ RuntimeState

enum class arcs::common_interface::RuntimeState : int
strong
枚举值
ENUM_RuntimeState_DECLARES 

在文件 type_def.h430 行定义.

◆ SafeguedStopType

枚举值
ENUM_SafeguedStopType_DECLARES 

在文件 type_def.h532 行定义.

◆ SafetyInputAction

枚举值
ENUM_SafetyInputAction_DECLARES 

在文件 type_def.h502 行定义.

◆ SafetyModeType

enum class arcs::common_interface::SafetyModeType : int
strong

安全状态:

枚举值
ENUM_SafetyModeType_DECLARES 

在文件 type_def.h449 行定义.

◆ SafetyOutputRunState

枚举值
ENUM_SafetyOutputRunState_DECLARES 

在文件 type_def.h507 行定义.

◆ StandardInputAction

The StandardInputAction enum

枚举值
ENUM_StandardInputAction_DECLARES 

在文件 type_def.h497 行定义.

◆ StandardOutputRunState

标准输出运行状态

枚举值
ENUM_StandardOutputRunState_DECLARES 

在文件 type_def.h489 行定义.

◆ TaskFrameType

枚举值
ENUM_TaskFrameType_DECLARES 

在文件 type_def.h512 行定义.

◆ TraceLevel

枚举值
ENUM_TraceLevel_DECLARES 

在文件 type_def.h527 行定义.

函数说明

◆ operator<<() [1/5]

std::ostream & arcs::common_interface::operator<< ( std::ostream &  os,
CircleParameters  p 
)
inline

在文件 type_def.h608 行定义.

◆ operator<<() [2/5]

std::ostream & arcs::common_interface::operator<< ( std::ostream &  os,
const RobotSafetyParameterRange vd 
)
inline

在文件 type_def.h175 行定义.

◆ operator<<() [3/5]

std::ostream & arcs::common_interface::operator<< ( std::ostream &  os,
Enveloping  p 
)
inline

在文件 type_def.h638 行定义.

◆ operator<<() [4/5]

std::ostream & arcs::common_interface::operator<< ( std::ostream &  os,
SpiralParameters  p 
)
inline

在文件 type_def.h622 行定义.

◆ operator<<() [5/5]

std::ostream & arcs::common_interface::operator<< ( std::ostream &  os,
TrajConfig  p 
)
inline

在文件 type_def.h655 行定义.

◆ returnValue2Str()

const char * arcs::common_interface::returnValue2Str ( int  retval)
inline

在文件 type_def.h790 行定义.

引用了 ENUM_AuboErrorCodes_DECLARES.