| xCore-SDK 0.5.0 xCore SDK C# API

类 | 宏定义 | 类型定义 | 枚举 | 函数
data_types_cli.hpp 文件参考
`#include <unordered_map>`
`#include <any>`

浏览源代码.

## 类
class | rokae::clr::ErrorCode
| xCoreSDK错误码 更多...
struct | rokae::clr::DragOpt
| 机器人拖动模式参数, 包括拖动类型和空间 更多...
struct | rokae::clr::xPanelOpt
| xPanel配置 更多...
struct | rokae::clr::Info
| 机器人基本信息，在与建立机器人连接后加载 更多...
class | rokae::clr::Frame
| 坐标系 更多...
class | rokae::clr::CartesianPosition
| 笛卡尔点位 更多...
class | rokae::clr::CartesianPosition::Offset
| 偏移 更多...
class | rokae::clr::JointPosition
| 关节点位 更多...
class | rokae::clr::MoveCommand
| 非实时运动指令 更多...
class | rokae::clr::PulseLCommand
class | rokae::clr::Load
| 负载信息 更多...
class | rokae::clr::Toolset
| 工具工件组信息, 根据一对工具工件的坐标、负载、机器人手持设置计算得出 更多...
class | rokae::clr::FrameCalibrationResult
| 坐标系标定结果 更多...
class | rokae::clr::LogInfo
| 控制器日志信息 更多...
class | rokae::clr::RLProjectInfo
| RL工程信息 更多...
class | rokae::clr::WorkToolInfo
| 工具/工件信息。工件的坐标系已相对其用户坐标系变换 更多...
struct | rokae::clr::SignalBinding
| 工位预约信号绑定 更多...
class | rokae::clr::SchedEntry
| 工位预约设置项 更多...
class | rokae::clr::SchedSetting
| 预约设置, 支持8个预约设置项 更多...
struct | rokae::clr::SchedStatus
| 预约状态 更多...

## 类型定义
typedef System::Collections::Generic::Dictionary< String^, System::Object^> | rokae::clr::EventInfo
typedef void(__stdcall * | rokae::clr::EventCallbackPtr) (const std::unordered_map< std::string, std::any > &)
typedef void(__stdcall * | rokae::clr::ConnectionHandlerPtr) (bool)

## 枚举
enum class | rokae::clr::PowerState { on = 0 , off = 1 , estop = 2 , gstop = 3 , unknown = -1 }
| 机器人上下电及急停状态 更多...
enum class | rokae::clr::OperateMode { manual = 0 , automatic = 1 , unknown = -1 }
| 机器人操作模式 更多...
enum class | rokae::clr::OperationState { idle = 0 , jog = 1 , rtControlling = 2 , drag = 3 , rlProgram = 4 , demo = 5 , dynamicIdentify = 6 , frictionIdentify = 7 , loadIdentify = 8 , moving = 9 , jogging = 10 , unknown = -1 }
| 机器人工作状态 更多...
enum class | rokae::clr::CoordinateType { flangeInBase , endInRef }
| 位姿坐标系类型 更多...
enum class | rokae::clr::StopLevel { stop0 , stop1 , stop2 , suppleStop }
| 机器人停止运动等级 更多...
enum class | rokae::clr::MotionControlMode { Idle , NrtCommand , NrtRLTask , RtCommand }
| SDK运动控制模式 更多...
enum class | rokae::clr::JogSpace { world = 0 , flange , baseFrame , toolFrame , wobjFrame , jointSpace , singularityAvoidMode , baseParallelMode }
| Jog选项: 坐标系 更多...
enum class | rokae::clr::FrameType { world = 0 , baseFrame = 1 , flange = 2 , tool = 3 , wobj = 4 , path = 5 , rail = 6 }
| 笛卡尔空间坐标系类型 更多...
enum class | rokae::clr::AvoidSingularityMethod { lockAxis4 , wrist , jointWay }
| 奇异规避方式 更多...
enum class | rokae::clr::Event { moveExecution , safety , arcWeldState , rlExecution , logReporter , lasertrackState , anticollisionState , schedState , disconnectionBehaviour }
| 事件类型 更多...

## 函数
public delegate void | rokae::clr::EventCallbackDelegate (EventInfo)
public delegate void | rokae::clr::EventCallbackNativeDelegate (const std::unordered_map< std::string, std::any > &)
public delegate void | rokae::clr::ConnectionHandlerDelegate (bool)

## 详细描述

版权所有
  Copyright (C) 2024 ROKAE (Beijing) Technology Co., LTD. All Rights Reserved. Information in this file is the intellectual property of Rokae Technology Co., Ltd, And may contains trade secrets that must be stored and viewed confidentially.

在文件 data_types_cli.hpp 中定义.

## 宏定义说明

## ◆ XCORESDK_SRC_CLI_DATA_TYPES_CLI_HPP_

