StringMetadata

class StringMetadata

Bases: ansys.tools.variableinterop.common_variable_metadata.CommonVariableMetadata

Provides common metadata for STRING and STRING_ARRAY variable types.

Overview

Methods

accept	Invoke the visitor pattern of this object using the passed-in visitor
equals	Determine if the object is equal to the metadata.

Properties

variable_type	Variable type of the object.
enumerated_values	List of enumerated values.
enumerated_aliases	List of enumerated aliases.

Special methods

__eq__

Determine if the object is equal to the metadata.

Import detail

from ansys.tools.variableinterop.scalar_metadata import StringMetadata

Property detail

property StringMetadata.variable_type: VariableType

Variable type of the object.

Returns:

VariableType

Variable type of the object.

property StringMetadata.enumerated_values: List[ansys.tools.variableinterop.scalar_values.StringValue]

List of enumerated values.

This list may be empty to imply that there are no enumerated values.

Returns:

List[StringValue]

List of enumerated values.

property StringMetadata.enumerated_aliases: List[str]

List of enumerated aliases.

This list may be empty to imply that there are no enumerated aliases.

Returns:

List[str]

List of enumerated aliases.

Method detail

StringMetadata.__eq__(other)

Determine if the object is equal to the metadata.

StringMetadata.accept(visitor: ansys.tools.variableinterop.ivariablemetadata_visitor.IVariableMetadataVisitor[ansys.tools.variableinterop.ivariablemetadata_visitor.T]) → ansys.tools.variableinterop.ivariablemetadata_visitor.T

Invoke the visitor pattern of this object using the passed-in visitor implementation.

Parameters:

visitorIVariableMetadataVisitor[T]

Visitor object to call.

Returns:

T

Results of the visitor invocation.

StringMetadata.equals(other: Any) → bool

Determine if the object is equal to the metadata.

Parameters:

otherAny

Other object to compare this object to.

Returns:

bool

True if the metadata objects are equal, False otherwise.