arcs::aubo_scope::TreeNode类 参考

树节点 此接口表示程序树中的一个节点，可用于构建以 AuboCap 程序节点为根的子树。 更多...

#include <tree_node.h>

Public 成员函数
	TreeNode (TreeNode &f)
	TreeNode (TreeNode &&f)
virtual	~TreeNode ()
TreeNodePtr	addChild (ProgramNodePtr program_node)
	向子树添加一个子程序节点。
TreeNodePtr	insertChildBefore (TreeNodePtr existingChildNode, ProgramNodePtr program_node)
	在子树中，在现有选中子节点之前插入一个子程序节点。将选中子节点及其后的节点 移到新添加子节点之后的位置。
TreeNodePtr	insertChildAfter (TreeNodePtr existingChildNode, ProgramNodePtr program_node)
	在子树中，在现有选中子节点之后插入一个子程序节点。将后续节点移到新添加 子节点之后的位置。
TreeNodePtr	cutChildNode (TreeNodePtr child)
	剪切子树中的一个子程序节点。
bool	removeChild (TreeNodePtr program_node)
	从子树中移除子节点。注意：移除最后一个子节点将触发插入一个 <empty> 子节点。
std::vector< TreeNodePtr >	getChildren ()
std::vector< TreeNodePtr >	getChildrenNotSuppressed ()
TreeNodePtr	getParent ()
ProgramNodePtr	getProgramNode ()
bool	isSuppressed ()
bool	isInProgramTree ()
	节点是否在程序树中；不在程序树中的节点可能已被剪切或删除。
TreeNodePtr	locateDescendantTreeNode (ProgramNodePtr program_node)
void	setChildSequenceLocked (bool isChildSequenceLocked)
	配置子节点是否可被终端用户重新排列、删除或将其他节点插入到子节点序列中。
int	traverse (std::function< int(ProgramNodePtr, int, int)> nodeVisitor)

Private 成员函数
	TreeNode ()

Private 属性
void *	d_ { nullptr }

友元
class	DataSwitch

详细描述

树节点 此接口表示程序树中的一个节点，可用于构建以 AuboCap 程序节点为根的子树。

使用 ProgramModel#getRootTreeNode(ProgramNodeContribution) 获取子树 的根节点后，即可添加子节点。每次调用 TreeNode#addChild(ProgramNode) 都会返回一个新的 TreeNode，该节点又可以作为另一个子树的根节点。

在文件 tree_node.h 第 32 行定义.

构造及析构函数说明

TreeNode() [1/3]

arcs::aubo_scope::TreeNode::TreeNode

(

TreeNode &

f

)

引用了 TreeNode().

被这些函数引用 TreeNode() , 以及 TreeNode().

函数调用图:

这是这个函数的调用关系图:

TreeNode() [2/3]

arcs::aubo_scope::TreeNode::TreeNode

(

TreeNode &&

f

)

引用了 TreeNode().

函数调用图:

~TreeNode()

virtual arcs::aubo_scope::TreeNode::~TreeNode ( )

virtual

TreeNode() [3/3]

arcs::aubo_scope::TreeNode::TreeNode ( )

private

成员函数说明

addChild()

TreeNodePtr arcs::aubo_scope::TreeNode::addChild

(

ProgramNodePtr

program_node

)

向子树添加一个子程序节点。

参数

program_node

使用 ProgramNodeFactory 构建的 ProgramNode

返回

返回一个 TreeNode，可用于向新添加的子节点添加子节点。

异常

TreeStructureException	如果不允许在此位置插入 ProgramNode
IllegalStateException	如果在 UndoableChanges 范围外从基于 Qt 的 AuboCap 调用

cutChildNode()

TreeNodePtr arcs::aubo_scope::TreeNode::cutChildNode

(

TreeNodePtr

child

)

剪切子树中的一个子程序节点。

参数

child

此 TreeNode 的现有 TreeNode 子节点

返回

返回被剪切掉的 TreeNode

异常

TreeStructureException	如果不允许剪切此 ProgramNode 或子节点不是 此 TreeNode 的子节点
IllegalStateException	如果在 UndoableChanges 范围外调用

getChildren()

std::vector< TreeNodePtr > arcs::aubo_scope::TreeNode::getChildren

(

)

返回

TreeNode 对象列表，表示此 TreeNode 的所有子节点（包括以编程方式 添加的和终端用户插入的）

getChildrenNotSuppressed()

std::vector< TreeNodePtr > arcs::aubo_scope::TreeNode::getChildrenNotSuppressed

(

)

getParent()

