VOPTemplateLink

class ansys.speos.core.kernel.vop_template.VOPTemplateLink(db, key)

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

Link object for a Volume Optical Property (VOP) template in database.

Parameters:

dbansys.speos.core.kernel.vop_template.VOPTemplateStub

Database to link to.

keystr

Key of the vop template in the database.

Parameters:

key (str)

Examples

>>> from ansys.speos.core.speos import Speos
>>> from ansys.speos.core.kernel.vop_template import ProtoVOPTemplate
>>> speos = Speos(host="localhost", port=50098)
>>> vop_t_db = speos.client.vop_templates()
>>> vop_t_message = ProtoVOPTemplate(name="Opaque")
>>> vop_t_message.opaque.SetInParent()
>>> vop_t_link = vop_t_db.create(message=vop_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 vop template.

Import detail

from ansys.speos.core.kernel.vop_template import VOPTemplateLink

Method detail

VOPTemplateLink.__str__()

Return the string representation of the vop template.

VOPTemplateLink.get()

Get the datamodel from database.

Returns:

vop_template.VOPTemplate

VOPTemplate datamodel.

VOPTemplateLink.set(data)

Change datamodel in database.

Parameters:

datavop_template.VOPTemplate

New VOPTemplate datamodel.

VOPTemplateLink.delete()

Remove datamodel from database.