SourceTemplateStub

class ansys.speos.core.kernel.source_template.SourceTemplateStub(channel)

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

Database interactions for source templates.

Parameters:

channelgrpc.Channel

Channel to use for the stub.

Examples

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

>>> from ansys.speos.core.speos import Speos
>>> speos = Speos(host="localhost", port=50098)
>>> src_t_db = speos.client.source_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.source_template import SourceTemplateStub

Method detail

SourceTemplateStub.create(message)

Create a new entry.

Parameters:

messagesource_template.SourceTemplate

Datamodel for the new entry.

Returns:

ansys.speos.core.kernel.source_template.SourceTemplateLink

Link object created.

SourceTemplateStub.read(ref)

Get an existing entry.

Parameters:

refansys.speos.core.kernel.source_template.SourceTemplateLink

Link object to read.

Returns:

source_template.SourceTemplate

Datamodel of the entry.

SourceTemplateStub.update(ref, data)

Change an existing entry.

Parameters:

refansys.speos.core.kernel.source_template.SourceTemplateLink

Link object to update.

datasource_template.SourceTemplate

New datamodel for the entry.

SourceTemplateStub.delete(ref)

Remove an existing entry.

Parameters:

refansys.speos.core.kernel.source_template.SourceTemplateLink

Link object to delete.

SourceTemplateStub.list()

List existing entries.

Returns:

List[ansys.speos.core.kernel.source_template.SourceTemplateLink]

Link objects.