installation_node_service.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_INSTALLATION_SERVICE_H
#define AUBO_SCOPE_INSTALLATION_SERVICE_H
 
#include <string>
#include <aubo_caps/domain/data/data_model.h>
#include <aubo_caps/contribution/view_api_provider.h>
#include <aubo_caps/contribution/installation/installation_node_view.h>
#include <aubo_caps/contribution/installation/installation_node_contribution.h>
#include <aubo_caps/contribution/installation/installation_creation_context.h>
#include <aubo_caps/contribution/installation/installation_contribution_configuration.h>
#include <aubo_caps/contribution/installation/installation_api_provider.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(InstallationNodeService);
 
/**
 * \chinese
 * 安装节点服务
 * 定义了在 AuboScope 中定义和添加安装节点及对应界面（用户界面基于 Qt）所需的 API。
 * \endchinese
 * \english
 * InstallationNodeService
 * Defines an API required for defining and adding to AuboScope an installation
 * node and corresponding screen where the user interface is Qt-based.
 * \endenglish
 */
class InstallationNodeService
{
public:
    virtual ~InstallationNodeService() = default;
 
    /**
     * \chinese
     * @param locale AuboScope 的当前语言环境，可用于支持多种语言的标题
     * @return 在安装标签页左侧导航中显示的文本以及对应安装节点画面的标题。
     * 在启动时调用一次。
     * \endchinese
     * \english
     * @param locale the current locale of AuboScope. Can be used for supporting
     * titles in several languages.
     * @return The text displayed for this installation contribution in the
     * left-hand side navigation of the Installation Tab as well as the title of
     * the corresponding installation node screen. Called once at start up.
     * \endenglish
     */
    virtual std::string getTitle() = 0;
 
    /**
     * \chinese
     * @return 此安装贡献显示的图标。在启动时调用一次。
     * \endchinese
     * \english
     * @return The icon displayed for this installation contribution. Called once
     * at start up.
     * \endenglish
     */
    virtual std::string getIcon() = 0;
 
    /**
     * \chinese
     * 此方法在服务注册后调用一次。修改 configuration 参数来配置您的贡献。
     * 配置对象将已经具有匹配大多数用例的默认属性值。
     * <p>
     * ContributionConfiguration 对象的值将在方法调用后立即读取一次。
     * 稍后更改值将不会产生任何效果，因此不要存储对配置对象的引用。
     * </p>
     * 如果默认值合适，请将此方法留空。
     *
     * @param configuration 具有默认值的可修改贡献配置
     * \endchinese
     * \english
     * This method is called once after this service is registered. Modify the
     * configuration parameter to configure your contribution. The configuration
     * object will already have default values for its properties matching most
     * use cases. <p> The values of the ContributionConfiguration object will be
     * read once immediately after this method call. Changing values at a later
     * stage will have no effect, so do not store a reference to the
     * configuration object.
     * </p>
     * If the default values are appropriate, leave this method empty.
     *
     * @param configuration a modifiable ContributionConfiguration with default
     * values
     * \endenglish
     */
    virtual void configureContribution(
        InstallationContributionConfigurationPtr configuration) = 0;
 
    /**
     * \chinese
     * 创建一个新的视图实例，实现安装节点画面的 UI。在加载或创建新安装时调用一次。
     *
     * @param api_provider 提供对 AuboScope 中与用户界面和终端用户交互相关的
     * 功能和服务访问
     * @return 视图
     * \endchinese
     * \english
     * Creates a new View instance which implements the UI for your installation
     * node screen. Called once when a new installation is loaded or created.
     *
     * @param api_provider Provides access to functionality and services
     * available from within AuboScope related to user interface and end user
     * interaction
     * @return the view
     * \endenglish
     */
    virtual InstallationNodeViewPtr createView(
        ViewApiProviderPtr api_provider) = 0;
 
    /**
     * \chinese
     * <p>创建一个新的安装节点实例。</p>
     * <p>返回的节点必须使用提供的数据模型对象来检索和存储其中包含的数据。
     * 加载现有安装时，将忽略安装节点构造函数对提供的数据模型所做的所有修改。
     * 数据模型对象在同一 AuboCap 贡献的所有安装节点之间共享。</p>
     *
     * @param api_provider 提供对 AuboScope 中与安装节点相关的功能和服务访问
     * @param view 由 createView 创建的视图
     * @param model 新安装节点实例的所有配置数据存储和检索的数据模型对象
     * @param context 创建此节点的上下文
     * @return 新构建的安装节点贡献实例
     * \endchinese
     * \english
     * <p>
     * Creates a new installation node instance.
     * </p>
     * <p>
     * The returned node must use the supplied data model object to retrieve and
     * store the data contained in it. All modifications to the supplied data
     * model from the installation node constructor are ignored when an existing
     * installation is loaded. The data model object is shared between all
     * installation nodes contributed by the same AuboCap.
     * </p>
     *
     * @param api_provider Provides access to functionality and services
     * available from within AuboScope relevant for the installation node
     * @param view the View created by {@link #createView(ViewAPIProvider)}
     * @param model object where all configuration data of the new installation
     * node instance is to be stored in and retrieved from
     * @param context the context in which this node is created
     * @return the newly constructed installation node contribution instance
     * \endenglish
     */
    virtual InstallationNodeContributionPtr createInstallationNode(
        InstallationApiProviderPtr api_provider, InstallationNodeViewPtr view,
        DataModelPtr model, InstallationCreationContextPtr context) = 0;
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif