ToAPIStringVisitor

class ToAPIStringVisitor(save_context: ansys.tools.variableinterop.isave_context.ISaveContext | None)

Bases: ansys.tools.variableinterop.ivariable_visitor.IVariableValueVisitor[str]

Visits values and converts them to an API string.

Overview

Methods

visit_integer	Method that is called if the IVariableValue.accept() method is called on
visit_real	Method that is called if the IVariableValue.accept() method is called on
visit_boolean	Method that is called if the IVariableValue.accept() method is called on
visit_string	Method that is called if the IVariableValue.accept() method is called on
visit_integer_array	Method that is called if the IVariableValue.accept() method is called on
visit_file	Method that is called if the IVariableValue.accept() method is called on
visit_real_array	Method that is called if the :meth:`IVariableValue.accept() method is called
visit_boolean_array	Method that is called if the IVariableValue.accept() method is called on
visit_string_array	Method that is called if the IVariableValue.accept() method is called on
visit_file_array	Method that is called if the IVariableValue.accept() method is called on

Import detail

from ansys.tools.variableinterop.api_serialization import ToAPIStringVisitor

Method detail

ToAPIStringVisitor.visit_integer(value: ansys.tools.variableinterop.scalar_values.IntegerValue) → str

Method that is called if the IVariableValue.accept() method is called on an IntegerValue type.

Parameters:

valueIntegerValue

IntegerValue type to visit.

Returns:

T

Result.

ToAPIStringVisitor.visit_real(value: ansys.tools.variableinterop.scalar_values.RealValue) → str

Method that is called if the IVariableValue.accept() method is called on a RealValue type.

Parameters:

valueRealValue

RealValue type to visit.

Returns:

T

Result.

ToAPIStringVisitor.visit_boolean(value: ansys.tools.variableinterop.scalar_values.BooleanValue) → str

Method that is called if the IVariableValue.accept() method is called on a BooleanValue type.

Parameters:

valueBooleanValue

BooleanValue type to visit.

Returns:

T

Result.

ToAPIStringVisitor.visit_string(value: ansys.tools.variableinterop.scalar_values.StringValue) → str

Method that is called if the IVariableValue.accept() method is called on a StringValue type.

Parameters:

valueStringValue

StringValue type to visit.

Returns:

T

Result.

ToAPIStringVisitor.visit_integer_array(value: ansys.tools.variableinterop.array_values.IntegerArrayValue) → str

Method that is called if the IVariableValue.accept() method is called on an IntegerArrayValue type.

Parameters:

valueIntegerArrayValue

IntegerArrayValue type to visit.

Returns:

T

Result.

ToAPIStringVisitor.visit_file(value: ansys.tools.variableinterop.file_value.FileValue) → str

Method that is called if the IVariableValue.accept() method is called on a FileValue type.

Parameters:

valueFileValue

FileValue type to visit.

Returns:

T

Result

ToAPIStringVisitor.visit_real_array(value: ansys.tools.variableinterop.array_values.RealArrayValue) → str

Method that is called if the :meth:`IVariableValue.accept() method is called on a RealArrayValue type.

Parameters:

valueRealArrayValue

RealArrayValue type to visit.

Returns:

T

Result.

ToAPIStringVisitor.visit_boolean_array(value: ansys.tools.variableinterop.array_values.BooleanArrayValue) → str

Method that is called if the IVariableValue.accept() method is called on a BooleanArrayValue type.

Parameters:

valueBooleanArrayValue

BooleanArrayValue type to visit.

Returns:

T

Result.

ToAPIStringVisitor.visit_string_array(value: ansys.tools.variableinterop.array_values.StringArrayValue) → str

Method that is called if the IVariableValue.accept() method is called on a StringArrayValue type.

Parameters:

valueStringArrayValue

StringArrayValue type to visit.

Returns:

T

Result.

ToAPIStringVisitor.visit_file_array(value: ansys.tools.variableinterop.file_array_value.FileArrayValue) → str

Method that is called if the IVariableValue.accept() method is called on a FileArrayValue type.

Parameters:

valueFileArrayValue

FileArrayValue type to visit.

Returns:

T

Result.