Skip to content

GenericVariable

QIX methods for version 12.207.0.

ApplyPatches

Applies a patch to the properties of a variable. Allows an update to some of the properties.
Applying a patch takes less time than resetting all the properties.

Parameters:

Name Type Mandatory Description
qPatches NxPatch Yes Array of patches.

No return values.

GetInfo

Returns the type and identifier of the object.

No parameters.

Returns:

Name Type Description
qInfo NxInfo {"qId":"<identifier>","qType":"<type>"}

GetLayout

Evaluates an object and displays its properties including the dynamic properties.
If the member delta is set to true in the request object, only the delta is evaluated.

No parameters.

Returns:

Name Type Description
qLayout GenericVariableLayout Information on the object

GetProperties

Shows the properties of an object.
If the member delta is set to true in the request, only the delta is retrieved.
The following is always returned in the output:

No parameters.

Returns:

Name Type Description
qProp GenericVariableProperties Information about the generic object

SetDualValue

Sets the value of a dual variable.
These changes are not persistent. They only last the duration of the engine session.

Parameters:

Name Type Mandatory Description
qText string Yes String representation of a dual value. Set this parameter to "", if the string representation is to be Null.
qNum number Yes Numeric representation of a dual value.

No return values.

SetNumValue

Sets a numerical value to a variable.
These changes are not persistent. They only last the duration of the engine session.

Parameters:

Name Type Mandatory Description
qVal number Yes Value of the variable.

No return values.

SetProperties

Sets some properties for a variable.
The identifier of a variable cannot be modified. You cannot update the properties of a script-defined variable using the SetProperties method.

Parameters:

Name Type Mandatory Description
qProp GenericVariableProperties Yes Information about the variable.

No return values.

SetStringValue

Sets a string value to a variable.
These changes are not persistent. They only last the duration of the engine session.

Parameters:

Name Type Mandatory Description
qVal string Yes Value of the variable. The string can contain an expression.

No return values.