JobLink

class ansys.speos.core.kernel.job.JobLink(db, key)

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

Link object for job in database.

Parameters:

dbansys.speos.core.kernel.job.JobStub

Database to link to.

keystr

Key of the job in the database.

Parameters:

key (str)

Overview

Methods

get	Get the datamodel from database.
set	Change datamodel in database.
delete	Remove datamodel from database.
get_state	Retrieve job state.
start	Start the job.
stop	Stop the job.
get_error	Retrieve job error.
get_results	Retrieve job results.
get_progress_status	Retrieve job progress.
get_ray_paths	Retrieve ray paths.

Special methods

__str__

Return the string representation of the Job.

Import detail

from ansys.speos.core.kernel.job import JobLink

Method detail

JobLink.__str__()

Return the string representation of the Job.

JobLink.get()

Get the datamodel from database.

Returns:

job.Job

Job datamodel.

JobLink.set(data)

Change datamodel in database.

Parameters:

datajob.Job

New Job datamodel.

JobLink.delete()

Remove datamodel from database.

JobLink.get_state()

Retrieve job state.

Returns:

ansys.api.speos.job.v2.job_pb2.GetState_Response

State of the job.

JobLink.start()

Start the job.

JobLink.stop()

Stop the job.

JobLink.get_error()

Retrieve job error.

Returns:

ansys.api.speos.job.v2.job_pb2.GetError_Response

Error of the job.

JobLink.get_results()

Retrieve job results.

Returns:

ansys.api.speos.job.v2.job_pb2.GetResults_Response

Results of the job.

JobLink.get_progress_status()

Retrieve job progress.

Returns:

ansys.api.speos.job.v2.job_pb2.GetProgressStatus_Response

Progress status of the job.

JobLink.get_ray_paths()

Retrieve ray paths.

Available for interactive simulation.

Returns:

Iterator[ansys.api.speos.results.v1.ray_path_pb2.RayPath]

Ray paths generated by the interactive simulation.