program_node_contribution.h

浏览该文件的文档.

#ifndef AUBO_SCOPE_PROGRAM_NODE_CONTRIBUTION_H
#define AUBO_SCOPE_PROGRAM_NODE_CONTRIBUTION_H
 
#include <string>
#include <aubo_caps/contribution/program/program_creation_context.h>
#include <aubo_caps/domain/script/script_writer.h>
 
namespace arcs {
namespace aubo_scope {
ARCS_CLASS_FORWARD(ProgramNodeContribution);
 
/**
 * \chinese
 * 程序节点贡献
 * 定义了在 AuboScope 中指定 AuboCap 程序节点所需的 API。
 * \endchinese
 * \english
 * ProgramNodeContribution
 * Defines an API required for specifying a AuboCap Program Node within
 * AuboScope.
 * \endenglish
 */
class ProgramNodeContribution
{
public:
    virtual ~ProgramNodeContribution() = default;
 
    /**
     * \chinese
     * 当此节点在程序树中被选中时调用。
     * \endchinese
     * \english
     * Called when this node is selected in the program tree.
     * \endenglish
     */
    virtual void openView() = 0;
 
    /**
     * \chinese
     * 当此节点在程序树中被取消选中或导航到其他视图时调用。
     * \endchinese
     * \english
     * Called when this node is unselected in the program tree or when
     * navigating to another view.
     * \endenglish
     */
    virtual void closeView() = 0;
 
    /**
     * \chinese
     * @return 程序树中为此程序节点显示的文本。
     * @throws IllegalStateException 如果数据模型或子程序子树被修改
     * \endchinese
     * \english
     * @return The text displayed in the Program Tree for the program node.
     * @throws IllegalStateException if the data model or child program
     * sub-tree is modified
     * \endenglish
     */
    virtual std::string getTitle() = 0;
 
    /**
     * \chinese
     * <p>
     * 如果此程序节点完整，应返回 <code>true</code>，否则返回 <code>false</code>。
     * </p>
     *
     * <p>
     * 未定义的程序节点将在程序树中以黄色标记。只要程序包含一个或多个未定义的
     * 程序节点，用户就无法启动程序。
     * </p>
     *
     * 如果此程序节点在其 DataModel 中存储了不可解析的实体（例如
     * PersistedVariable 或 TCP），则该程序节点将被视为未定义。
     *
     * @return 如果此程序节点完整则返回 <code>true</code>，否则返回
     * <code>false</code>。
     * @throws IllegalStateException 如果数据模型或子程序子树被修改
     * \endchinese
     * \english
     * <p>
     * Should return <code>true</code> if this program node is complete, and
     * <code>false</code> otherwise.
     * </p>
     *
     * <p>
     * Undefined program nodes will be marked with yellow in the program
     * tree. The user cannot start the program as long as it contains one or
     * more undefined program nodes.
     * </p>
     *
     * If this program node stores an unresolvable entity (e.g. {@link
     * variable/PersistedVariable} or {@link tcp/TCP}) in its DataModel, the
     * program node will be treated as undefined.
     *
     * @return <code>true</code> if this program node is complete and otherwise
     * <code>false</code>.
     * @throws IllegalStateException if the data model or child program
     * sub-tree is modified.
     * \endenglish
     */
    virtual bool isDefined() = 0;
 
    /**
     * \chinese
     * 定义此程序节点在程序中要生成的脚本代码。
     *
     * @param script_writer 用于添加定义此程序节点行为的脚本命令
     * \endchinese
     * \english
     * Defines the script code to be generated by this program node within
     * the program.
     *
     * @param script_writer serves to add script commands that define the behaviour
     * of this program node.
     * \endenglish
     */
    virtual void generateScript(ScriptWriterPtr script_writer) = 0;
 
    /**
     * \chinese
     * @brief postAction 发送 HTTP POST 请求
     * @param pattern URL 模式
     * @param body 请求体
     * @return 响应内容
     * \endchinese
     * \english
     * @brief post
     * @param pattern
     * @param body
     * @return
     * \endenglish
     */
    virtual std::string postAction(const char *pattern, const std::string &body)
    {
        return "";
    }
 
    /**
     * \chinese
     * @brief getAction 发送 HTTP GET 请求
     * @param pattern URL 模式
     * @param body 请求体
     * @return 响应内容
     * \endchinese
     * \english
     * @brief GET
     * @param pattern
     * @param body
     * @return
     * \endenglish
     */
    virtual std::string getAction(const char *pattern, const std::string &body)
    {
        return "";
    }
};
 
} // namespace aubo_scope
} // namespace arcs
 
#endif // AUBO_SCOPE_PROGRAM_NODE_CONTRIBUTION_H