IVariableValueVisitor

class ansys.tools.variableinterop.ivariable_visitor.IVariableValueVisitor

Bases: abc.ABC, Generic[T]

Defines the interface to be implemented for using the visitor pattern with variable values.

To use an implementation of this interface, create and pass an instance to the IVariableValue.accept() method.

Overview

Abstract 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.ivariable_visitor import IVariableValueVisitor

Method detail

abstractmethod IVariableValueVisitor.visit_integer(value: ansys.tools.variableinterop.scalar_values.IntegerValue) → T

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

Parameters:

valueIntegerValue

IntegerValue type to visit.

Returns:

T

Result.

abstractmethod IVariableValueVisitor.visit_real(value: ansys.tools.variableinterop.scalar_values.RealValue) → T

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

Parameters:

valueRealValue

RealValue type to visit.

Returns:

T

Result.

abstractmethod IVariableValueVisitor.visit_boolean(value: ansys.tools.variableinterop.scalar_values.BooleanValue) → T

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

Parameters:

valueBooleanValue

BooleanValue type to visit.

Returns:

T

Result.

abstractmethod IVariableValueVisitor.visit_string(value: ansys.tools.variableinterop.scalar_values.StringValue) → T

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

Parameters:

valueStringValue

StringValue type to visit.

Returns:

T

Result.

abstractmethod IVariableValueVisitor.visit_integer_array(value: ansys.tools.variableinterop.array_values.IntegerArrayValue) → T

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

Parameters:

valueIntegerArrayValue

IntegerArrayValue type to visit.

Returns:

T

Result.

abstractmethod IVariableValueVisitor.visit_file(value: ansys.tools.variableinterop.file_value.FileValue) → T

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

Parameters:

valueFileValue

FileValue type to visit.

Returns:

T

Result

abstractmethod IVariableValueVisitor.visit_real_array(value: ansys.tools.variableinterop.array_values.RealArrayValue) → T

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.

abstractmethod IVariableValueVisitor.visit_boolean_array(value: ansys.tools.variableinterop.array_values.BooleanArrayValue) → T

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

Parameters:

valueBooleanArrayValue

BooleanArrayValue type to visit.

Returns:

T

Result.

abstractmethod IVariableValueVisitor.visit_string_array(value: ansys.tools.variableinterop.array_values.StringArrayValue) → T

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

Parameters:

valueStringArrayValue

StringArrayValue type to visit.

Returns:

T

Result.

abstractmethod IVariableValueVisitor.visit_file_array(value: ansys.tools.variableinterop.file_array_value.FileArrayValue) → T

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

Parameters:

valueFileArrayValue

FileArrayValue type to visit.

Returns:

T

Result.