APIStringToValueVisitor#

class APIStringToValueVisitor(source: str, fscope: ansys.tools.variableinterop.file_scope.FileScope | None = None, save_context: ansys.tools.variableinterop.isave_context.ILoadContext | None = None)#

Bases: ansys.tools.variableinterop.ivariable_type_pseudovisitor.IVariableTypePseudoVisitor

Visits variable type enumeration values, producing a variable value from a

Overview#

Abstract methods

visit_unknown

Visit the UNKNOWN variable type.

Methods

`visit_int`	Produce an `IntegerValue` type from the API string format.
`visit_real`	Produce a `RealValue` type from the API string format.
`visit_boolean`	Produce a `BooleanValue` type from the API string format.
`visit_string`	Produce a `StringValue` type from the API string format.
`visit_file`	Produce a `FileValue` type from the API string format.
`visit_int_array`	Produce an `IntegerArrayValue` type from the API string format.
`visit_real_array`	Produce a `RealArrayValue` type from the API string format.
`visit_bool_array`	Produce a `BooleanArrayValue` from the API string format.
`visit_string_array`	Produce a `StringArrayValue` type from the API string format.
`visit_file_array`	Produce a `FileArrayValue` type from the API string format.

Import detail#

from ansys.tools.variableinterop.api_string_to_value_visitor import APIStringToValueVisitor

Method detail#

abstract APIStringToValueVisitor.visit_unknown() → None#

Visit the UNKNOWN variable type.

Given that variables of the UNKNOWN type cannot actually be produced, this method always raises NotImplementedError.

Returns:

None: Never returns; always raises NotImplementedError.

Raises:

NotImplementedError: Always.

APIStringToValueVisitor.visit_int() → ansys.tools.variableinterop.scalar_values.IntegerValue#

Produce an IntegerValue type from the API string format.

Returns:

IntegerValue: IntegerValue type with a value determined by the specified string.

APIStringToValueVisitor.visit_real() → ansys.tools.variableinterop.scalar_values.RealValue#

Produce a RealValue type from the API string format.

Returns:

RealValue: RealValue type with a value determined by the specified string.

APIStringToValueVisitor.visit_boolean() → ansys.tools.variableinterop.scalar_values.BooleanValue#

Produce a BooleanValue type from the API string format.

Returns:

BooleanValue: BooleanValue type with a value determined by the specified string.

APIStringToValueVisitor.visit_string() → ansys.tools.variableinterop.scalar_values.StringValue#

Produce a StringValue type from the API string format.

Returns:

StringValue: StringValue type with a value determined by the specified string.

APIStringToValueVisitor.visit_file() → ansys.tools.variableinterop.file_value.FileValue#

Produce a FileValue type from the API string format.

Returns:

FileValue: FileValue type with a value determined by the specified string.

APIStringToValueVisitor.visit_int_array() → ansys.tools.variableinterop.array_values.IntegerArrayValue#

Produce an IntegerArrayValue type from the API string format.

Returns:

IntegerArrayValue: IntegerArrayValue type with a value determined by the specified string.

APIStringToValueVisitor.visit_real_array() → ansys.tools.variableinterop.array_values.RealArrayValue#

Produce a RealArrayValue type from the API string format.

Returns:

RealArrayValue: RealArrayValue type with a value determined by the specified string.

APIStringToValueVisitor.visit_bool_array() → ansys.tools.variableinterop.array_values.BooleanArrayValue#

Produce a BooleanArrayValue from the API string format.

Returns:

BooleanArrayValue: BooleanArrayValue type with a value determined by the specified string.

APIStringToValueVisitor.visit_string_array() → ansys.tools.variableinterop.array_values.StringArrayValue#

Produce a StringArrayValue type from the API string format.

Returns:

StringArrayValue: StringArrayValue type with a value determined by the specified string.

APIStringToValueVisitor.visit_file_array() → ansys.tools.variableinterop.file_array_value.FileArrayValue#

Produce a FileArrayValue type from the API string format.

Returns:

FileArrayValue: FileArrayValue type with a value determined by the specified string.