VOPTemplateStub

class ansys.speos.core.kernel.vop_template.VOPTemplateStub(channel)

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

Database interactions for Volume Optical Properties templates.

Parameters:

channelgrpc.Channel

Channel to use for the stub.

Examples

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

>>> from ansys.speos.core.speos import Speos
>>> speos = Speos(host="localhost", port=50098)
>>> vop_t_db = speos.client.vop_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.vop_template import VOPTemplateStub

Method detail

VOPTemplateStub.create(message)

Create a new entry.

Parameters:

messagevop_template.VOPTemplate

Datamodel for the new entry.

Returns:

ansys.speos.core.kernel.vop_template.VOPTemplateLink

Link object created.

VOPTemplateStub.read(ref)

Get an existing entry.

Parameters:

refansys.speos.core.kernel.vop_template.VOPTemplateLink

Link object to read.

Returns:

vop_template.VOPTemplate

Datamodel of the entry.

VOPTemplateStub.update(ref, data)

Change an existing entry.

Parameters:

refansys.speos.core.kernel.vop_template.VOPTemplateLink

Link object to update.

datavop_template.VOPTemplate

New datamodel for the entry.

VOPTemplateStub.delete(ref)

Remove an existing entry.

Parameters:

refansys.speos.core.kernel.vop_template.VOPTemplateLink

Link object to delete.

VOPTemplateStub.list()

List existing entries.

Returns:

List[ansys.speos.core.kernel.vop_template.VOPTemplateLink]

Link objects.