arcs::aubo_scope::VariableFactory Class Reference

#include <variable_factory.h>

Public Member Functions
	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 Member Functions
	VariableFactory ()

Private Attributes
void *	d_ { nullptr }

Friends
class	DataSwitch

Detailed Description

This interface supplies methods to create variable objects.

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

Definition at line 21 of file variable_factory.h.

Constructor & Destructor Documentation

VariableFactory() [1/3]

arcs::aubo_scope::VariableFactory::VariableFactory

(

VariableFactory &

f

)

References VariableFactory().

Referenced by VariableFactory(), and VariableFactory().

Here is the call graph for this function:

Here is the caller graph for this function:

VariableFactory() [2/3]

arcs::aubo_scope::VariableFactory::VariableFactory

(

VariableFactory &&

f

)

References VariableFactory().

Here is the call graph for this function:

~VariableFactory()

arcs::aubo_scope::VariableFactory::~VariableFactory

(

)

VariableFactory() [3/3]

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

private

Member Function Documentation

createFeatureVariable()

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

Creates a feature variable.

Parameters

suggested_name	Suggested name of the variable.
pose	the pose of the feature.

Returns

FeatureVariable.

Exceptions

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.

Parameters

suggested_name

Suggested name of the variable.

Returns

GlobalVariable.

Exceptions

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 with an initial value.

Parameters

suggested_name	Suggested name of the variable.
initialValue	The expression that will be evaluated in order to initialize the value of the variable.

Returns

GlobalVariable.

Exceptions

VariableException

In case of an illegal name.

Friends And Related Symbol Documentation

DataSwitch

friend class DataSwitch

friend

Definition at line 98 of file variable_factory.h.

References DataSwitch.

Referenced by DataSwitch.

Member Data Documentation

d_

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

private

Definition at line 100 of file variable_factory.h.

---

The documentation for this class was generated from the following file:

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