AuboStudio SDK 0.6.3

Public 成员函数 | 所有成员列表
arcs::aubo_scope::ProgramNodeContribution类 参考abstract

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
| Called when this node is selected in the program tree. 更多...
virtual void | closeView ()=0
| Called when this node is unselected in the program tree or when navigating to another view. 更多...
virtual std::string | getTitle ()=0
virtual bool | isDefined ()=0
virtual void | generateScript (ScriptWriterPtr script_writer)=0
| Defines the script code to be generated by this program node within the program. 更多...
virtual std::string | postAction (const char *pattern, const std::string &body)
| post 更多...
virtual std::string | getAction (const char *pattern, const std::string &body)
| GET 更多...

## 详细描述

Defines an API required for specifying a AuboCap Program Node within AuboScope.

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

## 构造及析构函数说明

## ◆ ~ProgramNodeContribution()

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

## 成员函数说明

## ◆ closeView()

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

Called when this node is unselected in the program tree or when navigating to another view.

## ◆ generateScript()

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

Defines the script code to be generated by this program node within the program.

参数

  writer | serves to add script commands that define the behaviour of this program node.

## ◆ getAction()

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

GET

参数

  pattern |
  body |

返回

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

## ◆ getTitle()

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

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

异常

  IllegalStateException | if the data model or child program sub-tree is modified

## ◆ isDefined()

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

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. {} 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.

## ◆ openView()

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

Called when this node is selected in the program tree.

## ◆ postAction()

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

post

参数

  pattern |
  body |

返回

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

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

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