program_model.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_PROGRAM_MODEL_H
#define AUBO_SCOPE_PROGRAM_MODEL_H
 
#include <aubo_caps/domain/program/structure/tree_node.h>
#include <aubo_caps/contribution/program/program_node_contribution.h>
#include <aubo_caps/domain/program/nodes/program_node_factory.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(ProgramModel);
 
/**
 * @ingroup ProgramApi
 * \chinese
 * 程序模型
 * <h1>概述</h1>
 * 此接口使得修改 AuboStudio 插件的子树成为可能。树的结构与节点的内容相分离。
 * {@link TreeNode} 接口关注树的结构，而 {@link ProgramNode} 接口处理树节点的具体内容。
 *
 * <h1>程序修改入门</h1>
 * ProgramModel 包含：
 * <ul>
 *     <li>getProgramNodeFactory() - 可以创建新的程序节点（包括 AuboScope
 * 内置节点和 AuboCap 程序节点）。</li>
 *     <li>getRootTreeNode(ProgramNodeContribution root) - 返回给定 AuboCap
 * ProgramNodeContribution 的子树</li>
 * </ul>
 *
 * TreeNode 接口支持节点的插入和删除。使用它可以获取特定节点的子节点列表。对树节点
 * 调用 lockChildSequence 会锁定该节点下的直接子节点。即终端用户无法重新排列、删除
 * 子节点或将其他节点插入到子节点序列中。
 * \endchinese
 * \english
 * ProgramModel
 * <h1>Summary</h1>
 * This interface makes it possible to modify sub-trees of aubo_studio plugins.
 * The structure of trees is separated from the contents of the nodes.
 * The {@link TreeNode} interface is concerned with the structure of trees
 * whereas the {@link ProgramNode} interface deals with the concrete content of
 * the nodes of the tree.
 *
 * <h1>Getting started with program modification</h1>
 * A ProgramModel contains a:
 * <ul>
 *     <li>getProgramNodeFactory() - that makes it possible to create new
 * program nodes (both built-in AuboScope nodes and AuboCap program nodes).
 * </li> <li>getRootTreeNode(ProgramNodeContribution root)} - returns the
 * sub-tree of a given AuboCap ProgramNodeContribution</li>
 * </ul>
 *
 * The TreeNode interface supports insertion and removal of nodes. With it you
 * can retrieve the list of children of particular nodes. Calling
 * lockChildSequence on a tree node, locks the immediate children under the
 * node. I.e. children can not be rearranged, deleted or have other nodes
 * inserted into the child sequence by the end user.
 * \endenglish
 */
class ARCS_ABI_EXPORT ProgramModel
{
public:
    ProgramModel(ProgramModel &f);
    ProgramModel(ProgramModel &&f);
    virtual ~ProgramModel();
 
    /**
     * \chinese
     * 返回一个 ProgramNodeFactory 用于创建程序节点。
     *
     * @return 用于创建程序节点的工厂
     * \endchinese
     * \english
     * This method returns a {@link ProgramNodeFactory} to create program nodes.
     *
     * @return the factory to create program nodes.
     * \endenglish
     */
    ProgramNodeFactoryPtr getProgramNodeFactory();
 
    /**
     * \chinese
     * 从 ProgramNodeContribution 获取 TreeNode 根节点。从这里可以添加子节点
     * 以形成子树。
     *
     * @param root 要作为子树根的 AuboCap 程序节点
     * @return TreeNode 根节点
     * \endchinese
     * \english
     * Gets the {@link TreeNode} root from {@link ProgramNodeContribution}. From
     * here, children can be added to form a sub-tree.
     *
     * @param root The AuboCap program node where a sub-tree is to be rooted.
     * @return Returns a {@link TreeNode} root.
     * \endenglish
     */
    TreeNodePtr getTreeNode(ProgramNodeContribution *root);
 
private:
    friend class DataSwitch;
    ProgramModel();
    void *d_{ nullptr };
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // AUBO_SCOPE_PROGRAM_MODEL_H