FileMetadata

class ansys.tools.variableinterop.file_metadata.FileMetadata

Bases: ansys.tools.variableinterop.common_variable_metadata.CommonVariableMetadata

Provides metadata for the File variable type.

Overview

Constructors

from_dict

Creates a new metadata object from the data from a call to to_dict().

Methods

accept	Invoke the visitor pattern of this object using the passed-in visitor
equals	Determine if the object is equal to the metadata.
to_dict	Creates a dictionary representation of this object suitable for JSON

Properties

variable_type

Variable type of the object.

Special methods

__eq__

Determine if the object is equal to the metadata.

Import detail

from ansys.tools.variableinterop.file_metadata import FileMetadata

Property detail

property FileMetadata.variable_type: ansys.tools.variableinterop.variable_type.VariableType

Variable type of the object.

Returns:

VariableType

Variable type of the object.

Method detail

FileMetadata.__eq__(other)

Determine if the object is equal to the metadata.

FileMetadata.accept(visitor: ansys.tools.variableinterop.ivariablemetadata_visitor.IVariableMetadataVisitor[T]) → 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.

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

FileMetadata.to_dict() → dict

Creates a dictionary representation of this object suitable for JSON serialization.

Returns:

dict

The generated dictionary

classmethod FileMetadata.from_dict(data) → FileMetadata

Creates a new metadata object from the data from a call to to_dict().

Parameters:

data

The serialized dictionary data.

Returns:

CommonVariableMetadata

The new metadata object.