The array_value_conversion.py module

Summary

Functions

to_boolean_array_value	Convert the given value to a BooleanArrayValue type.
to_integer_array_value	Convert the given value to an IntegerArrayValue type.
to_real_array_value	Convert the given value to a RealArrayValue type.
to_string_array_value	Convert the given value to a StringArrayValue type.

Description

Defines array value visitors.

Module detail

array_value_conversion.to_boolean_array_value(other: ansys.tools.variableinterop.variable_value.IVariableValue) → ansys.tools.variableinterop.array_values.BooleanArrayValue

Convert the given value to a BooleanArrayValue type.

The conversion is performed according to the type interoperability specifications. Note that some conversions are lossy (resulting in a loss of precision), and some conversions are not possible (raises IncompatibleTypesException).

Parameters:

otherIVariableValue

Other value to convert to a BooleanArrayValue type.

Returns:

BooleanArrayValue

Value as a BooleanArrayValue type.

array_value_conversion.to_integer_array_value(other: ansys.tools.variableinterop.variable_value.IVariableValue) → ansys.tools.variableinterop.array_values.IntegerArrayValue

Convert the given value to an IntegerArrayValue type.

The conversion is performed according to the type interoperability specifications. Note that some conversions are lossy (resulting in a loss of precision), and some conversions are not possible (raises IncompatibleTypesException).

Parameters:

otherIVariableValue

Other value to convert to an IntegerArrayValue type.

Returns:

IntegerArrayValue

Value as an IntegerArrayValue type.

array_value_conversion.to_real_array_value(other: ansys.tools.variableinterop.variable_value.IVariableValue) → ansys.tools.variableinterop.array_values.RealArrayValue

Convert the given value to a RealArrayValue type.

The conversion is performed according to the type interoperability specifications. Note that some conversions are lossy (resulting in a loss of precision), and some conversions are not possible (raises IncompatibleTypesException).

Parameters:

otherIVariableValue

Other value to convert to a RealArrayValue type.

Returns:

RealArrayValue

Value as a RealArrayValue type.

array_value_conversion.to_string_array_value(other: ansys.tools.variableinterop.variable_value.IVariableValue) → ansys.tools.variableinterop.array_values.StringArrayValue

Convert the given value to a StringArrayValue type.

The conversion is performed according to the type interoperability specifications. Note that some conversions are lossy (resulting in a loss of precision), and some conversions are not possible (raises IncompatibleTypesException).

Parameters:

otherIVariableValue

Other value to convert to a StringArrayValue type.

Returns:

StringArrayValue

Value as a StringArrayValue type.