NumericMetadata

class NumericMetadata

Bases: ansys.tools.variableinterop.common_variable_metadata.CommonVariableMetadata, abc.ABC

Provides a generic base for all numeric metadata implementations.

Overview

Abstract methods

accept

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

Methods

equals

Determine if a given metadata is equal to this metadata.

Properties

units	Units of the variable.
display_format	Display format of the variable.

Special methods

__eq__

Determine if the object is equal to the metadata.

Import detail

from ansys.tools.variableinterop.numeric_metadata import NumericMetadata

Property detail

property NumericMetadata.units: str

Units of the variable.

property NumericMetadata.display_format: str

Display format of the variable.

Method detail

NumericMetadata.__eq__(other)

Determine if the object is equal to the metadata.

NumericMetadata.equals(other: Any) → bool

Determine if a given metadata is equal to this metadata.

Parameters:

otherAny

Given metadata to compare this metadate to.

Returns:

bool

True if the two objects are equal, False otherwise.

abstract NumericMetadata.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.