program_node_service.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_PROGRAM_NODE_SERVICE_H
#define AUBO_SCOPE_PROGRAM_NODE_SERVICE_H
 
#include <aubo_caps/contribution/view_api_provider.h>
#include <aubo_caps/contribution/program/program_node_view.h>
#include <aubo_caps/contribution/program/program_creation_context.h>
#include <aubo_caps/contribution/program/program_api_provider.h>
#include <aubo_caps/contribution/program/program_contribution_configuration.h>
#include <aubo_caps/domain/data/data_model.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(ProgramNodeService);
 
/**
 * \chinese
 * 程序节点服务
 * 定义了向 AuboScope 添加新类型程序节点所需的 API。
 * \endchinese
 * \english
 * ProgramNodeService
 * Defines an API required for adding a new type of program node to AuboScope.
 * \endenglish
 */
class ProgramNodeService
{
public:
    virtual ~ProgramNodeService() = default;
 
    /**
     * \chinese
     * 获取此类程序节点的唯一标识符。该标识符将在存储使用此程序节点的程序时使用。
     *
     * @return 唯一标识符
     * \endchinese
     * \english
     * Get the unique identifier for this kind of program node. The identifier
     * will be used when storing programs that use the program node.
     *
     * @return the unique identifier.
     * \endenglish
     */
    virtual std::string getId() = 0;
 
    /**
     * \chinese
     * @return 通过此工厂创建的程序节点在结构标签页中显示的文本
     * \endchinese
     * \english
     * @return The text displayed in the Structure Tab for program nodes created
     * by this factory.
     * \endenglish
     */
    virtual std::string getTitle() = 0;
 
    /**
     * \chinese
     * @return 通过此工厂创建的程序节点显示的图标
     * \endchinese
     * \english
     * @return The icon displayed for program nodes created by this factory.
     * \endenglish
     */
    virtual std::string getIcon() = 0;
 
    /**
     * \chinese
     * 配置贡献，设置程序节点的属性和行为。
     * @param configuration 贡献配置对象
     * \endchinese
     * \english
     * configureContribution
     * @param configuration
     * \endenglish
     */
    virtual void configureContribution(
        ProgramContributionConfigurationPtr configuration) = 0;
 
    /**
     * \chinese
     * 创建一个新的视图实例，实现程序节点画面的 UI。在加载或创建新程序时调用一次。
     *
     * @param api_provider 提供对 AuboScope 中与用户界面和终端用户交互相关的
     * 功能和服务访问
     * @return 视图
     * \endchinese
     * \english
     * Creates a new View instance which implements the UI for your program node
     * screen. Called once when a new program 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 ProgramNodeViewPtr createView(ViewApiProviderPtr api_provider) = 0;
 
    /**
     * \chinese
     * <p>
     * 创建一个新的程序节点贡献实例。
     * </p>
     *
     * <p>
     * 返回的节点必须使用提供的数据模型对象来检索和存储其中包含的数据。
     * 加载或复制/粘贴现有程序节点时，将忽略程序节点构造函数对提供的数据模型
     * 所做的所有修改。对模型对象的每次更改都将在程序树中注册为一个单独的
     * 撤销/重做事件。
     * </p>
     *
     * @param api_provider 提供对 AuboScope 中可用的域数据相关功能的访问
     * @param view 程序节点视图
     * @param model 新程序节点实例的所有配置数据存储和检索的数据模型对象
     * @param context 创建上下文
     * @return 新构建的程序节点贡献实例
     * \endchinese
     * \english
     * <p>
     * Creates a new program node contribution 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 program node constructor are ignored when an existing
     * program node is loaded or copy/pasted. Every change to the model object
     * is registered as a separate undo/redo event in the program tree.
     * </p>
     *
     * @param api_provider the AuboCap API object with access to domain data
     * @param view the View created by createView
     * @param model object where all configuration data of the new program node
     * instance is to be stored in and retrieved from
     * @param context the creation context
     * @return the newly constructed program node contribution instance
     * \endenglish
     */
    virtual ProgramNodeContributionPtr createNode(
        ProgramApiProviderPtr api_provider, ProgramNodeViewPtr view,
        DataModelPtr model, ProgramCreationContextPtr context) = 0;
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // AUBO_SCOPE_PROGRAM_NODE_SERVICE_H