StringArrayValue#

class StringArrayValue#

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

Stores a value as a StringArrayValue variable type.

Overview#

Methods

`clone`	Get a deep copy of this value.
`accept`	Invoke the visitor pattern of this object using the passed-in visitor
`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`	Convert the value to an API string.
`to_display_string`	Convert the value to a formatted string.

Properties

variable_type

Variable type of the object.

Static methods

from_api_string

Convert an API-formatted string to a StringArrayValue type.

Special methods

__eq__

Return self==value.

Import detail#

from ansys.tools.variableinterop.array_values import StringArrayValue

Property detail#

property StringArrayValue.variable_type: VariableType#

Variable type of the object.

Returns:

VariableType: Variable type of the object.

Method detail#

StringArrayValue.__eq__(other)#: Return self==value.

StringArrayValue.clone() → StringArrayValue#: Get a deep copy of this value.

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

Invoke the visitor pattern of this object using the passed-in visitor implementation.

Parameters:

visitorIVariableValueVisitor: Visitor object to call.

Returns:

T: Results of the visitor invocation.

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#

Convert the value to an API string.

Returns:

str: String appropriate for use in files and APIs.

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#

Convert the value to a formatted string.

Parameters:

locale_namestr: Locale to format the string in.

Returns:

str: String appropriate for use in user-facing areas.