RealMetadata#

class RealMetadata#

Bases: ansys.tools.variableinterop.numeric_metadata.NumericMetadata

Provides metadata for REAL and REAL_ARRAY variable types.

Overview#

Methods

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

Properties

`variable_type`	Variable type of the object.
`lower_bound`	Hard lower bound for the variable.
`upper_bound`	Hard upper bound for the variable.
`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 RealMetadata

Property detail#

property RealMetadata.variable_type: VariableType#

Variable type of the object.

Returns:

VariableType: Variable type of the object.

property RealMetadata.lower_bound: ansys.tools.variableinterop.scalar_values.RealValue | None#

Hard lower bound for the variable.

Systems utilizing this variable should prevent setting the value below this lower bound. This is typically used to represent physical impossibilities (negative length) or limits of the simulation software. Values below this hard lower bound cause an error or invalid result. This may not be the soft bounds used for an optimization design parameter or DOE exploration.

Returns:

Optional[RealValue]: Lower bound or None if no lower bound is specified.

property RealMetadata.upper_bound: ansys.tools.variableinterop.scalar_values.RealValue | None#

Hard upper bound for the variable.

Systems utilizing this variable should prevent setting the value above this upper bound. This is typically used to represent physical impossibilities (100%) or limits of the simulation software. Values above this hard upper bound cause an error or invalid result. This may not be the soft bounds used for an optimization design parameter or DOE exploration.

Returns:

Optional[RealValue]: Upper bound or None if no upper bound is specified.

property RealMetadata.enumerated_values: List[ansys.tools.variableinterop.scalar_values.RealValue]#

List of enumerated values.

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

Returns:

List[RealValue]: List of enumerated values.

property RealMetadata.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#

RealMetadata.__eq__(other)#: Determine if the object is equal to the metadata.

RealMetadata.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.

RealMetadata.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.