The ansys.tools.variableinterop library#

Summary#

utils

Provides utility methods and classes used by the main package.

api_serialization

Defines the ToAPIStringVisitor class.

api_string_to_value_visitor

Provides a variable type pseudo-visitor that parses values from strings.

array_metadata

Defines array metadata types.

array_value_conversion

Defines array value visitors.

array_values

Defines all array value implementations of the IVariableValue variable type.

common_variable_metadata

Defines the CommonVariableMetadata class.

exceptions

Provides custom exception types.

file_array_metadata

Defines the FileArrayMetadata class.

file_array_value

Defines the FileArrayValue class.

file_metadata

Defines the FileMetadata class.

file_scope

Implements the FileScope class.

file_value

Defines the FileValue class.

from_formatted_string_visitor

Defines the FromFormattedStringVisitor class.

isave_context

Defines the ISaveContext class.

ivariable_type_pseudovisitor

Defines and implements a pseudo-visitor pattern for variable types.

ivariable_visitor

Defines the IVariableValueVisitor class.

ivariablemetadata_visitor

Defines the IVariableMetadataVisitor class.

non_managing_file_scope

Defines the NonManagingFileScope class.

numeric_metadata

Defines the NumericMetadata class.

scalar_metadata

Defines scalar metadata types.

scalar_value_conversion

Defines scalar value visitors.

scalar_values

Defines all scalar value implementations of the IVariableValue variable type.

value_from_formatted_string

Provides a method for converting a formatted string to a value.

var_type_array_check

Provides a method for checking whether a variable type is an array type.

variable_state

Defines the VariableState class.

variable_type

Defines the VariableType class.

variable_value

Defines the IVariableValue class and related classes.

vartype_arrays_and_elements

Defines functions for determining the correct array type for a scalar type and vice-

__version__

ansys.tools.variableinterop version.

Description#

This library contains definitions of the basic variables, types, metadata, and values intended to provide interoperability between all products that optionally choose to participate.

For high-level project documentation with examples and installation instructions, see http://variableinterop.docs.pyansys.com.

Module detail#

variableinterop.__version__#

ansys.tools.variableinterop version.