`StringArrayValue`#

class ansys.tools.variableinterop.array_values.StringArrayValue#

Bases: ansys.tools.variableinterop.variable_value.CommonArrayValue[numpy.str_]

Stores a value as a StringArrayValue variable type.

In Python, the StringArrayValue type is implemented by extending NumPy’s ndarray type. This means that they decay naturally into numpy.ndarray objects when using NumPy’s array operators.

Overview#

Methods

`clone`
`accept`
`to_real_array_value`	Convert the value to a `RealArrayValue` type.
`to_boolean_array_value`	Convert the value to a `BooleanArrayValue` type.
`to_integer_array_value`	Convert the value to an `IntegerArrayValue` type.
`to_api_string`
`to_display_string`

Properties

variable_type

Static methods

from_api_string

Convert an API-formatted string to a StringArrayValue type.

Special methods

__eq__

Import detail#

from ansys.tools.variableinterop.array_values import StringArrayValue

Property detail#

property StringArrayValue.variable_type: ansys.tools.variableinterop.variable_type.VariableType#

Method detail#

StringArrayValue.__eq__(other)#

StringArrayValue.clone() → StringArrayValue#

StringArrayValue.accept(visitor: ansys.tools.variableinterop.ivariable_visitor.IVariableValueVisitor[T]) → T#

StringArrayValue.to_real_array_value() → RealArrayValue#

Convert the value to a RealArrayValue type.

Returns:

RealArrayValue: RealArrayValue type with the same values converted to real numbers.

StringArrayValue.to_boolean_array_value() → BooleanArrayValue#

Convert the value to a BooleanArrayValue type.

Returns:

BooleanArrayValue: BooleanArrayValue type with the same values converted to Boolean values.

StringArrayValue.to_integer_array_value() → IntegerArrayValue#

Convert the value to an IntegerArrayValue type.

Returns:

IntegerArrayValue: IntegerArrayValue type with the same values converted to integers.

StringArrayValue.to_api_string(context: ansys.tools.variableinterop.isave_context.ISaveContext | None = None) → str#

static StringArrayValue.from_api_string(value: str) → StringArrayValue#

Convert an API-formatted string to a StringArrayValue type.

Parameters:

valuestr: API string to parse.

Returns:

StringArrayValue: Result of parsing the StringArrayValue type.

StringArrayValue.to_display_string(locale_name: str) → str#