installation_api.h

Go to the documentation of this file.

#ifndef AUBO_SCOPE_INSTALLATION_API_H
#define AUBO_SCOPE_INSTALLATION_API_H
 
#include <aubo_caps/domain/application_api.h>
#include <aubo_caps/domain/function/function_model.h>
#include <aubo_caps/domain/tcp/tcp_contribution_model.h>
#include <aubo_caps/domain/feature/feature_contribution_model.h>
#include <aubo_caps/domain/payload/payload_contribution_model.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(InstallationApi);
 
/**
 * \chinese
 * @defgroup InstallationApi InstallationApi(安装)
 * @ingroup InstallationApi
 * 安装接口
 * 提供与安装相关的功能和服务访问。这包括 AuboScope 内部已有的功能，以及在
 * AuboScope 中创建要使用的额外模型元素。
 * \endchinese
 * \english
 * @defgroup InstallationApi InstallationApi
 * @ingroup InstallationApi
 * InstallationApi
 * Provides access to functionality and services related to the installation.
 * This includes what is available from within AuboScope, as well as creating
 * additional model elements to be used within AuboScope.
 * \endenglish
 */
class ARCS_ABI_EXPORT InstallationApi : public ApplicationApi
{
public:
    InstallationApi(InstallationApi &f);
    InstallationApi(InstallationApi &&f);
    virtual ~InstallationApi();
 
    /**
     * @ingroup InstallationApi
     * \chinese
     * 获取向AuboScope添加脚本功能的接口
     * @return 用于添加脚本功能的接口。
     * \endchinese
     * \english
     * Returns an interface for adding script functions to AuboScope.
     * @return An interface for adding script functions to AuboScope.
     * \endenglish
     */
    FunctionModelPtr getFunctionModel();
 
    /**
     * @ingroup InstallationApi
     * \chinese
     * 获取向AuboScope贡献TCP的接口
     * @return 用于贡献TCP的接口。
     * \endchinese
     * \english
     * Returns an interface for contributing TCPs to AuboScope.
     * @return An interface for contributing TCPs to AuboScope.
     * \endenglish
     */
    TcpContributionModelPtr getTcpContributionModel();
 
    /**
     * @ingroup InstallationApi
     * \chinese
     * 获取向AuboScope贡献特征的接口
     * @return 用于贡献特征的接口。
     * \endchinese
     * \english
     * Returns an interface for contributing features to AuboScope.
     * @return An interface for contributing features to AuboScope.
     * \endenglish
     */
    FeatureContributionModelPtr getFeatureContributionModel();
 
    /**
     * @ingroup InstallationApi
     * \chinese
     * <p>
     * 获取向AuboScope安装贡献负载的接口。
     * </p>
     *
     * @return 用于贡献负载的接口。
     * \endchinese
     * \english
     * <p>
     * Gets an interface which provides functionality for contributing payloads
     * to the AuboScope installation.
     * </p>
     *
     * @return An interface for contributing payloads to AuboScope.
     * \endenglish
     */
    PayloadContributionModelPtr getPayloadContributionModel();
 
private:
    friend class DataSwitch;
    InstallationApi();
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // AUBO_SCOPE_INSTALLATION_API_H