SimulationTemplateStub

class ansys.speos.core.kernel.simulation_template.SimulationTemplateStub(channel)

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

Database interactions for simulation templates.

Parameters:

channelgrpc.Channel

Channel to use for the stub.

Examples

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

>>> from ansys.speos.core.speos import Speos
>>> speos = Speos(host="localhost", port=50098)
>>> sim_t_db = speos.client.simulation_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.simulation_template import SimulationTemplateStub

Method detail

SimulationTemplateStub.create(message)

Create a new entry.

Parameters:

messagesimulation_template.SimulationTemplate

Datamodel for the new entry.

Returns:

ansys.speos.core.kernel.simulation_template.SimulationTemplateLink

Link object created.

SimulationTemplateStub.read(ref)

Get an existing entry.

Parameters:

refansys.speos.core.kernel.simulation_template.SimulationTemplateLink

Link object to read.

Returns:

simulation_template.SimulationTemplate

Datamodel of the entry.

SimulationTemplateStub.update(ref, data)

Change an existing entry.

Parameters:

refansys.speos.core.kernel.simulation_template.SimulationTemplateLink

Link object to update.

datasimulation_template.SimulationTemplate

New datamodel for the entry.

SimulationTemplateStub.delete(ref)

Remove an existing entry.

Parameters:

refansys.speos.core.kernel.simulation_template.SimulationTemplateLink

Link object to delete.

SimulationTemplateStub.list()

List existing entries.

Returns:

List[ansys.speos.core.kernel.simulation_template.SimulationTemplateLink]

Link objects.