BooleanArrayValue#

class BooleanArrayValue#

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

Stores a value as a BooleanArrayValue variable type.

Overview#

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 this value to a RealArrayValue type.

to_integer_array_value

Convert this value to an IntegerArrayValue type.

to_string_array_value

Convert this value to a StringArrayValue type.

to_api_string

Convert the value to an API string.

to_display_string

Convert the value to a formatted string.

variable_type

Variable type of the object.

from_api_string

Convert an API-formatted string to a BooleanArrayValue type.

__eq__

Return self==value.

Import detail#

from ansys.tools.variableinterop.array_values import BooleanArrayValue

Property detail#

property BooleanArrayValue.variable_type: VariableType#

Variable type of the object.

Returns:
VariableType

Variable type of the object.

Method detail#

BooleanArrayValue.__eq__(other) bool#

Return self==value.

BooleanArrayValue.clone() BooleanArrayValue#

Get a deep copy of this value.

BooleanArrayValue.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.

BooleanArrayValue.to_real_array_value() RealArrayValue#

Convert this value to a RealArrayValue type.

Returns:
RealArrayValue

RealArrayValue type with the same values converted to real numbers.

BooleanArrayValue.to_integer_array_value() IntegerArrayValue#

Convert this value to an IntegerArrayValue type.

Returns:
IntegerArrayValue

IntegerArrayValue type with the same values converted to integers.

BooleanArrayValue.to_string_array_value() StringArrayValue#

Convert this value to a StringArrayValue type.

Returns:
StringArrayValue

StringArrayValue type with the same values converted to strings.

BooleanArrayValue.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 BooleanArrayValue.from_api_string(value: str) BooleanArrayValue#

Convert an API-formatted string to a BooleanArrayValue type.

Parameters:
valuestr

API string to parse.

Returns:
BooleanArrayValue

Result of parsing the BooleanArrayValue type.

BooleanArrayValue.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.