SceneStub

class ansys.speos.core.kernel.scene.SceneStub(channel)

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

Database interactions for scenes.

Parameters:

channelgrpc.Channel

Channel to use for the stub.

Examples

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

>>> from ansys.speos.core.speos import Speos
>>> speos = Speos(host="localhost", port=50098)
>>> sce_db = speos.client.scenes()

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.scene import SceneStub

Method detail

SceneStub.create(message=None)

Create a new entry.

Parameters:

messagescene.Scene, optional.

Datamodel for the new entry.

Returns:

ansys.speos.core.kernel.scene.SceneLink

Link object created.

SceneStub.read(ref)

Get an existing entry.

Parameters:

refansys.speos.core.kernel.scene.SceneLink

Link object to read.

Returns:

scene.Scene

Datamodel of the entry.

SceneStub.update(ref, data)

Change an existing entry.

Parameters:

refansys.speos.core.kernel.scene.SceneLink

Link object to update.

datascene.Scene

New datamodel for the entry.

SceneStub.delete(ref)

Remove an existing entry.

Parameters:

refansys.speos.core.kernel.scene.SceneLink

Link object to delete.

SceneStub.list()

List existing entries.

Returns:

List[ansys.speos.core.kernel.scene.SceneLink]

Link objects.