SOPTemplateLink

class ansys.speos.core.kernel.sop_template.SOPTemplateLink(db, key)

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

Link object for Surface Optical Properties template in database.

Parameters:

dbansys.speos.core.kernel.sop_template.SOPTemplateStub

Database to link to.

keystr

Key of the sop_template in the database.

Parameters:

key (str)

Examples

>>> from ansys.speos.core.speos import Speos
>>> from ansys.speos.core.kernel.sop_template import ProtoSOPTemplate
>>> speos = Speos(host="localhost", port=50098)
>>> sop_t_db = speos.client.sop_templates()
>>> sop_t_message = ProtoSOPTemplate(name="Mirror_50")
>>> sop_t_message.mirror.reflectance = 50
>>> sop_t_link = sop_t_db.create(message=sop_t_message)

Overview

Methods

get	Get the datamodel from database.
set	Change datamodel in database.
delete	Remove datamodel from database.

Special methods

__str__

Return the string representation of the sop_template.

Import detail

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

Method detail

SOPTemplateLink.__str__()

Return the string representation of the sop_template.

SOPTemplateLink.get()

Get the datamodel from database.

Returns:

sop_template.SOPTemplate

SOPTemplate datamodel.

SOPTemplateLink.set(data)

Change datamodel in database.

Parameters:

datasop_template.SOPTemplate

New SOPTemplate datamodel.

SOPTemplateLink.delete()

Remove datamodel from database.