Summary#
Provides a proxy object for an API element. |
|
Provides a proxy object for API elements that implement the sequence interface. |
|
Description#
Module that defines the ApiElementProxy
classes, which acts as a proxy for a
Rocky application internal objects.
Module detail#
Overview#
Serialize a proxy object of the API element. |
Import detail#
from ansys.rocky.core.rocky_api_proxies import ApiElementProxy
Method detail#
- classmethod ApiElementProxy.serialize(obj: ApiElementProxy) dict #
Serialize a proxy object of the API element.
- Parameters:
- obj
Any
Object to serialize.
- obj
- Returns:
dict
Dictionary of the serialized object.
- class ApiElementProxy.ApiListProxy(pyro_api: Pyro5.api.Proxy, pool_id: str)#
Bases:
ApiElementProxy
Provides a proxy object for API elements that implement the sequence interface.
Overview#
Serialize a proxy object of the API element. |
Import detail#
from ansys.rocky.core.rocky_api_proxies import ApiListProxy
Method detail#
- ApiListProxy.__getitem__(index: int) ApiElementProxy #
- ApiListProxy.__iter__() collections.abc.Generator[ApiElementProxy, None, None] #
- classmethod ApiListProxy.serialize(obj: ApiElementProxy) dict #
Serialize a proxy object of the API element.
- Parameters:
- obj
Any
Object to serialize.
- obj
- Returns:
dict
Dictionary of the serialized object.
Overview#
Serialize a proxy object of the API Grid Functions. |
Import detail#
from ansys.rocky.core.rocky_api_proxies import ApiGridFunctionProxy
Method detail#
- ApiGridFunctionProxy.__getattr__(attr_name: str) collections.abc.Callable #
- classmethod ApiGridFunctionProxy.serialize(obj: ApiGridFunctionProxy) dict #
Serialize a proxy object of the API Grid Functions.
- Parameters:
- obj
Any
Object to serialize.
- obj
- Returns:
dict
Dictionary of the serialized object.
- class ApiGridFunctionProxy.ApiExportToolkitProxy(pyro_api: Pyro5.api.Proxy)#
Overview#
Serialize a proxy object of the API ExportToolkit object. |
Import detail#
from ansys.rocky.core.rocky_api_proxies import ApiExportToolkitProxy
Method detail#
- ApiExportToolkitProxy.__getattr__(attr_name: str) collections.abc.Callable #
- classmethod ApiExportToolkitProxy.serialize(obj: ApiExportToolkitProxy) dict #
Serialize a proxy object of the API ExportToolkit object.
- Parameters:
- obj
Any
Object to serialize.
- obj
- Returns:
dict
Dictionary of the serialized object.