AuboStudio SDK 0.6.3

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

`#include <wait_node.h>`

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

## Public 类型
enum | ConfigType : int { NO_TYPE , NO_WAIT , TIME , DIGITAL_INPUT , ANALOG_INPUT_CURRENT , ANALOG_INPUT_VOLTAGE , FLOAT_REGISTER_INPUT , EXPRESSION_INPUT }
| The configuration type used to determine which type of configuration this instance is. 更多...
enum | CompareOperator : int { LESS_THAN , GREATER_THAN }
| Compare operator types LESS_THAN and GREATER_THAN used when waiting for an analog input to go lower or higher, respectively, than a threshold 更多...

## Public 成员函数
| WaitNode (WaitNode &f)
| WaitNode (WaitNode &&f)
virtual | ~WaitNode ()
ConfigType | getConfigType ()
| This method returns the type of configuration. 更多...
void | setConfigType (ConfigType type)
double | getWaitTime ()
void | setWaitTime (double time)
bool | getBoolValueToWaitFor ()
| Depending on the type of input this is interpreted in different ways. 更多...
void | setBoolValueToWaitFor (bool value)
float | getFloatValueToWaitFor ()
void | setFloatValueToWaitFor (float value)
void | setDigitalInput (DigitalIoPtr input)
| Creates a configuration for waiting for a digital input to go high or low. 更多...
DigitalIoPtr | getDigitalInput ()
void | setModbusInput (ModbusIoPtr input)
| Creates a configuration for waiting for a digital MODBUS input to go high or low. 更多...
ModbusIoPtr | getModbusInput ()
void | setBoolRegister (BoolRegisterPtr input)
| Creates a configuration for waiting for a boolean register to go `true` or `false`. 更多...
BoolRegisterPtr | getBoolRegister ()
void | setCompareOperator (CompareOperator compareOperator)
CompareOperator | getCompareOperator ()
void | setAnalogInput (AnalogIoPtr input)
| Creates a configuration for waiting for an analog input to go past an electric current threshold. 更多...
AnalogIoPtr | getAnalogInput ()
void | setDoubleRegisterInput (DoubleRegisterPtr input)
| Creates a configuration for waiting for a register to go past a float threshold. 更多...
DoubleRegisterPtr | getDoubleRegisterInput ()
void | setExpressionInputConfig (ExpressionPtr expression)
| Create a configuration for waiting for an expression to be evaluated to true. 更多...
ExpressionPtr | getExpressionInputConfig ()
Public 成员函数 继承自 arcs::aubo_scope::ProgramNode
| ProgramNode (ProgramNode &f)
| ProgramNode (ProgramNode &&f)
virtual | ~ProgramNode ()
ProgramNodeContributionPtr | getProgramNodeContribution ()
| 不推荐用户调用 ProgramNodeContribution::generateScript 使用 ScriptWritter::writeChildren 更多...

## Private 成员函数
| WaitNode ()

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

## 友元
class | DataSwitch

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

## 详细描述

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

## 成员枚举类型说明

## ◆ CompareOperator

enum arcs::aubo_scope::WaitNode::CompareOperator : int

Compare operator types LESS_THAN and GREATER_THAN used when waiting for an analog input to go lower or higher, respectively, than a threshold

枚举值
LESS_THAN |
GREATER_THAN |

在文件 wait_node.h 第 101 行定义.

## ◆ ConfigType

enum arcs::aubo_scope::WaitNode::ConfigType : int

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

枚举值
NO_TYPE |
NO_WAIT | Nothing to wait.
TIME | Wait type is time. The config instance can be cast to TimeWaitNodeConfig.
DIGITAL_INPUT | Wait type is digital_input. The config instance can be cast to {}.
ANALOG_INPUT_CURRENT | Wait type is analog_input_current. The config instance can be cast to {}.
ANALOG_INPUT_VOLTAGE | Wait type is analog_input_voltage. The config instance can be cast to {}.
FLOAT_REGISTER_INPUT | Wait type is float_register_input. The config instance can be cast to {}.
EXPRESSION_INPUT | Wait type is expression_input. The config instance can be cast to {}.

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

## 构造及析构函数说明

## ◆ WaitNode() [1/3]

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

## ◆ WaitNode() [2/3]

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

## ◆ ~WaitNode()

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

## ◆ WaitNode() [3/3]

arcs::aubo_scope::WaitNode::WaitNode | ( |  | ) |
| private

## 成员函数说明

## ◆ getAnalogInput()

AnalogIoPtr arcs::aubo_scope::WaitNode::getAnalogInput | ( |  | ) |

## ◆ getBoolRegister()

BoolRegisterPtr arcs::aubo_scope::WaitNode::getBoolRegister | ( |  | ) |

## ◆ getBoolValueToWaitFor()

bool arcs::aubo_scope::WaitNode::getBoolValueToWaitFor | ( |  | ) |

Depending on the type of input this is interpreted in different ways.

For digital inputs and MODBUS inputs, `true` means the input to wait for must be HIGH, `false` means the input to wait for must be LOW. For boolean registers the value is interpreted literally.

返回
  the input value to wait for.

## ◆ getCompareOperator()

CompareOperator arcs::aubo_scope::WaitNode::getCompareOperator | ( |  | ) |

