IVariableMetadataVisitor

class ansys.tools.variableinterop.ivariablemetadata_visitor.IVariableMetadataVisitor

Bases: abc.ABC, Generic[T]

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

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 an
visit_real	Method that is called if the IVariableValue.accept() method is called on a
visit_boolean	Method that is called if the IVariableValue.accept() method is called on a
visit_string	Method that is called if the IVariableValue.accept() method is called on a
visit_file	Method that is called if the IVariableValue.accept() method is called on a
visit_integer_array	Method that is called if the IVariableValue.accept() method is called on an
visit_real_array	Method that is called if the IVariableValue.accept() method is called on a
visit_boolean_array	Method that is called if the IVariableValue.accept() method is called on a
visit_string_array	Method that is called if the IVariableValue.accept() method is called on a
visit_file_array	Method that is called if the IVariableValue.accept() method is called on a

Import detail

from ansys.tools.variableinterop.ivariablemetadata_visitor import IVariableMetadataVisitor

Method detail

abstract IVariableMetadataVisitor.visit_integer(metadata: ansys.tools.variableinterop.scalar_metadata.IntegerMetadata) → T

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

Parameters:

metadataIntegerMetadata

IntegerMetadata type to visit.

Returns:

T

Result.

abstract IVariableMetadataVisitor.visit_real(metadata: ansys.tools.variableinterop.scalar_metadata.RealMetadata) → T

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

Parameters:

metadataRealMetadata

RealMetadata type to visit.

Returns:

T

Result.

abstract IVariableMetadataVisitor.visit_boolean(metadata: ansys.tools.variableinterop.scalar_metadata.BooleanMetadata) → T

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

Parameters:

metadataBooleanMetadata

BooleanMetadata type to visit.

Returns:

T

Result.

abstract IVariableMetadataVisitor.visit_string(metadata: ansys.tools.variableinterop.scalar_metadata.StringMetadata) → T

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

Parameters:

metadataStringMetadata

StringMetadata type to visit.

Returns:

T

Result.

abstract IVariableMetadataVisitor.visit_file(metadata: ansys.tools.variableinterop.file_metadata.FileMetadata) → T

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

Parameters:

metadataFileMetadata

FileMetadata type to visit.

Returns:

T

Result.

abstract IVariableMetadataVisitor.visit_integer_array(metadata: ansys.tools.variableinterop.array_metadata.IntegerArrayMetadata) → T

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

Parameters:

metadataIntegerArrayMetadata

IntegerArrayMetadata type to visit.

Returns:

T

Result.

abstract IVariableMetadataVisitor.visit_real_array(metadata: ansys.tools.variableinterop.array_metadata.RealArrayMetadata) → T

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

Parameters:

metadataRealArrayMetadata

RealArrayMetaData type to visit.

Returns:

T

Result.

abstract IVariableMetadataVisitor.visit_boolean_array(metadata: ansys.tools.variableinterop.array_metadata.BooleanArrayMetadata) → T

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

Parameters:

metadataBooleanArrayMetadata

BooleanArrayMetaData type to visit.

Returns:

T

Result.

abstract IVariableMetadataVisitor.visit_string_array(metadata: ansys.tools.variableinterop.array_metadata.StringArrayMetadata) → T

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

Parameters:

metadataStringArrayMetadata

StringArrayMetaData type to visit.

Returns:

T

Result.

abstract IVariableMetadataVisitor.visit_file_array(metadata: ansys.tools.variableinterop.file_array_metadata.FileArrayMetadata) → T

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

Parameters:

metadataFileArrayMetadata

FileArrayMetadata type to visit.

Returns:

T

Result.