ansys.rocky.core.client

Module that defines the RockyClient class, which acts as a proxy for a Rocky application session.

Module Contents

Classes

RockyClient

Provides the client object for interacting with the Rocky app.

Functions

connect_to_rocky(→ RockyClient)

Connect to a Rocky app instance.

Attributes

DEFAULT_SERVER_PORT

ansys.rocky.core.client.DEFAULT_SERVER_PORT: Final[int] = 50615

ansys.rocky.core.client.connect_to_rocky(host: str = 'localhost', port: int = DEFAULT_SERVER_PORT) → RockyClient

Connect to a Rocky app instance.

Parameters:

hoststr, optional

Host name where the app is running. The default is "localhost".

portint, optional

Service port to connect to. The default is DEFAULT_SERVER_PORT, which is 50615.

Returns:

RockyClient

Client object for interacting with the Rocky app.

class ansys.rocky.core.client.RockyClient(rocky_api)

Provides the client object for interacting with the Rocky app.

Parameters:

rocky_apiPyro5.api.Proxy

Pyro5 proxy object for interacting with the Rocky app.

property api: ansys.rocky.core._api_stubs.rocky30.plugins.api.rocky_api_application.RockyApiApplication

close()