program_api_provider.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_PROGRAM_API_PROVIDER_H
#define AUBO_SCOPE_PROGRAM_API_PROVIDER_H
 
#include <aubo_caps/domain/system_api.h>
#include <aubo_caps/domain/program/program_api.h>
#include <aubo_caps/domain/user_interface/user_interface_api.h>
 
namespace arcs {
namespace aubo_scope {
 
ARCS_CLASS_FORWARD(ProgramApiProvider);
 
/**
 * \chinese
 * 程序 API 提供者
 * 提供与程序节点相关的功能和服务访问。这包括 AuboScope 内部已有的功能，以及在
 * AuboScope 中创建要使用的额外模型元素。
 * \endchinese
 * \english
 * ProgramApiProvider
 * Provides access to functionality and services relevant for program nodes.
 * This includes what is available from within AuboScope, as well as creating
 * additional model elements to be used within AuboScope.
 * \endenglish
 */
class ProgramApiProvider
{
public:
    ProgramApiProvider(ProgramApiProvider &f);
    ProgramApiProvider(ProgramApiProvider &&f);
    virtual ~ProgramApiProvider();
 
    /**
     * \chinese
     * 提供对系统相关功能的访问
     *
     * @return SystemAPI 实例
     * \endchinese
     * \english
     * Provides access to system related functionality
     *
     * @return an instance of SystemAPI
     * \endenglish
     */
    SystemApiPtr getSystemApi();
 
    /**
     * \chinese
     * 提供对用户界面和终端用户交互相关功能的访问
     *
     * @return UserInterfaceAPI 实例
     * \endchinese
     * \english
     * Provides access to functionality related to user interface and end user
     * interaction
     *
     * @return an instance of UserInterfaceAPI
     * \endenglish
     */
    UserInterfaceApiPtr getUserInterfaceApi();
 
    /**
     * \chinese
     * 提供对程序相关功能的访问
     *
     * @return ProgramAPI 实例
     * \endchinese
     * \english
     * Provides access to functionality relevant related to programs
     *
     * @return an instance of ProgramAPI
     * \endenglish
     */
    ProgramApiPtr getProgramApi();
 
private:
    ProgramApiProvider();
    friend class DataSwitch;
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // AUBO_SCOPE_PROGRAM_API_PROVIDER_H