arcs::aubo_scope::VariableFactory类 参考

#include <variable_factory.h>

Public 成员函数
	VariableFactory (VariableFactory &f)
	VariableFactory (VariableFactory &&f)
	~VariableFactory ()
GlobalVariablePtr	createGlobalVariable (const std::string &suggested_name)
GlobalVariablePtr	createGlobalVariable (const std::string &suggested_name, ExpressionPtr initialValue)
FeatureVariablePtr	createFeatureVariable (const std::string &suggested_name, const std::vector< double > &pose)

Private 成员函数
	VariableFactory ()

Private 属性
void *	d_ { nullptr }

友元
class	DataSwitch

详细描述

This interface supplies methods to create variable objects.

NOTE: Only use this functionality in a AuboCap program node (not relevant for an installation node).

在文件 variable_factory.h 第 20 行定义.

构造及析构函数说明

VariableFactory() [1/3]

arcs::aubo_scope::VariableFactory::VariableFactory

(

VariableFactory &

f

)

引用了 VariableFactory().

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

函数调用图:

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

VariableFactory() [2/3]

arcs::aubo_scope::VariableFactory::VariableFactory

(

VariableFactory &&

f

)

引用了 VariableFactory().

函数调用图:

~VariableFactory()

arcs::aubo_scope::VariableFactory::~VariableFactory

(

)

VariableFactory() [3/3]

arcs::aubo_scope::VariableFactory::VariableFactory ( )

private

成员函数说明

createFeatureVariable()

FeatureVariablePtr arcs::aubo_scope::VariableFactory::createFeatureVariable	(	const std::string &	suggested_name,
		const std::vector< double > &	pose )

Creates a feature variable.

Registering the variable in AuboScope (by storing it in a DataModel instance or using it for the configuration of a built-in AuboScope program node) will make it accessible to all program nodes.

Setting an initial value will make it possible to read from the variable immediately without having to assign a value to it first. This can be useful in various constructs which requires an initial valu.

NOTE: Only use this method in a AuboCap program node (not relevant for an installation node).

参数

suggested_name	Suggested name of the variable. Valid names must match regex [a-zA-Z][a-zA-Z0-9_]{0,14} for a total of 15 characters.
initialValue	The expression that will be evaluated in order to initialize the value of the variable. This value is assigned before the actual program runs.

返回

FeatureVariable.

异常

VariableException

In case of an illegal name.

createGlobalVariable() [1/2]

GlobalVariablePtr arcs::aubo_scope::VariableFactory::createGlobalVariable

(

const std::string &

suggested_name

)

Creates a global variable. Registering the variable in AuboScope (by storing it in a DataModel instance or using it for the configuration of a built-in AuboScope program node) will make it accessible to all program nodes.

NOTE: Only use this method in a AuboCap program node (not relevant for an installation node).

参数

suggested_name

Suggested name of the variable. Valid names must match regex [a-zA-Z][a-zA-Z0-9_]{0,14} for a total of 15 characters.

返回

GlobalVariable.

异常

VariableException

In case of an illegal name.

createGlobalVariable() [2/2]

GlobalVariablePtr arcs::aubo_scope::VariableFactory::createGlobalVariable	(	const std::string &	suggested_name,
		ExpressionPtr	initialValue )

Creates a global variable.

Registering the variable in AuboScope (by storing it in a DataModel instance or using it for the configuration of a built-in AuboScope program node) will make it accessible to all program nodes.

Setting an initial value will make it possible to read from the variable immediately without having to assign a value to it first. This can be useful in various constructs which requires an initial value, e.g. 'var_1 = var_1 + 1' or 'if (var_2 =):'.

NOTE: Only use this method in a AuboCap program node (not relevant for an installation node).

参数

suggested_name	Suggested name of the variable. Valid names must match regex [a-zA-Z][a-zA-Z0-9_]{0,14} for a total of 15 characters.
initialValue	The expression that will be evaluated in order to initialize the value of the variable. This value is assigned before the actual program runs.

返回

GlobalVariable.

异常

VariableException

In case of an illegal name.

友元及相关符号说明

DataSwitch

friend class DataSwitch

friend

在文件 variable_factory.h 第 112 行定义.

引用了 DataSwitch.

被这些函数引用 DataSwitch.

类成员变量说明

d_

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

private

在文件 variable_factory.h 第 114 行定义.

---

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

• include/aubo_caps/domain/variable/variable_factory.h