arcs::aubo_scope::ProgramNodeContribution类 参考

\chinese 程序节点贡献 定义了在 AuboScope 中指定 AuboCap 程序节点所需的 API。 \endchinese \english ProgramNodeContribution Defines an API required for specifying a AuboCap Program Node within AuboScope. 更多...

#include <program_node_contribution.h>

Public 成员函数
virtual	~ProgramNodeContribution ()=default
virtual void	openView ()=0
	\chinese 当此节点在程序树中被选中时调用。 \endchinese \english Called when this node is selected in the program tree.
virtual void	closeView ()=0
	\chinese 当此节点在程序树中被取消选中或导航到其他视图时调用。 \endchinese \english Called when this node is unselected in the program tree or when navigating to another view.
virtual std::string	getTitle ()=0
	\chinese
virtual bool	isDefined ()=0
	\chinese
virtual void	generateScript (ScriptWriterPtr script_writer)=0
	\chinese 定义此程序节点在程序中要生成的脚本代码。
virtual std::string	postAction (const char *pattern, const std::string &body)
	\chinese
virtual std::string	getAction (const char *pattern, const std::string &body)
	\chinese

详细描述

\chinese 程序节点贡献 定义了在 AuboScope 中指定 AuboCap 程序节点所需的 API。 \endchinese \english ProgramNodeContribution Defines an API required for specifying a AuboCap Program Node within AuboScope.

\endenglish

在文件 program_node_contribution.h 第 23 行定义.

构造及析构函数说明

~ProgramNodeContribution()

virtual arcs::aubo_scope::ProgramNodeContribution::~ProgramNodeContribution ( )

virtualdefault

成员函数说明

closeView()

virtual void arcs::aubo_scope::ProgramNodeContribution::closeView ( )

pure virtual

\chinese 当此节点在程序树中被取消选中或导航到其他视图时调用。 \endchinese \english Called when this node is unselected in the program tree or when navigating to another view.

\endenglish

generateScript()

virtual void arcs::aubo_scope::ProgramNodeContribution::generateScript ( ScriptWriterPtr script_writer )

pure virtual

\chinese 定义此程序节点在程序中要生成的脚本代码。

参数

script_writer	用于添加定义此程序节点行为的脚本命令 \endchinese \english Defines the script code to be generated by this program node within the program.
script_writer	serves to add script commands that define the behaviour of this program node. \endenglish

getAction()

virtual std::string arcs::aubo_scope::ProgramNodeContribution::getAction ( const char * pattern, const std::string & body )

inlinevirtual

\chinese

getAction 发送 HTTP GET 请求

参数

pattern	URL 模式
body	请求体

返回

响应内容 \endchinese \english

GET

参数

pattern
body

返回

\endenglish

在文件 program_node_contribution.h 第 153 行定义.

getTitle()

virtual std::string arcs::aubo_scope::ProgramNodeContribution::getTitle ( )

pure virtual

\chinese

返回

程序树中为此程序节点显示的文本。

异常

IllegalStateException

如果数据模型或子程序子树被修改 \endchinese \english

返回

The text displayed in the Program Tree for the program node.

异常

IllegalStateException

if the data model or child program sub-tree is modified \endenglish

isDefined()

virtual bool arcs::aubo_scope::ProgramNodeContribution::isDefined ( )

pure virtual

\chinese

如果此程序节点完整，应返回 true，否则返回 false。

未定义的程序节点将在程序树中以黄色标记。只要程序包含一个或多个未定义的 程序节点，用户就无法启动程序。

如果此程序节点在其 DataModel 中存储了不可解析的实体（例如 PersistedVariable 或 TCP），则该程序节点将被视为未定义。

返回

如果此程序节点完整则返回 true，否则返回 false。

异常

IllegalStateException

如果数据模型或子程序子树被修改 \endchinese \english

Should return true if this program node is complete, and false otherwise.

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.

If this program node stores an unresolvable entity (e.g. variable/PersistedVariable or tcp/TCP) in its DataModel, the program node will be treated as undefined.

返回

true if this program node is complete and otherwise false.

异常

IllegalStateException

if the data model or child program sub-tree is modified. \endenglish

openView()

virtual void arcs::aubo_scope::ProgramNodeContribution::openView ( )

pure virtual

\chinese 当此节点在程序树中被选中时调用。 \endchinese \english Called when this node is selected in the program tree.

\endenglish

postAction()

virtual std::string arcs::aubo_scope::ProgramNodeContribution::postAction ( const char * pattern, const std::string & body )

inlinevirtual

\chinese

postAction 发送 HTTP POST 请求

参数

pattern	URL 模式
body	请求体

返回

响应内容 \endchinese \english

post

参数

pattern
body

返回

\endenglish

在文件 program_node_contribution.h 第 134 行定义.

---

该类的文档由以下文件生成:

• include/aubo_caps/contribution/program/program_node_contribution.h