#define XCORESDK_SRC_CLI_DATA_TYPES_CLI_HPP_

在文件 data_types_cli.hpp 第 10 行定义.

## 类型定义说明

## ◆ ConnectionHandlerPtr

typedef void(__stdcall * rokae::clr::ConnectionHandlerPtr) (bool)

在文件 data_types_cli.hpp 第 244 行定义.

## ◆ EventCallbackPtr

typedef void(__stdcall * rokae::clr::EventCallbackPtr) (const std::unordered_map< std::string, std::any > &)

在文件 data_types_cli.hpp 第 241 行定义.

## ◆ EventInfo

typedef System::Collections::Generic::Dictionary<String^, System::Object^> rokae::clr::EventInfo

在文件 data_types_cli.hpp 第 238 行定义.

## 枚举类型说明

## ◆ AvoidSingularityMethod

enum class rokae::clr::AvoidSingularityMethod
| strong

奇异规避方式

枚举值
lockAxis4 | 四轴锁定
wrist | 牺牲姿态
jointWay | 轴空间短轨迹插补

在文件 data_types_cli.hpp 第 229 行定义.

## ◆ CoordinateType

enum class rokae::clr::CoordinateType
| strong

位姿坐标系类型

枚举值
flangeInBase | 法兰相对于基坐标系
endInRef | 末端相对于外部坐标系

在文件 data_types_cli.hpp 第 109 行定义.

## ◆ Event

enum class rokae::clr::Event
| strong

事件类型

枚举值
moveExecution | 非实时运动指令执行信息
safety | 安全 (是否碰撞)
arcWeldState | 弧焊状态
rlExecution | RL执行信息
logReporter | 控制器日志上报
lasertrackState | 激光跟踪器状态
anticollisionState | 防碰撞状态
schedState | 工位预约状态
disconnectionBehaviour | 断连行为状态

在文件 data_types_cli.hpp 第 249 行定义.

## ◆ FrameType

enum class rokae::clr::FrameType
| strong

笛卡尔空间坐标系类型

枚举值
world | 世界坐标系
baseFrame | 基坐标系
flange | 法兰坐标系
tool | 工具坐标系
wobj | 工件坐标系
path | 路径坐标系
rail | 导轨基坐标系

在文件 data_types_cli.hpp 第 169 行定义.

## ◆ JogSpace

enum class rokae::clr::JogSpace
| strong

Jog选项: 坐标系

枚举值
world | 世界坐标系
flange | 法兰坐标系
baseFrame | 基坐标系
toolFrame | 工具坐标系
wobjFrame | 工件坐标系
jointSpace | 轴空间
singularityAvoidMode | 奇异规避模式，适用于工业六轴, xMateCR和xMateSR机型，规避方法是锁定4轴
baseParallelMode | 平行基座模式，仅适用于xMateCR和xMateSR机型

在文件 data_types_cli.hpp 第 147 行定义.

## ◆ MotionControlMode

enum class rokae::clr::MotionControlMode
| strong

SDK运动控制模式

枚举值
Idle | 空闲
NrtCommand | 非实时模式执行运动指令
NrtRLTask | 非实时模式运行RL工程
RtCommand | 实时模式控制

在文件 data_types_cli.hpp 第 133 行定义.

## ◆ OperateMode

enum class rokae::clr::OperateMode
| strong

机器人操作模式

枚举值
manual | 手动
automatic | 自动
unknown | 未知(发生异常)

在文件 data_types_cli.hpp 第 67 行定义.

## ◆ OperationState

enum class rokae::clr::OperationState
| strong

机器人工作状态

枚举值
idle | 机器人静止
jog | jog状态(未运动)
rtControlling | 实时模式控制中
drag | 拖动已开启
rlProgram | RL工程运行中
demo | Demo演示中
dynamicIdentify | 动力学辨识中
frictionIdentify | 摩擦力辨识中
loadIdentify | 负载辨识中
moving | 机器人运动中
jogging | Jog运动中
unknown | 未知(异常情况)

在文件 data_types_cli.hpp 第 79 行定义.

## ◆ PowerState

enum class rokae::clr::PowerState
| strong

机器人上下电及急停状态

枚举值
on | 上电
off | 下电
estop | 急停被按下
gstop | 安全门打开
unknown | 未知(发生异常)

在文件 data_types_cli.hpp 第 51 行定义.

## ◆ StopLevel

enum class rokae::clr::StopLevel
| strong

机器人停止运动等级

枚举值
stop0 | 快速停止机器人运动后断电
stop1 | 规划停止机器人运动后断电, 停在原始路径上
stop2 | 规划停止机器人运动后不断电, 停在原始路径上
suppleStop | 柔顺停止，仅适用于协作机型

在文件 data_types_cli.hpp 第 119 行定义.