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);
 
/**
 * @defgroup SystemApi SystemApi(系统信息)
 * @ingroup SystemApi
 * SystemApi
 */
 
class ARCS_ABI_EXPORT SystemApi
{
public:
    SystemApi(SystemApi &f);
    SystemApi(SystemApi &&f);
    virtual ~SystemApi();
 
    /**
     * @ingroup SystemApi
     * @return the major version of Software.
     */
    int getMajorVersion();
 
    /**
     * @ingroup SystemApi
     * @return the minor version of Software.
     */
    int getMinorVersion();
 
    /**
     * @ingroup SystemApi
     * @return the bug fix version of Software.
     */
    int getBugfixVersion();
 
    /**
     * @ingroup SystemApi
     * @return the build number of Software.
     */
    int getBuildNumber();
 
    /**
     * @ingroup SystemApi
     * Returns the {@link Locale} for the system.
     *
     * @return Locale.
     */
    std::string getLocale();
 
    /**
     * @ingroup SystemApi
     * Returns the {@link Locale} for the programming language used in the
     * system.
     *
     * @return Locale.
     */
    std::string getLocaleForProgrammingLanguage();
 
    /**
     * @ingroup SystemApi
     * Returns the UnitType of the system as an enum.
     *
     * @return UnitType.
     */
    UnitType getUnitType();
 
    /**
     * @ingroup SystemApi
     *
     * @return the serial number of the robot
     */
    std::string getSerialNumber();
 
    /**
     * @ingroup SystemApi
     * @return <code>true</code> if controlling the real, physical robot and
     * <code>false</code> if in simulation mode.
     */
    bool isRealRobot();
 
    /**
     * @ingroup SystemApi
     * @return Max Positions of robot joints in radian
     */
    std::vector<double> getJointMaxPositions();
 
    /**
     * @ingroup SystemApi
     * @brief getJointMinPositions
     * @return
     */
    std::vector<double> getJointMinPositions();
 
    /**
     * @ingroup SystemApi
     * @brief getJointDefaultVelocity
     * @return
     */
    double getJointDefaultVelocity();
 
    /**
     * @ingroup SystemApi
     * @brief getJointDefaultAcceleration
     * @return
     */
    double getJointDefaultAcceleration();
 
    /**
     * @ingroup SystemApi
     * @brief getJointMaxVelocity
     * @return
     */
    std::vector<double> getJointMaxVelocity();
 
    /**
     * @ingroup SystemApi
     * @brief getJointMaxAcceleration
     * @return
     */
    std::vector<double> getJointMaxAcceleration();
 
    /**
     * @ingroup SystemApi
     * @brief getTcpDefaultVelocity
     * @return
     */
    double getTcpDefaultVelocity();
 
    /**
     * @ingroup SystemApi
     * @brief getTcpDefaultAcceleration
     * @return
     */
    double getTcpDefaultAcceleration();
 
    /**
     * @ingroup SystemApi
     * @brief getTcpMaxVelocity
     * @return
     */
    double getTcpMaxVelocity();
 
    /**
     * @ingroup SystemApi
     * @brief getTcpMaxAcceleration
     * @return
     */
    double getTcpMaxAcceleration();
 
    /**
     * @ingroup SystemApi
     * @brief getTcpMaxDistance
     * @return
     */
    double getTcpMaxDistance();
 
    /**
     * @ingroup SystemApi
     * @brief getMaxPayloadMass
     * @return
     */
    double getMaxPayloadMass();
 
    /**
     * @ingroup SystemApi
     * @brief getMaxPayloadDistance
     * @return
     */
    double getMaxPayloadDistance();
 
    /**
     * @ingroup SystemApi
     * @brief getHomeDefaultPosition
     * @return
     */
    std::vector<double> getHomeDefaultPosition();
 
    /**
     * @ingroup SystemApi
     * @brief getHomePackagePosition
     * @return
     */
    std::vector<double> getHomePackagePosition();
 
    /**
     * @ingroup SystemApi
     * @brief getRobotDhParams
     * @param is_real
     * @return
     */
    std::unordered_map<std::string, std::vector<double>> getRobotDhParams(
        bool is_real);
 
    /**
     * @ingroup SystemApi
     * @brief getToolDigitalIOConfigure
     * @return
     */
    IoConfigure getToolDigitalIOConfigure();
 
    /**
     * @ingroup SystemApi
     * @brief getStandardDigitalInputConfigure
     * @return
     */
    IoConfigure getStandardDigitalInputConfigure();
 
    /**
     * @ingroup SystemApi
     * @brief getConfigurableDigitalInputConfigure
     * @return
     */
    IoConfigure getConfigurableDigitalInputConfigure();
 
    /**
     * @ingroup SystemApi
     * @brief getStandardDigitalOutputConfigure
     * @return
     */
    IoConfigure getStandardDigitalOutputConfigure();
 
    /**
     * @ingroup SystemApi
     * @brief getConfigurableDigitalOutputConfigure
     * @return
     */
    IoConfigure getConfigurableDigitalOutputConfigure();
 
    /**
     * @ingroup SystemApi
     * @brief getStandardAnalogInputConfigure
     * @return
     */
    IoConfigure getStandardAnalogInputConfigure();
 
    /**
     * @ingroup SystemApi
     * @brief getToolAnalogInputConfigure
     * @return
     */
    IoConfigure getToolAnalogInputConfigure();
 
    /**
     * @ingroup SystemApi
     * @brief getStandardAnalogOutputConfigure
     * @return
     */
    IoConfigure getStandardAnalogOutputConfigure();
 
    /**
     * @ingroup SystemApi
     * @brief getToolAnalogOutputConfigure
     * @return
     */
    IoConfigure getToolAnalogOutputConfigure();
 
    /**
     * @ingroup SystemApi
     * @brief getStaticLinkInputConfigure
     * @return
     */
    IoConfigure getStaticLinkInputConfigure();
 
    /**
     * @ingroup SystemApi
     * @brief getStaticLinkOutputConfigure
     * @return
     */
    IoConfigure getStaticLinkOutputConfigure();
 
    /**
     * @ingroup SystemApi
     * @brief getENCConfigure
     * @return
     */
    IoConfigure getENCConfigure();
 
private:
    friend class DataSwitch;
    SystemApi();
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // SYSTEMAPI_H