IntensityTemplateLink

class ansys.speos.core.kernel.intensity_template.IntensityTemplateLink(db, key)

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

Link object for intensity template in database.

Parameters:

dbansys.speos.core.kernel.intensity_template.IntensityTemplateStub

Database to link to.

keystr

Key of the body in the database.

Parameters:

key (str)

Examples

>>> from ansys.speos.core.speos import Speos
>>> from ansys.speos.core.kernel.intensity_template import (
...     ProtoIntensityTemplate,
... )
>>> speos = Speos(host="localhost", port=50098)
>>> int_t_db = speos.client.intensity_templates()
>>> int_t_message = ProtoIntensityTemplate(name="Cos_3_170")
>>> int_t_message.cos.N = 3.0
>>> int_t_message.cos.total_angle = 170
>>> int_t_link = int_t_db.create(message=int_t_message)

Overview

Methods

get	Get the datamodel from database.
set	Change datamodel in database.
delete	Remove datamodel from database.
get_library_type_info	Retrieve information about intensity template in case of library type.

Special methods

__str__

Return the string representation of the intensity_template.

Import detail

from ansys.speos.core.kernel.intensity_template import IntensityTemplateLink

Method detail

IntensityTemplateLink.__str__()

Return the string representation of the intensity_template.

IntensityTemplateLink.get()

Get the datamodel from database.

Returns:

intensity_template.IntensityTemplate

IntensityTemplate datamodel.

IntensityTemplateLink.set(data)

Change datamodel in database.

Parameters:

dataintensity_template.IntensityTemplate

New IntensityTemplate datamodel.

IntensityTemplateLink.delete()

Remove datamodel from database.

IntensityTemplateLink.get_library_type_info()

Retrieve information about intensity template in case of library type.

Returns:

ansys.api.speos.intensity.v1.intensity_pb2.GetLibraryTypeInfo_Response

Information about intensity template, like flux value.