The serializers.py module

Summary

Functions

register_proxies
deserialize_api_element	Deserialize the proxy objects for the API element.
deserialize_api_list	Deserialize the proxy objects for the API list element.
deserialize_api_grid_function	Deserialize the proxy objects for the API grid function.
deserialize_api_exporttoolkit	Deserialize the proxy objects for the API element.
deserialize_api_project	Deserialize the proxy objects for the API project.
deserialize_api_error	Deserialize an API error.
deserialize_numpy	Deserialize a numpy array.

Description

Module that defines the ApiElementProxy classes, which acts as a proxy for a Rocky application internal objects.

Module detail

serializers.register_proxies() → None

serializers.deserialize_api_element(classname: str, serialized: dict) → ansys.rocky.core.rocky_api_proxies.ApiElementProxy

Deserialize the proxy objects for the API element.

Parameters:

serializeddict

Dictionary of serialized objects.

classnamestr

Name of the class to deserialize. This parameter is required by the superclass but is not used.

Returns:

ApiElementProxy

Deserialized object.

serializers.deserialize_api_list(classname: str, serialized: dict) → ansys.rocky.core.rocky_api_proxies.ApiListProxy

Deserialize the proxy objects for the API list element.

Parameters:

serializeddict

Dictionary of serialized objects.

classnamestr

Name of the class to deserialize. This parameter is required by the superclass but is not used.

Returns:

ApiListProxy

Deserialized object.

serializers.deserialize_api_grid_function(classname: str, serialized: dict) → ansys.rocky.core.rocky_api_proxies.ApiGridFunctionProxy

Deserialize the proxy objects for the API grid function.

Parameters:

classnamestr

Name of the class to deserialize. This parameter is required by the superclass but is not used.

serializeddict

Dictionary of serialized objects.

Returns:

ApiGridFunctionProxy

Deserialized object.

serializers.deserialize_api_exporttoolkit(classname: str, serialized: dict) → ansys.rocky.core.rocky_api_proxies.ApiExportToolkitProxy

Deserialize the proxy objects for the API element.

Parameters:

classnamestr

Name of the class to deserialize. This parameter is required by the superclass but is not used.

serializeddict

Dictionary of serialized objects.

Returns:

ApiExportToolkitProxy

Deserialized object.

serializers.deserialize_api_project(classname: str, serialized: dict) → ansys.rocky.core.rocky_api_proxies.ApiProjectProxy

Deserialize the proxy objects for the API project.

Parameters:

classnamestr

Name of the class to deserialize. This parameter is required by the superclass but is not used.

serializeddict

Dictionary of serialized objects.

Returns:

ApiProjectProxy

Deserialized object.

serializers.deserialize_api_error(classname: str, serialized: dict) → Exception

Deserialize an API error.

Parameters:

classnamestr

Name of the class to deserialize. This parameter is required by the superclass but is not used.

serializeddict

Dictionary of the serialized object.

Returns:

RockyApiError

Error in the serialized object.

serializers.deserialize_numpy(classname: str, serialized: dict) → Any

Deserialize a numpy array.

Parameters:

classnamestr

Name of the class to deserialize. This parameter is required by the superclass but is not used.

serializeddict

Dictionary of the serialized object.

Returns:

Any

Deserialized object.