TreeNodePtr arcs::aubo_scope::TreeNode::getParent

(

)

返回

节点的父 TreeNode

getProgramNode()

ProgramNodePtr arcs::aubo_scope::TreeNode::getProgramNode

(

)

返回

返回子树中此位置的 ProgramNode。可以是内置 AuboScope 程序节点 或 AuboCap 程序节点。

insertChildAfter()

TreeNodePtr arcs::aubo_scope::TreeNode::insertChildAfter	(	TreeNodePtr	existingChildNode,
		ProgramNodePtr	program_node )

在子树中，在现有选中子节点之后插入一个子程序节点。将后续节点移到新添加 子节点之后的位置。

参数

existingChildNode	此 TreeNode 的现有 TreeNode 子节点
program_node	使用 ProgramNodeFactory 构建的 ProgramNode

返回

返回一个 TreeNode，可用于向新添加的子节点添加子节点。

异常

TreeStructureException	如果不允许在此位置插入或选中子节点不是 此 TreeNode 的子节点
IllegalStateException	如果在 UndoableChanges 范围外调用

insertChildBefore()

TreeNodePtr arcs::aubo_scope::TreeNode::insertChildBefore	(	TreeNodePtr	existingChildNode,
		ProgramNodePtr	program_node )

在子树中，在现有选中子节点之前插入一个子程序节点。将选中子节点及其后的节点 移到新添加子节点之后的位置。

参数

existingChildNode	此 TreeNode 的现有 TreeNode 子节点
program_node	使用 ProgramNodeFactory 构建的 ProgramNode

返回

返回一个 TreeNode，可用于向新添加的子节点添加子节点。

异常

TreeStructureException	如果不允许在此位置插入或选中子节点不是 此 TreeNode 的子节点
IllegalStateException	如果在 UndoableChanges 范围外调用

isInProgramTree()

bool arcs::aubo_scope::TreeNode::isInProgramTree

(

)

节点是否在程序树中；不在程序树中的节点可能已被剪切或删除。

返回

true 节点在程序树中， false 节点不在程序树中（可能已被剪切或删除）

isSuppressed()

bool arcs::aubo_scope::TreeNode::isSuppressed

(

)

locateDescendantTreeNode()

TreeNodePtr arcs::aubo_scope::TreeNode::locateDescendantTreeNode

(

ProgramNodePtr

program_node

)

获取此 TreeNode 下子树中子程序节点（ProgramNode 实例）对应的 TreeNode 实例。

此方法可用于在遍历父节点子树时，获取遇到子程序节点下的子树访问权限。

参数

program_node

需要获取对应 TreeNode 表示的程序节点，不能为 null

返回

指定程序节点的 TreeNode 实例

异常

ProgramNodeNotInSubTreeException

当程序节点不在子树中时

removeChild()

bool arcs::aubo_scope::TreeNode::removeChild

(

TreeNodePtr

program_node

)

从子树中移除子节点。注意：移除最后一个子节点将触发插入一个 <empty> 子节点。

参数

program_node

要移除的 TreeNode 子节点

返回

成功移除返回 true，否则返回 false

异常

TreeStructureException	如果移除子节点会使树处于非法状态
IllegalStateException	如果在 UndoableChanges 范围外调用

setChildSequenceLocked()

void arcs::aubo_scope::TreeNode::setChildSequenceLocked

(

bool

isChildSequenceLocked

)

配置子节点是否可被终端用户重新排列、删除或将其他节点插入到子节点序列中。

参数

isChildSequenceLocked

如果为 true，则此 TreeNode 下的直接子节点将被锁定

traverse()

int arcs::aubo_scope::TreeNode::traverse

(

std::function< int(ProgramNodePtr, int, int)>

nodeVisitor

)

此方法以深度优先方式遍历此树节点下的整个子树（对应于程序树中的自顶向下方式）。

使用节点访问器进行回调，回调的重载取决于遇到的节点类型。

所有 visit 方法都具有程序节点、兄弟索引和深度作为参数，以便在需要时过滤节点。

参数

nodeVisitor

回调实例

返回

0 表示正常退出，非零表示异常或错误导致提前退出

友元及相关符号说明

DataSwitch

friend class DataSwitch

friend

在文件 tree_node.h 第 342 行定义.

引用了 DataSwitch.

被这些函数引用 DataSwitch.

类成员变量说明

d_

void* arcs::aubo_scope::TreeNode::d_ { nullptr }

private

在文件 tree_node.h 第 344 行定义.

---

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

• include/aubo_caps/domain/program/structure/tree_node.h