Download as Python script

Download as Jupyter notebook

Download example’s assets

---

# # How to use an ObjectLink
from ansys.speos.core import launcher

# This tutorial demonstrates how to use speos objects in layer core.
# ## What is an ObjectLink?
# The ObjectLink is an object that is created from a protobuf message and then stored in the server
# database.
# ## Which speos objects are used via ObjectLink?
# Almost all speos objects are used via ObjectLink: like sources, sensors, simulations and more.
# For this tutorial we will use as example the surface optical property (sop)
# ## Prerequisites
#
# ### Perform imports

from ansys.speos.core.kernel.sop_template import ProtoSOPTemplate
from ansys.speos.core.speos import Speos

Define constants

Constants help ensure consistency and avoid repetition throughout the example.

HOSTNAME = "localhost"
GRPC_PORT = 50098  # Be sure the Speos GRPC Server has been started on this port.
USE_DOCKER = True  # Set to False if you're running this example locally as a Notebook.

Start/Connect to Speos RPC Server

This Python client connects to a server where the Speos engine is running as a service. In this example, the server and client are the same machine. The launch_local_speos_rpc_method can be used to start a local instance of the service.

if USE_DOCKER:
    speos = Speos(host=HOSTNAME, port=GRPC_PORT)
else:
    speos = launcher.launch_local_speos_rpc_server(port=GRPC_PORT)

Create an ObjectLink

Retrieve the access to the database.

sop_t_db = speos.client.sop_templates()

Create the protobuf message.

sop_t = ProtoSOPTemplate()
sop_t.name = "Mirror_90"
sop_t.mirror.reflectance = 90.0

Create the ObjectLink (here a SOPTemplateLink).

mirror_90_link = sop_t_db.create(message=sop_t)
print(mirror_90_link)

ansys.api.speos.sop.v1.SOPTemplate
{
    "name": "Mirror_90",
    "mirror": {
        "reflectance": 90.0
    },
    "description": "",
    "metadata": {}
}

Create another ObjectLink from another protobuf message.

sop_t = ProtoSOPTemplate()
sop_t.name = "Mirror_100"
sop_t.mirror.reflectance = 100.0

mirror_100_link = sop_t_db.create(message=sop_t)

Modify an ObjectLink

Retrieve the protobuf message corresponding to the ObjectLink.

mirror_data = mirror_90_link.get()

Modify data locally

mirror_data.name = "Mirror_50"
mirror_data.mirror.reflectance = 50

Update on db

mirror_90_link.set(data=mirror_data)
print(mirror_90_link)

ansys.api.speos.sop.v1.SOPTemplate
{
    "name": "Mirror_50",
    "mirror": {
        "reflectance": 50.0
    },
    "description": "",
    "metadata": {}
}

Delete an ObjectLink

This means deleting data in db

mirror_100_link.delete()
mirror_90_link.delete()
sop_t_db.list()

[]

speos.close()

True