The progress_handler.py
module#
Summary#
|
Interface for simulation progress updates. |
Progress information. |
|
|
Creates a progress bar for a single simulation. |
|
Simulation progress status. |
Description#
Provides progress updates.
Module detail#
- class progress_handler.Progress(/, **data: Any)#
Bases:
pydantic.BaseModel
Progress information.
Overview#
Create a |
Import detail#
from ansys.additive.core.progress_handler import Progress
Attribute detail#
- Progress.state: ProgressState#
Method detail#
- classmethod Progress.from_proto_msg(sim_id: str, progress: ansys.api.additive.v0.additive_domain_pb2.Progress)#
Create a
Progress
object from a progress protobuf message.
- class Progress.DefaultSingleSimulationProgressHandler#
Bases:
IProgressHandler
Creates a progress bar for a single simulation.
- Parameters:
- sim_id
str
Simulation ID.
- sim_id
Overview#
Update the progress bar. |
Import detail#
from ansys.additive.core.progress_handler import DefaultSingleSimulationProgressHandler
Method detail#
Overview#
Update progress. |
Import detail#
from ansys.additive.core.progress_handler import IProgressHandler
Method detail#
- abstract IProgressHandler.update(progress: Progress)#
Update progress.
- Parameters:
- progress
Progress
Progress information.
- progress
- class IProgressHandler.ProgressState#
Bases:
enum.IntEnum
Simulation progress status.
Overview#
Import detail#
from ansys.additive.core.progress_handler import ProgressState
Attribute detail#
- ProgressState.WAITING#
Waiting for the simulation to start.
- ProgressState.RUNNING#
Simulation is running.
- ProgressState.COMPLETED#
Simulation has completed.
- ProgressState.ERROR#
Simulation has errored.