SourceTemplateLink

class ansys.speos.core.kernel.source_template.SourceTemplateLink(db, key)

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

Link object for a source template in database.

Parameters:

dbansys.speos.core.kernel.source_template.SourceTemplateStub

Database to link to.

keystr

Key of the source template in the database.

Parameters:

key (str)

Overview

Methods

get	Get the datamodel from database.
set	Change datamodel in database.
delete	Remove datamodel from database.
get_ray_file_info	Retrieve information about ray file source.

Special methods

__str__

Return the string representation of the source template.

Import detail

from ansys.speos.core.kernel.source_template import SourceTemplateLink

Method detail

SourceTemplateLink.__str__()

Return the string representation of the source template.

SourceTemplateLink.get()

Get the datamodel from database.

Returns:

source_template.SourceTemplate

Source template datamodel.

SourceTemplateLink.set(data)

Change datamodel in database.

Parameters:

datasource_template.SourceTemplate

New source template datamodel.

SourceTemplateLink.delete()

Remove datamodel from database.

SourceTemplateLink.get_ray_file_info()

Retrieve information about ray file source.

Returns:

ansys.api.speos.source.v1.source_pb2.GetRayFileInfo_Response

Information about ray file source, like flux value.