arcs::common_interface::AuboApi类 参考

#include <aubo_api.h>

Public 成员函数
	AuboApi ()
virtual	~AuboApi ()
MathPtr	getMath ()
	获取纯数学相关接口
SystemInfoPtr	getSystemInfo ()
	获取系统信息
RuntimeMachinePtr	getRuntimeMachine ()
	获取运行时接口
RegisterControlPtr	getRegisterControl ()
	对外寄存器接口
std::vector< std::string >	getRobotNames ()
	获取机器人列表
RobotInterfacePtr	getRobotInterface (const std::string &name)
	根据名字获取 RobotInterfacePtr 接口
std::vector< std::string >	getAxisNames ()
	获取外部轴列表
AxisInterfacePtr	getAxisInterface (const std::string &name)
	获取外部轴接口
SocketPtr	getSocket ()
	获取独立 IO 模块接口
SerialPtr	getSerial ()
SyncMovePtr	getSyncMove (const std::string &name)
	获取同步运动接口
TracePtr	getTrace (const std::string &name)
	获取告警信息接口

Protected 属性
void *	d_ { nullptr }

详细描述

在文件 aubo_api.h 第 21 行定义.

构造及析构函数说明

AuboApi()

arcs::common_interface::AuboApi::AuboApi

(

)

~AuboApi()

virtual arcs::common_interface::AuboApi::~AuboApi ( )

virtual

成员函数说明

getAxisInterface()

AxisInterfacePtr arcs::common_interface::AuboApi::getAxisInterface

(

const std::string &

name

)

获取外部轴接口

参数

name

返回

getAxisNames()

std::vector< std::string > arcs::common_interface::AuboApi::getAxisNames

(

)

获取外部轴列表

getMath()

MathPtr arcs::common_interface::AuboApi::getMath

(

)

获取纯数学相关接口

返回

MathPtr对象的指针

Python函数原型

getMath(self: pyaubo_sdk.AuboApi) -> pyaubo_sdk.Math

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
MathPtr ptr = rpc_cli->getMath();

getRegisterControl()

RegisterControlPtr arcs::common_interface::AuboApi::getRegisterControl

(

)

对外寄存器接口

返回

RegisterControlPtr对象的指针

Python函数原型

getRegisterControl(self: pyaubo_sdk.AuboApi) -> pyaubo_sdk.RegisterControl

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
RegisterControlPtr ptr = rpc_cli->getRegisterControl();

getRobotInterface()

RobotInterfacePtr arcs::common_interface::AuboApi::getRobotInterface

(

const std::string &

name

)

根据名字获取 RobotInterfacePtr 接口

参数

name

机器人名字

返回

RobotInterfacePtr对象的指针

Python函数原型

getRobotInterface(self: pyaubo_sdk.AuboApi, arg0: str) -> pyaubo_sdk.RobotInterface

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();
RobotInterfacePtr ptr = rpc_cli->getRobotInterface(robot_name);

getRobotNames()

std::vector< std::string > arcs::common_interface::AuboApi::getRobotNames

(

)

获取机器人列表

返回

机器人列表

Python函数原型

getRobotNames(self: pyaubo_sdk.AuboApi) -> List[str]

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
auto robot_name = rpc_cli->getRobotNames().front();

JSON-RPC请求示例

{"jsonrpc":"2.0","method":"getRobotNames","params":[],"id":1}

JSON-RPC响应示例

{"id":1,"jsonrpc":"2.0","result":["rob1"]}

getRuntimeMachine()

RuntimeMachinePtr arcs::common_interface::AuboApi::getRuntimeMachine

(

)

获取运行时接口

返回

RuntimeMachinePtr对象的指针

Python函数原型

getRuntimeMachine(self: pyaubo_sdk.AuboApi) -> pyaubo_sdk.RuntimeMachine

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
RuntimeMachinePtr ptr = rpc_cli->getRuntimeMachine();

getSerial()

SerialPtr arcs::common_interface::AuboApi::getSerial

(

)

返回

SerialPtr对象的指针

Python函数原型

getSerial(self: pyaubo_sdk.AuboApi) -> arcs::common_interface::Serial

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
SerialPtr ptr = rpc_cli->getSerial();

getSocket()

SocketPtr arcs::common_interface::AuboApi::getSocket

(

)

获取独立 IO 模块接口

获取 socket

返回

SocketPtr对象的指针

Python函数原型

getSocket(self: pyaubo_sdk.AuboApi) -> arcs::common_interface::Socket

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
SocketPtr ptr = rpc_cli->getSocket();

getSyncMove()

SyncMovePtr arcs::common_interface::AuboApi::getSyncMove

(

const std::string &

name

)

获取同步运动接口

返回

SyncMovePtr对象的指针

getSystemInfo()

SystemInfoPtr arcs::common_interface::AuboApi::getSystemInfo

(

)

获取系统信息

返回

SystemInfoPtr对象的指针

Python函数原型

getSystemInfo(self: pyaubo_sdk.AuboApi) -> pyaubo_sdk.SystemInfo

C++示例

auto rpc_cli = std::make_shared<RpcClient>();
SystemInfoPtr ptr = rpc_cli->getSystemInfo();

getTrace()

TracePtr arcs::common_interface::AuboApi::getTrace

(

const std::string &

name

)

获取告警信息接口

返回

TracePtr对象的指针

类成员变量说明

d_

void* arcs::common_interface::AuboApi::d_ { nullptr }

protected

在文件 aubo_api.h 第 350 行定义.

---

该类的文档由以下文件生成:

• include/aubo/aubo_api.h