Summary

Classes

ApiElementProxy	Provides a proxy object for an API element.
ApiListProxy	Provides a proxy object for API elements that implement the sequence interface.
ApiGridFunctionProxy
ApiExportToolkitProxy

Description

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

Module detail

class rocky_api_proxies.ApiElementProxy(pyro_api: Pyro5.api.Proxy, pool_id: str)

Provides a proxy object for an API element.

Parameters:

pyro_apiPyro5.api.Proxy

Pyro5 proxy object for interacting with the Rocky app.

pool_idint

ID of the API element.

Overview

Constructors

serialize

Serialize a proxy object of the API element.

Special methods

__getattr__

Import detail

from ansys.rocky.core.rocky_api_proxies import ApiElementProxy

Method detail

ApiElementProxy.__getattr__(attr_name: str) → object

classmethod ApiElementProxy.serialize(obj: ApiElementProxy) → dict

Serialize a proxy object of the API element.

Parameters:

objAny

Object to serialize.

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

Constructors

serialize

Serialize a proxy object of the API element.

Special methods

__len__
__getitem__
__iter__
__delitem__
__getattr__

Import detail

from ansys.rocky.core.rocky_api_proxies import ApiListProxy

Method detail

ApiListProxy.__len__() → int

ApiListProxy.__getitem__(index: int) → ApiElementProxy

ApiListProxy.__iter__() → collections.abc.Generator[ApiElementProxy, None, None]

ApiListProxy.__delitem__(index: int) → None

ApiListProxy.__getattr__(attr_name: str) → object

classmethod ApiListProxy.serialize(obj: ApiElementProxy) → dict

Serialize a proxy object of the API element.

Parameters:

objAny

Object to serialize.

Returns:

dict

Dictionary of the serialized object.

class ApiListProxy.ApiGridFunctionProxy(grid_pool_id: str, gf_name: str, pyro_api: Pyro5.api.Proxy)

Overview

Constructors

serialize

Serialize a proxy object of the API Grid Functions.

Special methods

__getattr__

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:

objAny

Object to serialize.

Returns:

dict

Dictionary of the serialized object.

class ApiGridFunctionProxy.ApiExportToolkitProxy(pyro_api: Pyro5.api.Proxy)

Overview

Constructors

serialize

Serialize a proxy object of the API ExportToolkit object.

Special methods

__getattr__

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:

objAny

Object to serialize.

Returns:

dict

Dictionary of the serialized object.