SOPTemplateStub

class ansys.speos.core.kernel.sop_template.SOPTemplateStub(channel)

Bases: ansys.speos.core.kernel.crud.CrudStub

Database interactions for Surface Optical Properties templates.

Parameters:

channelgrpc.Channel

Channel to use for the stub.

Examples

The best way to get a SOPTemplateStub is to retrieve it from SpeosClient via sop_templates() method. Like in the following example:

>>> from ansys.speos.core.speos import Speos
>>> speos = Speos(host="localhost", port=50098)
>>> sop_t_db = speos.client.sop_templates()

Overview

Methods

create	Create a new entry.
read	Get an existing entry.
update	Change an existing entry.
delete	Remove an existing entry.
list	List existing entries.

Import detail

from ansys.speos.core.kernel.sop_template import SOPTemplateStub

Method detail

SOPTemplateStub.create(message)

Create a new entry.

Parameters:

messagesop_template.SOPTemplate

Datamodel for the new entry.

Returns:

ansys.speos.core.kernel.sop_template.SOPTemplateLink

Link object created.

SOPTemplateStub.read(ref)

Get an existing entry.

Parameters:

refansys.speos.core.kernel.sop_template.SOPTemplateLink

Link object to read.

Returns:

sop_template.SOPTemplate

Datamodel of the entry.

SOPTemplateStub.update(ref, data)

Change an existing entry.

Parameters:

refansys.speos.core.kernel.sop_template.SOPTemplateLink

Link object to update.

datasop_template.SOPTemplate

New datamodel for the entry.

SOPTemplateStub.delete(ref)

Remove an existing entry.

Parameters:

refansys.speos.core.kernel.sop_template.SOPTemplateLink

Link object to delete.

SOPTemplateStub.list()

List existing entries.

Returns:

List[ansys.speos.core.kernel.sop_template.SOPTemplateLink]

Link objects.