nvneural::runtimeoptionstype Namespace Reference

Enumeration describing the runtime options given to the host, see IRuntimeOptionsLayer. More...

Variables
const char *const	booltf = "boolTF"
	Requires nothing, sent "true" or "false".
const char *const	numfloat = "numFloat"
	Requires nothing, sent float.
const char *const	numint = "numInt"
	Requires nothing, sent int.
const char *const	stringlist = "stringList"
	Requires runtimeoptionsattributes::list, sent ordinal.
const char *const	textedit = "textEdit"
	Requires nothing, sent string.
const char *const	textlabel = "textLabel"
	Requires nothing, sent nothing, send string.
const char *const	trigger = "trigger"
	Requires nothing, sent empty string.

Detailed Description

Enumeration describing the runtime options given to the host, see IRuntimeOptionsLayer.

Each enumeration has a brief description and example. In each description, a definition requirement, if there is one, is defined. Also defined, is a sent value from the host, this is sent from the host through setRuntimeOptionValue() when the option has changed. On the host-side, default (or current) selection/value is obtained by using getRuntimeOptionValue(). The value the host is expecting is the same as the defined sent value, unless noted.

Note that each option is a single value, for instance, a runtimeoptionstype::stringList is a single selection list. Further note that all communications to/from the host are through strings and any number/string conversions during this communication should use the "C" locale. The host can, of course, localize its UI however it likes.