AIExpressionOptions Struct Reference

A structure that describes how the result should be returned by AIUserSuite::EvaluateExpression(). More...

#include <AIUser.h>

List of all members.

Public Attributes
ai::uint32	unit
	The units in which the output value is expressed, one of the distance-measuring units from AITypes::AIUnits, or the constant kAINoUnits to indicate an absolute value.
AIDouble	minValue
	The minimum value to which the result is clipped, expressed in the specified units.
AIDouble	maxValue
	The maximum value to which the result is clipped, expressed in the specified units.
AIDouble	oldValue
	The previous value of control.
ai::uint32	precision
	The number of digits after the decimal in the result.

---

Detailed Description

A structure that describes how the result should be returned by AIUserSuite::EvaluateExpression().

---

Member Data Documentation

AIDouble AIExpressionOptions::maxValue

The maximum value to which the result is clipped, expressed in the specified units.

AIDouble AIExpressionOptions::minValue

The minimum value to which the result is clipped, expressed in the specified units.

AIDouble AIExpressionOptions::oldValue

The previous value of control.

Can be any valid value. In case of erroneous or unallowed inStringVal, finalValue would be same as old value

ai::uint32 AIExpressionOptions::precision

The number of digits after the decimal in the result.

ai::uint32 AIExpressionOptions::unit

The units in which the output value is expressed, one of the distance-measuring units from AITypes::AIUnits, or the constant kAINoUnits to indicate an absolute value.

Other values cause parameter errors.

---

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

• AIUser.h