SpectrumStub

class ansys.speos.core.kernel.spectrum.SpectrumStub(channel)

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

Database interactions for spectrums.

Parameters:

channelgrpc.Channel

Channel to use for the stub.

Examples

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

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

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.spectrum import SpectrumStub

Method detail

SpectrumStub.create(message)

Create a new entry.

Parameters:

messagespectrum.Spectrum

Datamodel for the new entry.

Returns:

ansys.speos.core.kernel.spectrum.SpectrumLink

Link object created.

SpectrumStub.read(ref)

Get an existing entry.

Parameters:

refansys.speos.core.kernel.spectrum.SpectrumLink

Link object to read.

Returns:

spectrum.Spectrum

Datamodel of the entry.

SpectrumStub.update(ref, data)

Change an existing entry.

Parameters:

refansys.speos.core.kernel.spectrum.SpectrumLink

Link object to update.

dataspectrum.Spectrum

New datamodel for the entry.

SpectrumStub.delete(ref)

Remove an existing entry.

Parameters:

refansys.speos.core.kernel.spectrum.SpectrumLink

Link object to delete.

SpectrumStub.list()

List existing entries.

Returns:

List[ansys.speos.core.kernel.spectrum.SpectrumLink]

Link objects.