## ◆ getConfigType()

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

This method returns the type of configuration.

Cast this instance appropriately to have access to specific getters.

返回
  the type of this config.

## ◆ getDigitalInput()

DigitalIoPtr arcs::aubo_scope::WaitNode::getDigitalInput | ( |  | ) |

## ◆ getDoubleRegisterInput()

DoubleRegisterPtr arcs::aubo_scope::WaitNode::getDoubleRegisterInput | ( |  | ) |

## ◆ getExpressionInputConfig()

ExpressionPtr arcs::aubo_scope::WaitNode::getExpressionInputConfig | ( |  | ) |

## ◆ getFloatValueToWaitFor()

float arcs::aubo_scope::WaitNode::getFloatValueToWaitFor | ( |  | ) |

## ◆ getModbusInput()

ModbusIoPtr arcs::aubo_scope::WaitNode::getModbusInput | ( |  | ) |

## ◆ getWaitTime()

double arcs::aubo_scope::WaitNode::getWaitTime | ( |  | ) |

返回
  the time to wait for. second

## ◆ setAnalogInput()

void arcs::aubo_scope::WaitNode::setAnalogInput | ( | AnalogIoPtr | input | ) |

Creates a configuration for waiting for an analog input to go past an electric current threshold.

参数

  input | on which to wait, not `null`.
  compareOperator | the operator to use when comparing input to value, not `null`. Available options are "less than" ({@literal <}) or "greater than" ({@literal >}).
  current | the electric current threshold to wait for, not `null`.
  errorHandler | the error handler for validation errors. If using ErrorHandler#AUTO_CORRECT this will clamp the value to the nearest valid current value.

返回
  the configuration.

异常

  IllegalArgumentException | if `input` is an output (does not support reading of values). See IO#isInput().

## ◆ setBoolRegister()

void arcs::aubo_scope::WaitNode::setBoolRegister | ( | BoolRegisterPtr | input | ) |

Creates a configuration for waiting for a boolean register to go `true` or `false`.

参数

  input | the boolean register input on which to wait, not `null`.
  value_to_wait_for | `true`, if waiting for the register to be `true}, `false} otherwise.``

返回
  ``the configuration.``

异常

  IllegalArgumentException | ``if `input` is an output (does not support reading of values). See IO#isInput().``

## ◆ setBoolValueToWaitFor()

void arcs::aubo_scope::WaitNode::setBoolValueToWaitFor | ( | bool | value | ) |

## ◆ setCompareOperator()

void arcs::aubo_scope::WaitNode::setCompareOperator | ( | CompareOperator | compareOperator | ) |

## ◆ setConfigType()

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

## ◆ setDigitalInput()

void arcs::aubo_scope::WaitNode::setDigitalInput | ( | DigitalIoPtr | input | ) |

Creates a configuration for waiting for a digital input to go high or low.

参数

  input | the digital input on which to wait, not `null`.
  value_to_wait_for | `true`, if waiting for the input signal value/level to go HIGH, `false` otherwise (waiting for LOW signal value/level).

返回
  the configuration.

异常

  IllegalArgumentException | if `input` is an output (does not support reading of values). See IO#isInput().

## ◆ setDoubleRegisterInput()

void arcs::aubo_scope::WaitNode::setDoubleRegisterInput | ( | DoubleRegisterPtr | input | ) |

Creates a configuration for waiting for a register to go past a float threshold.

参数

  input | the float register input on which to wait, not `null`.
  compareOperator | the operator to use when comparing register to value, not `null`. Available options are "less than" ({@literal <}) or "greater than" ({@literal >}).
  value_to_wait_for | the float threshold to wait for.

返回
  the configuration.

异常

  IllegalArgumentException | if `input` is an output (does not support reading of values). See IO#isInput().

## ◆ setExpressionInputConfig()

void arcs::aubo_scope::WaitNode::setExpressionInputConfig | ( | ExpressionPtr | expression | ) |

Create a configuration for waiting for an expression to be evaluated to true.

参数

  expression | the expression to evaluate, not `null`.

返回
  the configuration.

## ◆ setFloatValueToWaitFor()

void arcs::aubo_scope::WaitNode::setFloatValueToWaitFor | ( | float | value | ) |

## ◆ setModbusInput()

void arcs::aubo_scope::WaitNode::setModbusInput | ( | ModbusIoPtr | input | ) |

Creates a configuration for waiting for a digital MODBUS input to go high or low.

参数

  input | the digital MODBUS input on which to wait, not `null`.
  value_to_wait_for | `true`, if waiting for the input signal value/level to go HIGH, `false` otherwise (waiting for LOW signal value/level).

返回
  the configuration.

异常

  IllegalArgumentException | if `input` is an output (does not support reading of values) or if `output` is not a digital output. See IO#isInput() and IO#getType().

## ◆ setWaitTime()

void arcs::aubo_scope::WaitNode::setWaitTime | ( | double | time | ) |

## 友元及相关函数文档

## ◆ DataSwitch

friend class DataSwitch
| friend

在文件 wait_node.h 第 239 行定义.

## 类成员变量说明

## ◆ d_

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

在文件 wait_node.h 第 241 行定义.

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

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