BodyStub

class ansys.speos.core.kernel.body.BodyStub(channel)

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

Database interactions for body.

Parameters:

channelgrpc.Channel

Channel to use for the stub.

Examples

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

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

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.body import BodyStub

Method detail

BodyStub.create(message)

Create a new entry.

Parameters:

messagebody.Body

Datamodel for the new entry.

Returns:

ansys.speos.core.kernel.body.BodyLink

Link object created.

BodyStub.read(ref)

Get an existing entry.

Parameters:

refansys.speos.core.kernel.body.BodyLink

Link object to read.

Returns:

body.Body

Datamodel of the entry.

BodyStub.update(ref, data)

Change an existing entry.

Parameters:

refansys.speos.core.kernel.body.BodyLink

Link object to update.

databody.Body

New datamodel for the entry.

BodyStub.delete(ref)

Remove an existing entry.

Parameters:

refansys.speos.core.kernel.body.BodyLink

Link object to delete.

BodyStub.list()

List existing entries.

Returns:

List[ansys.speos.core.kernel.body.BodyLink]

Link objects.