screw_driver_api_provider.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_SCREW_DIRVER_API_PROVIDER_H
#define AUBO_SCOPE_SCREW_DIRVER_API_PROVIDER_H
 
#include <aubo_caps/domain/system_api.h>
#include <aubo_caps/domain/io/io_model.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(ScrewdriverApiProvider);
 
/**
 * \chinese
 * 螺丝刀 API 提供者
 * 此接口提供对 AuboScope 中与螺丝刀贡献相关的功能和服务的访问。
 * \endchinese
 * \english
 * ScrewdriverApiProvider
 * This interface provides access to functionality and services available from
 * within AuboScope relevant for screwdriver contributions.
 * \endenglish
 */
class ScrewdriverApiProvider
{
public:
    virtual ~ScrewdriverApiProvider() = default;
 
    /**
     * \chinese
     * @return 提供系统相关功能访问的接口
     * \endchinese
     * \english
     * @return an interface providing access to system related functionality.
     * \endenglish
     */
    virtual SystemApiPtr getSystemAPI() = 0;
 
    /**
     * \chinese
     * @return I/O 模型接口（例如用于获取在设置螺丝刀的自定义用户输入中显示的 I/O）
     * \endchinese
     * \english
     * @return an I/O model interface (e.g. for getting I/Os to display in the
     * custom user input for setting up the screwdriver)
     * \endenglish
     */
    virtual IoModelPtr getIOModel() = 0;
};
} // namespace aubo_scope
} // namespace arcs
#endif