system_api.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_SYSTEM_API_H
#define AUBO_SCOPE_SYSTEM_API_H
 
#include <string>
#include <vector>
#include <unordered_map>
#include <aubo_caps/class_forward.h>
 
namespace arcs {
namespace aubo_scope {
 
enum class UnitType
{
    METRIC,  ///< 公制 mm Kg
    IMPERIAL ///< 英制
};
 
struct IoConfigure
{
    std::string label;
    int num;
    std::vector<std::string> names;
    std::vector<int> sequences;
    std::vector<int> functions;
    std::vector<int> safety_functions;
    std::vector<int> safety_functions_fixed;
    bool function_lock{ false };
    std::vector<int> types;
    std::vector<double> mins;
    std::vector<double> maxs;
};
 
ARCS_CLASS_FORWARD(SystemApi);
 
/**
 * \chinese 
 * @defgroup SystemApi SystemApi(系统信息)
 * @ingroup SystemApi
 * 系统信息接口
 * 提供对 AuboScope 软件系统信息的访问，包括软件版本号、系统语言区域、单位制、机器人
 * 序列号，以及机器人的关节位置范围、速度、加速度和负载等参数信息。
 * \endchinese
 * \english
 * @defgroup SystemApi SystemApi
 * @ingroup SystemApi
 * SystemApi
 * Provides access to system information of the AuboScope software, including
 * software version numbers, system locale, unit types, the robot serial number,
 * as well as robot joint position limits, velocity, acceleration, and payload
 * parameters.
 * \endenglish
 */
 
class ARCS_ABI_EXPORT SystemApi
{
public:
    SystemApi(SystemApi &f);
    SystemApi(SystemApi &&f);
    virtual ~SystemApi();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取软件版本号
     * @return 版本号。
     * \endchinese
     * \english
     * Get the version of Software.
     * @return the major version of Software.
     * \endenglish
     * 
     */
    int getMajorVersion();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取软件次版本号
     * @return 次版本号。
     * \endchinese
     * \english
     * Get the minor version of Software.
     * @return the minor version of Software.
     * \endenglish
     */
    int getMinorVersion();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取软件Bug修复版本号
     * @return Bug修复版本号。
     * \endchinese
     * \english
     * Get the bug fix version of Software.
     * @return the bug fix version of Software.
     * \endenglish
     */
    int getBugfixVersion();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取软件构建号
     * @return 构建号。
     * \endchinese
     * \english
     * Get the build number of Software.
     * @return the build number of Software.
     * \endenglish
     */
    int getBuildNumber();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 返回系统的{@link Locale}语言区域设置。
     *
     * @return 语言区域。
     * \endchinese
     * \english
     * Returns the {@link Locale} for the system.
     *
     * @return Locale.
     * \endenglish
     */
    std::string getLocale();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 返回系统中编程语言使用的{@link Locale}语言区域设置。
     *
     * @return 语言区域。
     * \endchinese
     * \english
     * Returns the {@link Locale} for the programming language used in the
     * system.
     *
     * @return Locale.
     * \endenglish
     */
    std::string getLocaleForProgrammingLanguage();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 以枚举类型返回系统的单位制。
     *
     * @return 单位制枚举。
     * \endchinese
     * \english
     * Returns the UnitType of the system as an enum.
     *
     * @return UnitType.
     * \endenglish
     */
    UnitType getUnitType();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取机器人的序列号
     * @return 序列号。
     * \endchinese
     * \english
     * Returns the serial number of the robot.
     * @return the serial number of the robot.
     * \endenglish
     */
    std::string getSerialNumber();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 检查是否控制真实机器人
     * @return <code>true</code> 表示控制真实物理机器人，<code>false</code> 表示处于仿真模式。
     * \endchinese
     * \english
     * Returns <code>true</code> if controlling the real, physical robot and
     * <code>false</code> if in simulation mode.
     * @return <code>true</code> if controlling the real, physical robot and
     * <code>false</code> if in simulation mode.
     * \endenglish
     */
    bool isRealRobot();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取机器人各关节的最大位置
     * @return 各关节最大位置，单位为弧度。
     * \endchinese
     * \english
     * Returns the max positions of robot joints.
     * @return Max Positions of robot joints in radian.
     * \endenglish
     */
    std::vector<double> getJointMaxPositions();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取机器人各关节的最小位置
     * @return 各关节最小位置，单位为弧度。
     * \endchinese
     * \english
     * Returns the min positions of robot joints.
     * @return Min Positions of robot joints in radian.
     * \endenglish
     */
    std::vector<double> getJointMinPositions();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取关节默认速度
     * @return 关节默认速度。
     * \endchinese
     * \english
     * Returns the default velocity of robot joints.
     * @return the default velocity of robot joints.
     * \endenglish
     */
    double getJointDefaultVelocity();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取关节默认加速度
     * @return 关节默认加速度。
     * \endchinese
     * \english
     * Returns the default acceleration of robot joints.
     * @return the default acceleration of robot joints.
     * \endenglish
     */
    double getJointDefaultAcceleration();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取各关节最大速度
     * @return 各关节最大速度。
     * \endchinese
     * \english
     * Returns the max velocity of robot joints.
     * @return the max velocity of robot joints.
     * \endenglish
     */
    std::vector<double> getJointMaxVelocity();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取各关节最大加速度
     * @return 各关节最大加速度。
     * \endchinese
     * \english
     * Returns the max acceleration of robot joints.
     * @return the max acceleration of robot joints.
     * \endenglish
     */
    std::vector<double> getJointMaxAcceleration();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取TCP默认速度
     * @return TCP默认速度。
     * \endchinese
     * \english
     * Returns the default velocity of TCP.
     * @return the default velocity of TCP.
     * \endenglish
     */
    double getTcpDefaultVelocity();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取TCP默认加速度
     * @return TCP默认加速度。
     * \endchinese
     * \english
     * Returns the default acceleration of TCP.
     * @return the default acceleration of TCP.
     * \endenglish
     */
    double getTcpDefaultAcceleration();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取TCP最大速度
     * @return TCP最大速度。
     * \endchinese
     * \english
     * Returns the max velocity of TCP.
     * @return the max velocity of TCP.
     * \endenglish
     */
    double getTcpMaxVelocity();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取TCP最大加速度
     * @return TCP最大加速度。
     * \endchinese
     * \english
     * Returns the max acceleration of TCP.
     * @return the max acceleration of TCP.
     * \endenglish
     */
    double getTcpMaxAcceleration();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取TCP最大移动距离
     * @return TCP最大距离。
     * \endchinese
     * \english
     * Returns the max distance of TCP.
     * @return the max distance of TCP.
     * \endenglish
     */
    double getTcpMaxDistance();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取最大负载质量
     * @return 最大负载质量。
     * \endchinese
     * \english
     * Returns the max payload mass.
     * @return the max payload mass.
     * \endenglish
     */
    double getMaxPayloadMass();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取最大负载距离
     * @return 最大负载距离。
     * \endchinese
     * \english
     * Returns the max payload distance.
     * @return the max payload distance.
     * \endenglish
     */
    double getMaxPayloadDistance();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取默认Home位置
     * @return 默认Home位置关节角度。
     * \endchinese
     * \english
     * Returns the default home position.
     * @return the default home position.
     * \endenglish
     */
    std::vector<double> getHomeDefaultPosition();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取包装Home位置
     * @return 包装Home位置关节角度。
     * \endchinese
     * \english
     * Returns the package home position.
     * @return the package home position.
     * \endenglish
     */
    std::vector<double> getHomePackagePosition();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取机器人DH参数
     * @param is_real 是否获取真实参数。
     * @return DH参数表。
     * \endchinese
     * \english
     * Returns the robot DH parameters.
     * @param is_real whether to get the real parameters.
     * @return the DH parameters.
     * \endenglish
     */
    std::unordered_map<std::string, std::vector<double>> getRobotDhParams(
        bool is_real);
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取工具端数字IO配置
     * @return 工具端数字IO配置。
     * \endchinese
     * \english
     * Returns the tool digital I/O configuration.
     * @return the tool digital I/O configuration.
     * \endenglish
     */
    IoConfigure getToolDigitalIOConfigure();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取标准数字输入配置
     * @return 标准数字输入配置。
     * \endchinese
     * \english
     * Returns the standard digital input configuration.
     * @return the standard digital input configuration.
     * \endenglish
     */
    IoConfigure getStandardDigitalInputConfigure();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取可配置数字输入配置
     * @return 可配置数字输入配置。
     * \endchinese
     * \english
     * Returns the configurable digital input configuration.
     * @return the configurable digital input configuration.
     * \endenglish
     */
    IoConfigure getConfigurableDigitalInputConfigure();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取标准数字输出配置
     * @return 标准数字输出配置。
     * \endchinese
     * \english
     * Returns the standard digital output configuration.
     * @return the standard digital output configuration.
     * \endenglish
     */
    IoConfigure getStandardDigitalOutputConfigure();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取可配置数字输出配置
     * @return 可配置数字输出配置。
     * \endchinese
     * \english
     * Returns the configurable digital output configuration.
     * @return the configurable digital output configuration.
     * \endenglish
     */
    IoConfigure getConfigurableDigitalOutputConfigure();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取标准模拟输入配置
     * @return 标准模拟输入配置。
     * \endchinese
     * \english
     * Returns the standard analog input configuration.
     * @return the standard analog input configuration.
     * \endenglish
     */
    IoConfigure getStandardAnalogInputConfigure();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取工具端模拟输入配置
     * @return 工具端模拟输入配置。
     * \endchinese
     * \english
     * Returns the tool analog input configuration.
     * @return the tool analog input configuration.
     * \endenglish
     */
    IoConfigure getToolAnalogInputConfigure();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取标准模拟输出配置
     * @return 标准模拟输出配置。
     * \endchinese
     * \english
     * Returns the standard analog output configuration.
     * @return the standard analog output configuration.
     * \endenglish
     */
    IoConfigure getStandardAnalogOutputConfigure();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取工具端模拟输出配置
     * @return 工具端模拟输出配置。
     * \endchinese
     * \english
     * Returns the tool analog output configuration.
     * @return the tool analog output configuration.
     * \endenglish
     */
    IoConfigure getToolAnalogOutputConfigure();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取静态链路输入配置
     * @return 静态链路输入配置。
     * \endchinese
     * \english
     * Returns the static link input configuration.
     * @return the static link input configuration.
     * \endenglish
     */
    IoConfigure getStaticLinkInputConfigure();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取静态链路输出配置
     * @return 静态链路输出配置。
     * \endchinese
     * \english
     * Returns the static link output configuration.
     * @return the static link output configuration.
     * \endenglish
     */
    IoConfigure getStaticLinkOutputConfigure();
 
    /**
     * @ingroup SystemApi
     * \chinese
     * 获取编码器配置
     * @return 编码器配置。
     * \endchinese
     * \english
     * Returns the encoder configuration.
     * @return the encoder configuration.
     * \endenglish
     */
    IoConfigure getENCConfigure();
 
private:
    friend class DataSwitch;
    SystemApi();
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // SYSTEMAPI_H