FaceStub

class ansys.speos.core.kernel.face.FaceStub(channel)

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

Database interactions for face.

Parameters:

channelgrpc.Channel

Channel to use for the stub.

Examples

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

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

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.face import FaceStub

Method detail

FaceStub.create(message)

Create a new entry.

Parameters:

messageface.Face

Datamodel for the new entry.

Returns:

ansys.speos.core.kernel.face.FaceLink

Link object created.

FaceStub.read(ref)

Get an existing entry.

Parameters:

refansys.speos.core.kernel.face.FaceLink

Link object to read.

Returns:

face.Face

Datamodel of the entry.

FaceStub.update(ref, data)

Change an existing entry.

Parameters:

refansys.speos.core.kernel.face.FaceLink

Link object to update.

dataface.Face

New datamodel for the entry.

FaceStub.delete(ref)

Remove an existing entry.

Parameters:

refansys.speos.core.kernel.face.FaceLink

Link object to delete.

FaceStub.list()

List existing entries.

Returns:

List[ansys.speos.core.kernel.face.FaceLink]

Link objects.