AuboStudio SDK 0.6.3

Public 类型 | Public 成员函数 | Private 成员函数 | Private 属性 | 友元 | 所有成员列表
arcs::aubo_scope::LoopNode类 参考

`#include <loop_node.h>`

类 arcs::aubo_scope::LoopNode 继承关系图:
[图例]
arcs::aubo_scope::LoopNode 的协作图:
[图例]

## Public 类型
enum | ConfigType { ALWAYS , COUNTER , EXPRESSION }
| The configuration type used to determine which type of configuration this instance is. 更多...

## Public 成员函数
| LoopNode (LoopNode &f)
| LoopNode (LoopNode &&f)
virtual | ~LoopNode ()
ConfigType | getConfigType ()
| This method returns the type of configuration. 更多...
void | setConfigType (ConfigType type)
void | setLoopCount (int loop_count)
| Creates a loop counter configuration. 更多...
int | getLoopCount ()
void | setExpression (ExpressionPtr expression)
| Create a loop expression configuration. 更多...
ExpressionPtr | getExpression ()
bool | isEvaluateContinously ()
void | setEvaluateContinously (bool cont)
void | setLoopCountVariable (VariablePtr var)
VariablePtr | getLoopCountVariable ()
Public 成员函数 继承自 arcs::aubo_scope::ProgramNode
| ProgramNode (ProgramNode &f)
| ProgramNode (ProgramNode &&f)
virtual | ~ProgramNode ()
ProgramNodeContributionPtr | getProgramNodeContribution ()
| 不推荐用户调用 ProgramNodeContribution::generateScript 使用 ScriptWritter::writeChildren 更多...

## Private 成员函数
| LoopNode ()

## Private 属性
void * | d_ { nullptr }

## 友元
class | DataSwitch

## 额外继承的成员函数
Protected 成员函数 继承自 arcs::aubo_scope::ProgramNode
| ProgramNode ()

## 详细描述

在文件 loop_node.h 第 12 行定义.

## 成员枚举类型说明

## ◆ ConfigType

enum arcs::aubo_scope::LoopNode::ConfigType

The configuration type used to determine which type of configuration this instance is.

枚举值
ALWAYS | Looping infinitely has been selected. The config instance can be cast to AlwaysLoopNodeConfig
COUNTER | Looping a certain number of times has been selected. The config instance can be cast to CounterLoopNodeConfig
EXPRESSION | Looping as long as the evaluation of an expression is true has been selected. The config instance can be cast to ExpressionLoopNodeConfig

在文件 loop_node.h 第 19 行定义.

## 构造及析构函数说明

## ◆ LoopNode() [1/3]

arcs::aubo_scope::LoopNode::LoopNode | ( | LoopNode & | f | ) |

## ◆ LoopNode() [2/3]

arcs::aubo_scope::LoopNode::LoopNode | ( | LoopNode && | f | ) |

## ◆ ~LoopNode()

virtual arcs::aubo_scope::LoopNode::~LoopNode | ( |  | ) |
| virtual

## ◆ LoopNode() [3/3]

arcs::aubo_scope::LoopNode::LoopNode | ( |  | ) |
| private

## 成员函数说明

## ◆ getConfigType()

ConfigType arcs::aubo_scope::LoopNode::getConfigType | ( |  | ) |

This method returns the type of configuration.

Cast this instance appropriately to have access to specific getters.

返回
  the type of this config.

## ◆ getExpression()

ExpressionPtr arcs::aubo_scope::LoopNode::getExpression | ( |  | ) |

## ◆ getLoopCount()

int arcs::aubo_scope::LoopNode::getLoopCount | ( |  | ) |

## ◆ getLoopCountVariable()

VariablePtr arcs::aubo_scope::LoopNode::getLoopCountVariable | ( |  | ) |

## ◆ isEvaluateContinously()

bool arcs::aubo_scope::LoopNode::isEvaluateContinously | ( |  | ) |

返回
  `true` if the expression will be evaluated continuously during the looping (i.e. the loop can be interrupted anytime during its execution), otherwise `false` and the expression will be evaluated once per loop iteration.

## ◆ setConfigType()

void arcs::aubo_scope::LoopNode::setConfigType | ( | ConfigType | type | ) |

## ◆ setEvaluateContinously()

void arcs::aubo_scope::LoopNode::setEvaluateContinously | ( | bool | cont | ) |

## ◆ setExpression()

void arcs::aubo_scope::LoopNode::setExpression | ( | ExpressionPtr | expression | ) |

Create a loop expression configuration.

参数

  expression | the expression whose evaluation must be true to continue looping, not `null`.
  evaluateContinuously | if `true` the expression will be evaluated continuously during the looping (i.e. the loop can be interrupted anytime during its execution), otherwise `false` and the expression will be evaluated once per loop iteration.

返回
  the configuration.

## ◆ setLoopCount()

void arcs::aubo_scope::LoopNode::setLoopCount | ( | int | loop_count | ) |

Creates a loop counter configuration.

参数

  loopCount | the number of iterations through the loop node.
  errorHandler | error handler for handling validation. If using ErrorHandler#AUTO_CORRECT this will clamp the value to the nearest valid loop count value.

返回
  the configuration.

## ◆ setLoopCountVariable()

void arcs::aubo_scope::LoopNode::setLoopCountVariable | ( | VariablePtr | var | ) |

返回
  the variable for storing the loop count

## 友元及相关函数文档

## ◆ DataSwitch

friend class DataSwitch
| friend

在文件 loop_node.h 第 108 行定义.

## 类成员变量说明

## ◆ d_

void* arcs::aubo_scope::LoopNode::d_ { nullptr }
| private

在文件 loop_node.h 第 110 行定义.

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

- include/aubo_caps/domain/program/nodes/builtin/loop_node.h