Download as Python script

Download as Jupyter notebook

Download example’s assets

How to use an ObjectLink#

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)

[1]:

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

Create connection with speos rpc server

[2]:

speos = Speos(host="localhost", port=50098)

Create an ObjectLink#

Retrieve the access to the database.

[3]:

sop_t_db = speos.client.sop_templates()

Create the protobuf message.

[4]:

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

Create the ObjectLink (here a SOPTemplateLink).

[5]:

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.

[6]:

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.

[7]:

mirror_data = mirror_90_link.get()

Modify data locally

[8]:

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

Update on db

[9]:

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

[10]:

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

[10]:

[]