Euresys::action Namespace Reference

Functions
GenApiActionBuilder	declareInteger ()
	Create an action to declare a virtual user feature of type Integer on a GenApi Module.
GenApiActionBuilder	declareFloat ()
	Create an action to declare a virtual user feature of type Float on a GenApi Module.
GenApiActionBuilder	declareString ()
	Create an action to declare a virtual user feature of type String on a GenApi Module.
GenApiActionBuilder	undeclare ()
	Create an action to undeclare (delete) a virtual user feature on a GenApi Module.

Function Documentation

declareInteger()

GenApiActionBuilder declareInteger

(

)

Create an action to declare a virtual user feature of type Integer on a GenApi Module.

Note

a declared virtual user feature is used as a GenApi feature by prefixing its name with a dollar sign ($)

Example: create a virtual user feature "size" of type Integer on the Device module

grabber.setString<DeviceModule>(action::declareInteger(), "size");
grabber.setInteger<DeviceModule>("$size", 1024);
grabber.runScript(pathToScriptUsingTheUserFeature$size);
int64_t size = grabber.getInteger<DeviceModule>("$size");

declareFloat()

GenApiActionBuilder declareFloat

(

)

Create an action to declare a virtual user feature of type Float on a GenApi Module.

declareString()

GenApiActionBuilder declareString

(

)

Create an action to declare a virtual user feature of type String on a GenApi Module.

undeclare()

GenApiActionBuilder undeclare

(

)

Create an action to undeclare (delete) a virtual user feature on a GenApi Module.

Example: delete a virtual user feature "size" on the Device module

grabber.setString<DeviceModule>(action::undeclare(), "size");