em.workflow.v1#
Classes:
-
EdsAcquisitionMode–Enum indicating the acquisition mode.
-
VacuumParameter–List of parameters that can be called on the Vacuum.
-
WorkflowState–WorkflowState.
-
EdsSpectrumAcquisitionSettings–EDS spectrum acquisition setting.
-
EmRegionOfInterest–The EM region of interest settings.
-
CreateWorkflowServiceAddAbsoluteTiltingActionRequest–The CreateWorkflowServiceAddAbsoluteTiltingActionRequest class.
-
CreateWorkflowServiceAddAbsoluteTiltingActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddAcquireNavCamImageActionRequest–The CreateWorkflowServiceAddAcquireNavCamImageActionRequest class.
-
CreateWorkflowServiceAddAcquireNavCamImageActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddAcquireStoreImageActionRequest–The CreateWorkflowServiceAddAcquireStoreImageActionRequest class.
-
CreateWorkflowServiceAddAcquireStoreImageActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddChangeBeamStateActionRequest–The CreateWorkflowServiceAddChangeBeamStateActionRequest class.
-
CreateWorkflowServiceAddChangeBeamStateActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddChangeCurrentActionRequest–The CreateWorkflowServiceAddChangeCurrentActionRequest class.
-
CreateWorkflowServiceAddChangeCurrentActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddChangeEhtActionRequest–The CreateWorkflowServiceAddChangeEhtActionRequest class.
-
CreateWorkflowServiceAddChangeEhtActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddEdsAcquisitionSettingsParameterActionRequest–The CreateWorkflowServiceAddEdsAcquisitionSettingsParameterActionRequest class.
-
CreateWorkflowServiceAddEdsAcquisitionSettingsParameterActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddFocusAndFovActionRequest–The CreateWorkflowServiceAddFocusAndFovActionRequest class.
-
CreateWorkflowServiceAddFocusAndFovActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddGoToStoredPositionActionRequest–The CreateWorkflowServiceAddGoToStoredPositionActionRequest class.
-
CreateWorkflowServiceAddGoToStoredPositionActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddInitializeActionRequest–The CreateWorkflowServiceAddInitializeActionRequest class.
-
CreateWorkflowServiceAddInitializeActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddMoveStageRelativeActionRequest–The CreateWorkflowServiceAddMoveStageRelativeActionRequest class.
-
CreateWorkflowServiceAddMoveStageRelativeActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddPositionControlledTiltActionRequest–The CreateWorkflowServiceAddPositionControlledTiltActionRequest class.
-
CreateWorkflowServiceAddPositionControlledTiltActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddRestoreFibProbeActionRequest–The CreateWorkflowServiceAddRestoreFibProbeActionRequest class.
-
CreateWorkflowServiceAddRestoreFibProbeActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddSetFibProbeActionRequest–The CreateWorkflowServiceAddSetFibProbeActionRequest class.
-
CreateWorkflowServiceAddSetFibProbeActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddSetFibWithValuesActionRequest–The CreateWorkflowServiceAddSetFibWithValuesActionRequest class.
-
CreateWorkflowServiceAddSetFibWithValuesActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddSetVacuumParameterActionRequest–The CreateWorkflowServiceAddSetVacuumParameterActionRequest class.
-
CreateWorkflowServiceAddSetVacuumParameterActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddSpotParameterActionRequest–The CreateWorkflowServiceAddSpotParameterActionRequest class.
-
CreateWorkflowServiceAddSpotParameterActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddStoreFibProbeActionRequest–The CreateWorkflowServiceAddStoreFibProbeActionRequest class.
-
CreateWorkflowServiceAddStoreFibProbeActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddTouchAlarmGeneratorActionRequest–The CreateWorkflowServiceAddTouchAlarmGeneratorActionRequest class.
-
CreateWorkflowServiceAddTouchAlarmGeneratorActionResponse–ActionResponse response.
-
CreateWorkflowServiceAddVacuumCommandActionRequest–The CreateWorkflowServiceAddVacuumCommandActionRequest class.
-
CreateWorkflowServiceAddVacuumCommandActionResponse–ActionResponse response.
-
RunWorkflowServiceBreakRequest–The RunWorkflowServiceBreakRequest class.
-
RunWorkflowServiceBreakResponse–The RunWorkflowServiceBreakResponse class.
-
RunWorkflowServiceDefineAndRunCompleteWorkflowRequest–The RunWorkflowServiceDefineAndRunCompleteWorkflowRequest class.
-
RunWorkflowServiceDefineAndRunCompleteWorkflowResponse–Response object of the RunWorkflow method.
-
RunWorkflowServiceGetWorkflowByIdRequest–The RunWorkflowServiceGetWorkflowByIdRequest class.
-
RunWorkflowServiceGetWorkflowByIdResponse–Response object of the GetWorkflow method.
-
RunWorkflowServiceGetWorkflowStateRequest–The RunWorkflowServiceGetWorkflowStateRequest class.
-
RunWorkflowServiceGetWorkflowStateResponse–Response object of the RunWorkflowApi.
-
RunWorkflowServiceNextRequest–The RunWorkflowServiceNextRequest class.
-
RunWorkflowServiceNextResponse–The RunWorkflowServiceNextResponse class.
-
RunWorkflowServicePauseRequest–The RunWorkflowServicePauseRequest class.
-
RunWorkflowServicePauseResponse–The RunWorkflowServicePauseResponse class.
-
RunWorkflowServiceRegisterOnActionExecutionIdChangedRequest–The RunWorkflowServiceRegisterOnActionExecutionIdChangedRequest class.
-
RunWorkflowServiceRegisterOnActionExecutionIdChangedResponse–ActionExecutionId response.
-
RunWorkflowServiceRegisterOnWorkflowStateChangedRequest–The RunWorkflowServiceRegisterOnWorkflowStateChangedRequest class.
-
RunWorkflowServiceRegisterOnWorkflowStateChangedResponse–Response object of the RunWorkflowApi.
-
RunWorkflowServiceResumeRequest–The RunWorkflowServiceResumeRequest class.
-
RunWorkflowServiceResumeResponse–The RunWorkflowServiceResumeResponse class.
-
RunWorkflowServiceRunWorkflowRequest–The RunWorkflowServiceRunWorkflowRequest class.
-
RunWorkflowServiceRunWorkflowResponse–Response object of the RunWorkflow method.
-
RunWorkflowServiceSetNormalModeRequest–The RunWorkflowServiceSetNormalModeRequest class.
-
RunWorkflowServiceSetNormalModeResponse–The RunWorkflowServiceSetNormalModeResponse class.
-
RunWorkflowServiceSetStepModeRequest–The RunWorkflowServiceSetStepModeRequest class.
-
RunWorkflowServiceSetStepModeResponse–The RunWorkflowServiceSetStepModeResponse class.
-
RunWorkflowServiceStartRequest–The RunWorkflowServiceStartRequest class.
-
RunWorkflowServiceStartResponse–The RunWorkflowServiceStartResponse class.
-
RunWorkflowServiceStepRequest–The RunWorkflowServiceStepRequest class.
-
RunWorkflowServiceStepResponse–The RunWorkflowServiceStepResponse class.
-
RunWorkflowServiceStopEmergencyRequest–The RunWorkflowServiceStopEmergencyRequest class.
-
RunWorkflowServiceStopEmergencyResponse–The RunWorkflowServiceStopEmergencyResponse class.
-
RunWorkflowServiceStopRequest–The RunWorkflowServiceStopRequest class.
-
RunWorkflowServiceStopResponse–The RunWorkflowServiceStopResponse class.
-
WorkflowAdminServiceDeleteWorkflowByIdRequest–The WorkflowAdminServiceDeleteWorkflowByIdRequest class.
-
WorkflowAdminServiceDeleteWorkflowByIdResponse–The WorkflowAdminServiceDeleteWorkflowByIdResponse class.
-
WorkflowAdminServiceGetAvailableWorkflowIdsRequest–The WorkflowAdminServiceGetAvailableWorkflowIdsRequest class.
-
WorkflowAdminServiceGetAvailableWorkflowIdsResponse–Response object of the GetAvailableWorkflowsIds method.
-
CreateWorkflowServiceStub– -
RunWorkflowServiceStub– -
WorkflowAdminServiceStub– -
CreateWorkflowServiceBase– -
RunWorkflowServiceBase– -
WorkflowAdminServiceBase–
Bases: Enum
Enum indicating the acquisition mode.
Attributes:
-
UNSPECIFIED–Default enum value.
-
AUTO–Auto selection of acquisition mode which is Counts.
-
LIVE_TIME–Acquire EDS data for a period of live time. This is the time for which the system is processing counts into the spectrum.
-
COUNTS–Acquisition continues until enough counts are collected in the spectrum.
class-attribute
instance-attribute
#
AUTO = 1
Auto selection of acquisition mode which is Counts. Acquisition continues until enough counts are collected in the spectrum.
class-attribute
instance-attribute
#
LIVE_TIME = 2
Acquire EDS data for a period of live time. This is the time for which the system is processing counts into the spectrum.
class-attribute
instance-attribute
#
COUNTS = 3
Acquisition continues until enough counts are collected in the spectrum.
Bases: Enum
List of parameters that can be called on the Vacuum.
Attributes:
-
UNSPECIFIED–Default enum value.
-
VARIABLE_PRESSURE_TARGET–Variable pressure.
Bases: Enum
WorkflowState.
Attributes:
-
UNSPECIFIED–Default value.
-
RUN_ACTIVE–Execution running.
-
RUN_PAUSED–Execution paused.
-
RUN_COMPLETED–Execution completed.
-
RUN_FAILED–Execution failed.
-
RUN_UNKNOWN–Unknown status, e.g. no run so far.
class-attribute
instance-attribute
#
RUN_UNKNOWN = 5
Unknown status, e.g. no run so far.
dataclass
#
EdsSpectrumAcquisitionSettings(acquisition_counts: int = betterproto.int32_field(1), acquisition_time: float = betterproto.double_field(2), acquisition_mode: EdsAcquisitionMode = betterproto.enum_field(3))
Bases: Message
EDS spectrum acquisition setting.
Attributes:
-
acquisition_counts(int) –The acquisition counts.
-
acquisition_time(float) –The acquisition time in seconds.
-
acquisition_mode(EdsAcquisitionMode) –A value indicating whether the acquisition mode (live time or counts).
class-attribute
instance-attribute
#
acquisition_counts: int = betterproto.int32_field(1)
The acquisition counts.
class-attribute
instance-attribute
#
acquisition_time: float = betterproto.double_field(2)
The acquisition time in seconds.
class-attribute
instance-attribute
#
acquisition_mode: EdsAcquisitionMode = betterproto.enum_field(3)
A value indicating whether the acquisition mode (live time or counts).
dataclass
#
EmRegionOfInterest(position_x: float = betterproto.double_field(1), position_y: float = betterproto.double_field(2), width: float = betterproto.double_field(3), height: float = betterproto.double_field(4))
Bases: Message
The EM region of interest settings.
Attributes:
-
position_x(float) –The X-coordinate of the region's position.
-
position_y(float) –The Y-coordinate of the region's position.
-
width(float) –The width of the region.
-
height(float) –The height of the region.
class-attribute
instance-attribute
#
position_x: float = betterproto.double_field(1)
The X-coordinate of the region's position.
class-attribute
instance-attribute
#
position_y: float = betterproto.double_field(2)
The Y-coordinate of the region's position.
class-attribute
instance-attribute
#
width: float = betterproto.double_field(3)
The width of the region.
class-attribute
instance-attribute
#
height: float = betterproto.double_field(4)
The height of the region.
dataclass
#
CreateWorkflowServiceAddAbsoluteTiltingActionRequest(workflow_id: str = betterproto.string_field(1), tilt_angle: float = betterproto.double_field(2))
Bases: Message
The CreateWorkflowServiceAddAbsoluteTiltingActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
tilt_angle(float) –The angle in degrees to which the tilting should occur. Defaults to 0 if not specified.
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
tilt_angle: float = betterproto.double_field(2)
The angle in degrees to which the tilting should occur. Defaults to 0 if not specified.
dataclass
#
CreateWorkflowServiceAddAbsoluteTiltingActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddAcquireNavCamImageActionRequest(workflow_id: str = betterproto.string_field(1), em_region_of_interest: EmRegionOfInterest = betterproto.message_field(2), file_name: str = betterproto.string_field(3))
Bases: Message
The CreateWorkflowServiceAddAcquireNavCamImageActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
em_region_of_interest(EmRegionOfInterest) –An ZenApi.EM.Workflow.V1.EmRegionOfInterest object specifying the region of interest for the NavCam image acquisition.
-
file_name(str) –The name of the file where the acquired NavCam image will be saved.
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
em_region_of_interest: EmRegionOfInterest = betterproto.message_field(2)
An ZenApi.EM.Workflow.V1.EmRegionOfInterest object specifying the region of interest for the NavCam image acquisition.
class-attribute
instance-attribute
#
file_name: str = betterproto.string_field(3)
The name of the file where the acquired NavCam image will be saved.
dataclass
#
CreateWorkflowServiceAddAcquireNavCamImageActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddAcquireStoreImageActionRequest(workflow_id: str = betterproto.string_field(1), em_region_of_interest: EmRegionOfInterest = betterproto.message_field(2), image_key: str = betterproto.string_field(3), position_name: str = betterproto.string_field(4), xoffset: float = betterproto.double_field(5), yoffset: float = betterproto.double_field(6), file_name: str = betterproto.string_field(7))
Bases: Message
The CreateWorkflowServiceAddAcquireStoreImageActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
em_region_of_interest(EmRegionOfInterest) –An ZenApi.EM.Workflow.V1.EmRegionOfInterest object specifying the region of interest for the image acquisition.
-
image_key(str) –A unique key identifier for the image to be stored.
-
position_name(str) –An optional name for the position associated with the image acquisition. Default is an empty string.
-
xoffset(float) –An optional X-coordinate offset for the image acquisition. Default is System.Double.NaN.
-
yoffset(float) –An optional Y-coordinate offset for the image acquisition. Default is System.Double.NaN.
-
file_name(str) –An optional file name for storing the acquired image. Default is an empty string.
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
em_region_of_interest: EmRegionOfInterest = betterproto.message_field(2)
An ZenApi.EM.Workflow.V1.EmRegionOfInterest object specifying the region of interest for the image acquisition.
class-attribute
instance-attribute
#
image_key: str = betterproto.string_field(3)
A unique key identifier for the image to be stored.
class-attribute
instance-attribute
#
position_name: str = betterproto.string_field(4)
An optional name for the position associated with the image acquisition. Default is an empty string.
class-attribute
instance-attribute
#
xoffset: float = betterproto.double_field(5)
An optional X-coordinate offset for the image acquisition. Default is System.Double.NaN.
class-attribute
instance-attribute
#
yoffset: float = betterproto.double_field(6)
An optional Y-coordinate offset for the image acquisition. Default is System.Double.NaN.
class-attribute
instance-attribute
#
file_name: str = betterproto.string_field(7)
An optional file name for storing the acquired image. Default is an empty string.
dataclass
#
CreateWorkflowServiceAddAcquireStoreImageActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddChangeBeamStateActionRequest(workflow_id: str = betterproto.string_field(1), desired_state: BeamState = betterproto.enum_field(2))
Bases: Message
The CreateWorkflowServiceAddChangeBeamStateActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
desired_state(BeamState) –The desired state of the beam, specified as a ZenApi.EM.Hardware.V1.BeamState enumeration.
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
desired_state: BeamState = betterproto.enum_field(2)
The desired state of the beam, specified as a ZenApi.EM.Hardware.V1.BeamState enumeration.
dataclass
#
CreateWorkflowServiceAddChangeBeamStateActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddChangeCurrentActionRequest(workflow_id: str = betterproto.string_field(1), target_current: float = betterproto.double_field(2))
Bases: Message
The CreateWorkflowServiceAddChangeCurrentActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
target_current(float) –The target current level to which the current should be adjusted.
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
target_current: float = betterproto.double_field(2)
The target current level to which the current should be adjusted.
dataclass
#
CreateWorkflowServiceAddChangeCurrentActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddChangeEhtActionRequest(workflow_id: str = betterproto.string_field(1), target_voltage: float = betterproto.double_field(2))
Bases: Message
The CreateWorkflowServiceAddChangeEhtActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
target_voltage(float) –The target voltage level to which the EHT should be changed.
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
target_voltage: float = betterproto.double_field(2)
The target voltage level to which the EHT should be changed.
dataclass
#
CreateWorkflowServiceAddChangeEhtActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddEdsAcquisitionSettingsParameterActionRequest(workflow_id: str = betterproto.string_field(1), acquisition_settings: EdsSpectrumAcquisitionSettings = betterproto.message_field(2))
Bases: Message
The CreateWorkflowServiceAddEdsAcquisitionSettingsParameterActionRequest class.
Attributes:
-
workflow_id(str) –The unique identifier of the workflow to which the EDS acquisition settings action will be appended.
-
acquisition_settings(EdsSpectrumAcquisitionSettings) –The EDS acquisition settings to be applied, provided as an ZenApi.EM.Workflow.V1.EdsSpectrumAcquisitionSettings interface.
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
The unique identifier of the workflow to which the EDS acquisition settings action will be appended.
class-attribute
instance-attribute
#
acquisition_settings: EdsSpectrumAcquisitionSettings = betterproto.message_field(2)
The EDS acquisition settings to be applied, provided as an ZenApi.EM.Workflow.V1.EdsSpectrumAcquisitionSettings interface.
dataclass
#
CreateWorkflowServiceAddEdsAcquisitionSettingsParameterActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddFocusAndFovActionRequest(workflow_id: str = betterproto.string_field(1), focus: float = betterproto.double_field(2), fov: float = betterproto.double_field(3), is_sem: bool = betterproto.bool_field(4))
Bases: Message
The CreateWorkflowServiceAddFocusAndFovActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
focus(float) –The focus value to be set.
-
fov(float) –The field of view value to be set.
-
is_sem(bool) –A boolean indicating whether the setting is for a SEM (true) or not (false).
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
focus: float = betterproto.double_field(2)
The focus value to be set.
class-attribute
instance-attribute
#
fov: float = betterproto.double_field(3)
The field of view value to be set.
class-attribute
instance-attribute
#
is_sem: bool = betterproto.bool_field(4)
A boolean indicating whether the setting is for a SEM (true) or not (false).
dataclass
#
CreateWorkflowServiceAddFocusAndFovActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddGoToStoredPositionActionRequest(workflow_id: str = betterproto.string_field(1), id: int = betterproto.int32_field(2))
Bases: Message
The CreateWorkflowServiceAddGoToStoredPositionActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
id(int) –Id of the stage position stored.
dataclass
#
CreateWorkflowServiceAddGoToStoredPositionActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddInitializeActionRequest(workflow_id: str = betterproto.string_field(1))
Bases: Message
The CreateWorkflowServiceAddInitializeActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
Identifier of the workflow to which action should be added.
dataclass
#
CreateWorkflowServiceAddInitializeActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddMoveStageRelativeActionRequest(workflow_id: str = betterproto.string_field(1), axis_to_move: List[StageAxis] = betterproto.message_field(2))
Bases: Message
The CreateWorkflowServiceAddMoveStageRelativeActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
axis_to_move(List[StageAxis]) –The stage axis that should move.
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
axis_to_move: List[StageAxis] = betterproto.message_field(2)
The stage axis that should move. The position is in meters.
dataclass
#
CreateWorkflowServiceAddMoveStageRelativeActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddPositionControlledTiltActionRequest(workflow_id: str = betterproto.string_field(1), start_angle: float = betterproto.double_field(2), target_angle: float = betterproto.double_field(3), large_step: float = betterproto.double_field(4), small_step: float = betterproto.double_field(5))
Bases: Message
The CreateWorkflowServiceAddPositionControlledTiltActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
start_angle(float) –The starting angle in degrees for the tilt action.
-
target_angle(float) –The target angle in degrees the tilt action aims to reach.
-
large_step(float) –The size of the large step in degrees for tilting.
-
small_step(float) –The size of the small step in degrees for finer tilting adjustments.
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
start_angle: float = betterproto.double_field(2)
The starting angle in degrees for the tilt action.
class-attribute
instance-attribute
#
target_angle: float = betterproto.double_field(3)
The target angle in degrees the tilt action aims to reach.
class-attribute
instance-attribute
#
large_step: float = betterproto.double_field(4)
The size of the large step in degrees for tilting.
class-attribute
instance-attribute
#
small_step: float = betterproto.double_field(5)
The size of the small step in degrees for finer tilting adjustments.
dataclass
#
CreateWorkflowServiceAddPositionControlledTiltActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddRestoreFibProbeActionRequest(workflow_id: str = betterproto.string_field(1), fib_probe_storage_name: str = betterproto.string_field(2))
Bases: Message
The CreateWorkflowServiceAddRestoreFibProbeActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
fib_probe_storage_name(str) –The name of the storage location from which the FIB probe state will be restored.
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
fib_probe_storage_name: str = betterproto.string_field(2)
The name of the storage location from which the FIB probe state will be restored.
dataclass
#
CreateWorkflowServiceAddRestoreFibProbeActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddSetFibProbeActionRequest(workflow_id: str = betterproto.string_field(1), probe_name: str = betterproto.string_field(2))
Bases: Message
The CreateWorkflowServiceAddSetFibProbeActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
probe_name(str) –The name of the FIB probe to be set.
dataclass
#
CreateWorkflowServiceAddSetFibProbeActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddSetFibWithValuesActionRequest(workflow_id: str = betterproto.string_field(1), voltage: str = betterproto.string_field(2), current: str = betterproto.string_field(3))
Bases: Message
The CreateWorkflowServiceAddSetFibWithValuesActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
voltage(str) –The voltage value to set for the FIB.
-
current(str) –The current value to set for the FIB.
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
voltage: str = betterproto.string_field(2)
The voltage value to set for the FIB.
class-attribute
instance-attribute
#
current: str = betterproto.string_field(3)
The current value to set for the FIB.
dataclass
#
CreateWorkflowServiceAddSetFibWithValuesActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddSetVacuumParameterActionRequest(workflow_id: str = betterproto.string_field(1), vacuum_parameter: VacuumParameter = betterproto.enum_field(2), value: float = betterproto.double_field(3))
Bases: Message
The CreateWorkflowServiceAddSetVacuumParameterActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
vacuum_parameter(VacuumParameter) –The vacuum parameter to be set, specified as a ZenApi.EM.Workflow.V1.VacuumParameter enumeration.
-
value(float) –The value to which the specified vacuum parameter should be set.
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
vacuum_parameter: VacuumParameter = betterproto.enum_field(2)
The vacuum parameter to be set, specified as a ZenApi.EM.Workflow.V1.VacuumParameter enumeration.
class-attribute
instance-attribute
#
value: float = betterproto.double_field(3)
The value to which the specified vacuum parameter should be set.
dataclass
#
CreateWorkflowServiceAddSetVacuumParameterActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddSpotParameterActionRequest(workflow_id: str = betterproto.string_field(1), spot_id: str = betterproto.string_field(2), position_x: float = betterproto.double_field(3), position_y: float = betterproto.double_field(4))
Bases: Message
The CreateWorkflowServiceAddSpotParameterActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
spot_id(str) –The identifier of the spot to be configured.
-
position_x(float) –The X-coordinate of the beam position for the spot.
-
position_y(float) –The Y-coordinate of the beam position for the spot.
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
spot_id: str = betterproto.string_field(2)
The identifier of the spot to be configured.
class-attribute
instance-attribute
#
position_x: float = betterproto.double_field(3)
The X-coordinate of the beam position for the spot.
class-attribute
instance-attribute
#
position_y: float = betterproto.double_field(4)
The Y-coordinate of the beam position for the spot.
dataclass
#
CreateWorkflowServiceAddSpotParameterActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddStoreFibProbeActionRequest(workflow_id: str = betterproto.string_field(1), fib_probe_storage_name: str = betterproto.string_field(2))
Bases: Message
The CreateWorkflowServiceAddStoreFibProbeActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
fib_probe_storage_name(str) –The name for the storage location of the FIB probe state.
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
fib_probe_storage_name: str = betterproto.string_field(2)
The name for the storage location of the FIB probe state.
dataclass
#
CreateWorkflowServiceAddStoreFibProbeActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddTouchAlarmGeneratorActionRequest(workflow_id: str = betterproto.string_field(1), disable_alarm: bool = betterproto.bool_field(2))
Bases: Message
The CreateWorkflowServiceAddTouchAlarmGeneratorActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
disable_alarm(bool) –A boolean indicating whether to disable (true) or enable (false) the touch alarm.
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
Identifier of the workflow to which action should be added.
class-attribute
instance-attribute
#
disable_alarm: bool = betterproto.bool_field(2)
A boolean indicating whether to disable (true) or enable (false) the touch alarm.
dataclass
#
CreateWorkflowServiceAddTouchAlarmGeneratorActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
CreateWorkflowServiceAddVacuumCommandActionRequest(workflow_id: str = betterproto.string_field(1), command: str = betterproto.string_field(2))
Bases: Message
The CreateWorkflowServiceAddVacuumCommandActionRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow to which action should be added.
-
command(str) –The vacuum command to be sent.
dataclass
#
CreateWorkflowServiceAddVacuumCommandActionResponse(action_id: str = betterproto.string_field(1))
dataclass
#
RunWorkflowServiceBreakRequest(break_elements: str = betterproto.string_field(1))
Bases: Message
The RunWorkflowServiceBreakRequest class.
Attributes:
-
break_elements(str) –List of elements, that shall be skipped.
class-attribute
instance-attribute
#
break_elements: str = betterproto.string_field(1)
List of elements, that shall be skipped.
dataclass
#
RunWorkflowServiceBreakResponse()
Bases: Message
The RunWorkflowServiceBreakResponse class.
dataclass
#
RunWorkflowServiceDefineAndRunCompleteWorkflowRequest(workflow_definition: str = betterproto.string_field(1))
Bases: Message
The RunWorkflowServiceDefineAndRunCompleteWorkflowRequest class.
Attributes:
-
workflow_definition(str) –Complete and consistent definition of the workflow which should be executed.
class-attribute
instance-attribute
#
workflow_definition: str = betterproto.string_field(1)
Complete and consistent definition of the workflow which should be executed.
dataclass
#
RunWorkflowServiceDefineAndRunCompleteWorkflowResponse(task_success: bool = betterproto.bool_field(1))
Bases: Message
Response object of the RunWorkflow method.
Attributes:
-
task_success(bool) –A value indicating whether the task to run workflow succeeded or not.
class-attribute
instance-attribute
#
task_success: bool = betterproto.bool_field(1)
A value indicating whether the task to run workflow succeeded or not.
dataclass
#
RunWorkflowServiceGetWorkflowByIdRequest(workflow_id: str = betterproto.string_field(1))
Bases: Message
The RunWorkflowServiceGetWorkflowByIdRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow which should be returned.
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
Identifier of the workflow which should be returned.
dataclass
#
RunWorkflowServiceGetWorkflowByIdResponse(workflow: str = betterproto.string_field(1))
dataclass
#
RunWorkflowServiceGetWorkflowStateRequest()
Bases: Message
The RunWorkflowServiceGetWorkflowStateRequest class.
dataclass
#
RunWorkflowServiceGetWorkflowStateResponse(workflow_state: WorkflowState = betterproto.enum_field(1))
Bases: Message
Response object of the RunWorkflowApi.
Attributes:
-
workflow_state(WorkflowState) –A Workflow state value.
class-attribute
instance-attribute
#
workflow_state: WorkflowState = betterproto.enum_field(1)
A Workflow state value.
dataclass
#
RunWorkflowServiceNextRequest()
Bases: Message
The RunWorkflowServiceNextRequest class.
dataclass
#
RunWorkflowServiceNextResponse()
Bases: Message
The RunWorkflowServiceNextResponse class.
dataclass
#
RunWorkflowServicePauseRequest()
Bases: Message
The RunWorkflowServicePauseRequest class.
dataclass
#
RunWorkflowServicePauseResponse()
Bases: Message
The RunWorkflowServicePauseResponse class.
dataclass
#
RunWorkflowServiceRegisterOnActionExecutionIdChangedRequest()
Bases: Message
The RunWorkflowServiceRegisterOnActionExecutionIdChangedRequest class.
dataclass
#
RunWorkflowServiceRegisterOnActionExecutionIdChangedResponse(action_id: str = betterproto.string_field(1))
dataclass
#
RunWorkflowServiceRegisterOnWorkflowStateChangedRequest()
Bases: Message
The RunWorkflowServiceRegisterOnWorkflowStateChangedRequest class.
dataclass
#
RunWorkflowServiceRegisterOnWorkflowStateChangedResponse(workflow_state: WorkflowState = betterproto.enum_field(1))
Bases: Message
Response object of the RunWorkflowApi.
Attributes:
-
workflow_state(WorkflowState) –A Workflow state value.
class-attribute
instance-attribute
#
workflow_state: WorkflowState = betterproto.enum_field(1)
A Workflow state value.
dataclass
#
RunWorkflowServiceResumeRequest()
Bases: Message
The RunWorkflowServiceResumeRequest class.
dataclass
#
RunWorkflowServiceResumeResponse()
Bases: Message
The RunWorkflowServiceResumeResponse class.
dataclass
#
RunWorkflowServiceRunWorkflowRequest(workflow_id: str = betterproto.string_field(1))
Bases: Message
The RunWorkflowServiceRunWorkflowRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow which should be executed.
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
Identifier of the workflow which should be executed.
dataclass
#
RunWorkflowServiceRunWorkflowResponse(task_success: bool = betterproto.bool_field(1))
Bases: Message
Response object of the RunWorkflow method.
Attributes:
-
task_success(bool) –A value indicating whether the task to run workflow succeeded or not.
class-attribute
instance-attribute
#
task_success: bool = betterproto.bool_field(1)
A value indicating whether the task to run workflow succeeded or not.
dataclass
#
RunWorkflowServiceSetNormalModeRequest()
Bases: Message
The RunWorkflowServiceSetNormalModeRequest class.
dataclass
#
RunWorkflowServiceSetNormalModeResponse()
Bases: Message
The RunWorkflowServiceSetNormalModeResponse class.
dataclass
#
RunWorkflowServiceSetStepModeRequest()
Bases: Message
The RunWorkflowServiceSetStepModeRequest class.
dataclass
#
RunWorkflowServiceSetStepModeResponse()
Bases: Message
The RunWorkflowServiceSetStepModeResponse class.
dataclass
#
RunWorkflowServiceStartRequest()
Bases: Message
The RunWorkflowServiceStartRequest class.
dataclass
#
RunWorkflowServiceStartResponse()
Bases: Message
The RunWorkflowServiceStartResponse class.
dataclass
#
RunWorkflowServiceStepRequest()
Bases: Message
The RunWorkflowServiceStepRequest class.
dataclass
#
RunWorkflowServiceStepResponse()
Bases: Message
The RunWorkflowServiceStepResponse class.
dataclass
#
RunWorkflowServiceStopEmergencyRequest()
Bases: Message
The RunWorkflowServiceStopEmergencyRequest class.
dataclass
#
RunWorkflowServiceStopEmergencyResponse()
Bases: Message
The RunWorkflowServiceStopEmergencyResponse class.
dataclass
#
RunWorkflowServiceStopRequest()
Bases: Message
The RunWorkflowServiceStopRequest class.
dataclass
#
RunWorkflowServiceStopResponse()
Bases: Message
The RunWorkflowServiceStopResponse class.
dataclass
#
WorkflowAdminServiceDeleteWorkflowByIdRequest(workflow_id: str = betterproto.string_field(1))
Bases: Message
The WorkflowAdminServiceDeleteWorkflowByIdRequest class.
Attributes:
-
workflow_id(str) –Identifier of the workflow which should be deleted.
class-attribute
instance-attribute
#
workflow_id: str = betterproto.string_field(1)
Identifier of the workflow which should be deleted.
dataclass
#
WorkflowAdminServiceDeleteWorkflowByIdResponse()
Bases: Message
The WorkflowAdminServiceDeleteWorkflowByIdResponse class.
dataclass
#
WorkflowAdminServiceGetAvailableWorkflowIdsRequest()
Bases: Message
The WorkflowAdminServiceGetAvailableWorkflowIdsRequest class.
dataclass
#
WorkflowAdminServiceGetAvailableWorkflowIdsResponse(workflow_ids: List[str] = betterproto.string_field(1))
Bases: Message
Response object of the GetAvailableWorkflowsIds method.
Attributes:
-
workflow_ids(List[str]) –A value with workflow xml.
class-attribute
instance-attribute
#
workflow_ids: List[str] = betterproto.string_field(1)
A value with workflow xml.
Bases: ServiceStub
Methods:
-
add_absolute_tilting_action–Creates an absolute tilting action.
-
add_acquire_nav_cam_image_action–Creates an action to acquire a navigation camera image for a specified region of interest in an automated engine workflow.
-
add_acquire_store_image_action–Creates an action to acquire and store an image based on a specified region of interest in an automated engine workflow.
-
add_change_beam_state_action–Creates an action to change the beam state in an automated engine workflow.
-
add_change_current_action–Creates an action to change the current level in an automated engine workflow.
-
add_change_eht_action–Creates an action to change the EHT voltage in an automated engine workflow.
-
add_eds_acquisition_settings_parameter_action–Creates an action to set Energy-Dispersive X-ray Spectroscopy (EDS) acquisition settings in an automated engine workflow.
-
add_focus_and_fov_action–Creates an action to adjust the focus and field of view (FOV) in an automated engine workflow.
-
add_go_to_stored_position_action–Adds an action that moves the stage to a stored point.
-
add_initialize_action–Add action that initializes the stage.
-
add_move_stage_relative_action–Add Move Stage Relative action to the specified workflow. The action will
-
add_position_controlled_tilt_action–Creates a position-controlled tilt action as part of an automated engine workflow.
-
add_restore_fib_probe_action–Creates an action to restore the FIB probe to a previously stored state in an automated engine workflow.
-
add_set_fib_probe_action–Creates an action to set a specific FIB probe in an automated engine workflow.
-
add_set_fib_with_values_action–Creates an action to set the FIB with specified voltage and current values in an automated engine workflow.
-
add_set_vacuum_parameter_action–Creates an action to set a specific vacuum parameter in an automated engine workflow.
-
add_spot_parameter_action–Creates an action to set parameters for a specific spot in an automated engine workflow.
-
add_store_fib_probe_action–Creates an action to store the current state of the FIB probe in an automated engine workflow.
-
add_touch_alarm_generator_action–Creates an action to enable or disable the touch alarm in an automated engine workflow.
-
add_vacuum_command_action–Creates an action to send a vacuum command in an automated engine workflow.
async
#
add_absolute_tilting_action(create_workflow_service_add_absolute_tilting_action_request: CreateWorkflowServiceAddAbsoluteTiltingActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddAbsoluteTiltingActionResponse
Creates an absolute tilting action.
async
#
add_acquire_nav_cam_image_action(create_workflow_service_add_acquire_nav_cam_image_action_request: CreateWorkflowServiceAddAcquireNavCamImageActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddAcquireNavCamImageActionResponse
Creates an action to acquire a navigation camera image for a specified region of interest in an automated engine workflow. This method generates an action for capturing a NavCam image based on the provided EM region of interest and appends it to an existing workflow.
async
#
add_acquire_store_image_action(create_workflow_service_add_acquire_store_image_action_request: CreateWorkflowServiceAddAcquireStoreImageActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddAcquireStoreImageActionResponse
Creates an action to acquire and store an image based on a specified region of interest in an automated engine workflow. This method generates an action for capturing and storing an image, including optional position and offset parameters, and appends it to an existing workflow.
async
#
add_change_beam_state_action(create_workflow_service_add_change_beam_state_action_request: CreateWorkflowServiceAddChangeBeamStateActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddChangeBeamStateActionResponse
Creates an action to change the beam state in an automated engine workflow. This method generates a beam state change action based on the desired state and appends it to an existing workflow.
async
#
add_change_current_action(create_workflow_service_add_change_current_action_request: CreateWorkflowServiceAddChangeCurrentActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddChangeCurrentActionResponse
Creates an action to change the current level in an automated engine workflow. This method generates a current change action based on the specified target current and appends it to an existing workflow.
async
#
add_change_eht_action(create_workflow_service_add_change_eht_action_request: CreateWorkflowServiceAddChangeEhtActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddChangeEhtActionResponse
Creates an action to change the EHT voltage in an automated engine workflow. This method generates an EHT voltage change action and appends it to an existing workflow.
async
#
add_eds_acquisition_settings_parameter_action(create_workflow_service_add_eds_acquisition_settings_parameter_action_request: CreateWorkflowServiceAddEdsAcquisitionSettingsParameterActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddEdsAcquisitionSettingsParameterActionResponse
Creates an action to set Energy-Dispersive X-ray Spectroscopy (EDS) acquisition settings in an automated engine workflow. This method generates an action for configuring EDS acquisition settings and appends it to an existing workflow.
async
#
add_focus_and_fov_action(create_workflow_service_add_focus_and_fov_action_request: CreateWorkflowServiceAddFocusAndFovActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddFocusAndFovActionResponse
Creates an action to adjust the focus and field of view (FOV) in an automated engine workflow. This method generates an action for setting focus and FOV values, and appends it to an existing workflow.
async
#
add_go_to_stored_position_action(create_workflow_service_add_go_to_stored_position_action_request: CreateWorkflowServiceAddGoToStoredPositionActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddGoToStoredPositionActionResponse
Adds an action that moves the stage to a stored point.
async
#
add_initialize_action(create_workflow_service_add_initialize_action_request: CreateWorkflowServiceAddInitializeActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddInitializeActionResponse
Add action that initializes the stage.
async
#
add_move_stage_relative_action(create_workflow_service_add_move_stage_relative_action_request: CreateWorkflowServiceAddMoveStageRelativeActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddMoveStageRelativeActionResponse
Add Move Stage Relative action to the specified workflow. The action will be added at the last position of the specified workflow. When specified workflow is not present, it will be automatically created.
async
#
add_position_controlled_tilt_action(create_workflow_service_add_position_controlled_tilt_action_request: CreateWorkflowServiceAddPositionControlledTiltActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddPositionControlledTiltActionResponse
Creates a position-controlled tilt action as part of an automated engine workflow. This method generates an action based on specified tilt angles and step sizes, and appends it to a given workflow. When specified workflow is not present, it will be automatically created.
async
#
add_restore_fib_probe_action(create_workflow_service_add_restore_fib_probe_action_request: CreateWorkflowServiceAddRestoreFibProbeActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddRestoreFibProbeActionResponse
Creates an action to restore the FIB probe to a previously stored state in an automated engine workflow. This method generates an action for restoring the FIB probe configuration from a named storage and appends it to an existing workflow.
async
#
add_set_fib_probe_action(create_workflow_service_add_set_fib_probe_action_request: CreateWorkflowServiceAddSetFibProbeActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddSetFibProbeActionResponse
Creates an action to set a specific FIB probe in an automated engine workflow. This method generates an action to configure the FIB system to use a specified probe and appends it to an existing workflow.
async
#
add_set_fib_with_values_action(create_workflow_service_add_set_fib_with_values_action_request: CreateWorkflowServiceAddSetFibWithValuesActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddSetFibWithValuesActionResponse
Creates an action to set the FIB with specified voltage and current values in an automated engine workflow. This method generates an action for setting the FIB parameters and appends it to an existing workflow.
async
#
add_set_vacuum_parameter_action(create_workflow_service_add_set_vacuum_parameter_action_request: CreateWorkflowServiceAddSetVacuumParameterActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddSetVacuumParameterActionResponse
Creates an action to set a specific vacuum parameter in an automated engine workflow. This method generates an action to adjust a vacuum parameter to a specified value and appends it to an existing workflow.
async
#
add_spot_parameter_action(create_workflow_service_add_spot_parameter_action_request: CreateWorkflowServiceAddSpotParameterActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddSpotParameterActionResponse
Creates an action to set parameters for a specific spot in an automated engine workflow. This method generates an action to configure a beam spot with a given ID and beam position, using specified X and Y coordinates, and appends it to an existing workflow.
async
#
add_store_fib_probe_action(create_workflow_service_add_store_fib_probe_action_request: CreateWorkflowServiceAddStoreFibProbeActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddStoreFibProbeActionResponse
Creates an action to store the current state of the FIB probe in an automated engine workflow. This method generates an action for storing the FIB probe configuration and appends it to an existing workflow.
async
#
add_touch_alarm_generator_action(create_workflow_service_add_touch_alarm_generator_action_request: CreateWorkflowServiceAddTouchAlarmGeneratorActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddTouchAlarmGeneratorActionResponse
Creates an action to enable or disable the touch alarm in an automated engine workflow. This method generates an action for toggling the touch alarm state and appends it to an existing workflow.
async
#
add_vacuum_command_action(create_workflow_service_add_vacuum_command_action_request: CreateWorkflowServiceAddVacuumCommandActionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CreateWorkflowServiceAddVacuumCommandActionResponse
Creates an action to send a vacuum command in an automated engine workflow. This method generates an action for sending a specified vacuum command and appends it to an existing workflow.
Bases: ServiceStub
Methods:
-
define_and_run_complete_workflow–Trigger a run of the complete workflow.
-
get_workflow_by_id–Retrieves the workflow by the given id. If workflow is not yet defined an Empty.String will be returned.
-
get_workflow_state–Gets Workflow State.
-
next–Execution of Next command.
-
pause–Trigger pauses the currently running workflow.
-
register_on_action_execution_id_changed–Notification about change of the currently executed action id.
-
register_on_workflow_state_changed–Notification about change of the Workflow state.
-
resume–Trigger resumes the currently paused workflow.
-
run_workflow–Trigger a run of the specified workflow.
-
set_normal_mode–Execution of set normal / step mode command.
-
set_step_mode–Execution of set normal / step mode command.
-
start–Trigger starts the stopped workflow.
-
step–Execution of Step command in step mode.
-
stop–Trigger stops the currently running workflow. The workflow not necessary was started from API.
-
stop_emergency–Trigger stops emergency.
async
#
define_and_run_complete_workflow(run_workflow_service_define_and_run_complete_workflow_request: RunWorkflowServiceDefineAndRunCompleteWorkflowRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> RunWorkflowServiceDefineAndRunCompleteWorkflowResponse
Trigger a run of the complete workflow.
async
#
get_workflow_by_id(run_workflow_service_get_workflow_by_id_request: RunWorkflowServiceGetWorkflowByIdRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> RunWorkflowServiceGetWorkflowByIdResponse
Retrieves the workflow by the given id. If workflow is not yet defined an Empty.String will be returned.
async
#
get_workflow_state(run_workflow_service_get_workflow_state_request: RunWorkflowServiceGetWorkflowStateRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> RunWorkflowServiceGetWorkflowStateResponse
Gets Workflow State.
async
#
next(run_workflow_service_next_request: RunWorkflowServiceNextRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> RunWorkflowServiceNextResponse
Execution of Next command.
async
#
pause(run_workflow_service_pause_request: RunWorkflowServicePauseRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> RunWorkflowServicePauseResponse
Trigger pauses the currently running workflow.
async
#
register_on_action_execution_id_changed(run_workflow_service_register_on_action_execution_id_changed_request: RunWorkflowServiceRegisterOnActionExecutionIdChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[RunWorkflowServiceRegisterOnActionExecutionIdChangedResponse]
Notification about change of the currently executed action id.
async
#
register_on_workflow_state_changed(run_workflow_service_register_on_workflow_state_changed_request: RunWorkflowServiceRegisterOnWorkflowStateChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[RunWorkflowServiceRegisterOnWorkflowStateChangedResponse]
Notification about change of the Workflow state.
async
#
resume(run_workflow_service_resume_request: RunWorkflowServiceResumeRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> RunWorkflowServiceResumeResponse
Trigger resumes the currently paused workflow.
async
#
run_workflow(run_workflow_service_run_workflow_request: RunWorkflowServiceRunWorkflowRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> RunWorkflowServiceRunWorkflowResponse
Trigger a run of the specified workflow.
async
#
set_normal_mode(run_workflow_service_set_normal_mode_request: RunWorkflowServiceSetNormalModeRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> RunWorkflowServiceSetNormalModeResponse
Execution of set normal / step mode command.
async
#
set_step_mode(run_workflow_service_set_step_mode_request: RunWorkflowServiceSetStepModeRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> RunWorkflowServiceSetStepModeResponse
Execution of set normal / step mode command.
async
#
start(run_workflow_service_start_request: RunWorkflowServiceStartRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> RunWorkflowServiceStartResponse
Trigger starts the stopped workflow.
async
#
step(run_workflow_service_step_request: RunWorkflowServiceStepRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> RunWorkflowServiceStepResponse
Execution of Step command in step mode.
async
#
stop(run_workflow_service_stop_request: RunWorkflowServiceStopRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> RunWorkflowServiceStopResponse
Trigger stops the currently running workflow. The workflow not necessary was started from API.
async
#
stop_emergency(run_workflow_service_stop_emergency_request: RunWorkflowServiceStopEmergencyRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> RunWorkflowServiceStopEmergencyResponse
Trigger stops emergency.
Bases: ServiceStub
Methods:
-
delete_workflow_by_id–Delete specified workflow by workflowId.
-
get_available_workflow_ids–Gets all available workflowIds.
async
#
delete_workflow_by_id(workflow_admin_service_delete_workflow_by_id_request: WorkflowAdminServiceDeleteWorkflowByIdRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> WorkflowAdminServiceDeleteWorkflowByIdResponse
Delete specified workflow by workflowId.
async
#
get_available_workflow_ids(workflow_admin_service_get_available_workflow_ids_request: WorkflowAdminServiceGetAvailableWorkflowIdsRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> WorkflowAdminServiceGetAvailableWorkflowIdsResponse
Gets all available workflowIds.
Bases: ServiceBase
Methods:
-
add_absolute_tilting_action–Creates an absolute tilting action.
-
add_acquire_nav_cam_image_action–Creates an action to acquire a navigation camera image for a specified region of interest in an automated engine workflow.
-
add_acquire_store_image_action–Creates an action to acquire and store an image based on a specified region of interest in an automated engine workflow.
-
add_change_beam_state_action–Creates an action to change the beam state in an automated engine workflow.
-
add_change_current_action–Creates an action to change the current level in an automated engine workflow.
-
add_change_eht_action–Creates an action to change the EHT voltage in an automated engine workflow.
-
add_eds_acquisition_settings_parameter_action–Creates an action to set Energy-Dispersive X-ray Spectroscopy (EDS) acquisition settings in an automated engine workflow.
-
add_focus_and_fov_action–Creates an action to adjust the focus and field of view (FOV) in an automated engine workflow.
-
add_go_to_stored_position_action–Adds an action that moves the stage to a stored point.
-
add_initialize_action–Add action that initializes the stage.
-
add_move_stage_relative_action–Add Move Stage Relative action to the specified workflow. The action will
-
add_position_controlled_tilt_action–Creates a position-controlled tilt action as part of an automated engine workflow.
-
add_restore_fib_probe_action–Creates an action to restore the FIB probe to a previously stored state in an automated engine workflow.
-
add_set_fib_probe_action–Creates an action to set a specific FIB probe in an automated engine workflow.
-
add_set_fib_with_values_action–Creates an action to set the FIB with specified voltage and current values in an automated engine workflow.
-
add_set_vacuum_parameter_action–Creates an action to set a specific vacuum parameter in an automated engine workflow.
-
add_spot_parameter_action–Creates an action to set parameters for a specific spot in an automated engine workflow.
-
add_store_fib_probe_action–Creates an action to store the current state of the FIB probe in an automated engine workflow.
-
add_touch_alarm_generator_action–Creates an action to enable or disable the touch alarm in an automated engine workflow.
-
add_vacuum_command_action–Creates an action to send a vacuum command in an automated engine workflow.
async
#
add_absolute_tilting_action(create_workflow_service_add_absolute_tilting_action_request: CreateWorkflowServiceAddAbsoluteTiltingActionRequest) -> CreateWorkflowServiceAddAbsoluteTiltingActionResponse
Creates an absolute tilting action.
async
#
add_acquire_nav_cam_image_action(create_workflow_service_add_acquire_nav_cam_image_action_request: CreateWorkflowServiceAddAcquireNavCamImageActionRequest) -> CreateWorkflowServiceAddAcquireNavCamImageActionResponse
Creates an action to acquire a navigation camera image for a specified region of interest in an automated engine workflow. This method generates an action for capturing a NavCam image based on the provided EM region of interest and appends it to an existing workflow.
async
#
add_acquire_store_image_action(create_workflow_service_add_acquire_store_image_action_request: CreateWorkflowServiceAddAcquireStoreImageActionRequest) -> CreateWorkflowServiceAddAcquireStoreImageActionResponse
Creates an action to acquire and store an image based on a specified region of interest in an automated engine workflow. This method generates an action for capturing and storing an image, including optional position and offset parameters, and appends it to an existing workflow.
async
#
add_change_beam_state_action(create_workflow_service_add_change_beam_state_action_request: CreateWorkflowServiceAddChangeBeamStateActionRequest) -> CreateWorkflowServiceAddChangeBeamStateActionResponse
Creates an action to change the beam state in an automated engine workflow. This method generates a beam state change action based on the desired state and appends it to an existing workflow.
async
#
add_change_current_action(create_workflow_service_add_change_current_action_request: CreateWorkflowServiceAddChangeCurrentActionRequest) -> CreateWorkflowServiceAddChangeCurrentActionResponse
Creates an action to change the current level in an automated engine workflow. This method generates a current change action based on the specified target current and appends it to an existing workflow.
async
#
add_change_eht_action(create_workflow_service_add_change_eht_action_request: CreateWorkflowServiceAddChangeEhtActionRequest) -> CreateWorkflowServiceAddChangeEhtActionResponse
Creates an action to change the EHT voltage in an automated engine workflow. This method generates an EHT voltage change action and appends it to an existing workflow.
async
#
add_eds_acquisition_settings_parameter_action(create_workflow_service_add_eds_acquisition_settings_parameter_action_request: CreateWorkflowServiceAddEdsAcquisitionSettingsParameterActionRequest) -> CreateWorkflowServiceAddEdsAcquisitionSettingsParameterActionResponse
Creates an action to set Energy-Dispersive X-ray Spectroscopy (EDS) acquisition settings in an automated engine workflow. This method generates an action for configuring EDS acquisition settings and appends it to an existing workflow.
async
#
add_focus_and_fov_action(create_workflow_service_add_focus_and_fov_action_request: CreateWorkflowServiceAddFocusAndFovActionRequest) -> CreateWorkflowServiceAddFocusAndFovActionResponse
Creates an action to adjust the focus and field of view (FOV) in an automated engine workflow. This method generates an action for setting focus and FOV values, and appends it to an existing workflow.
async
#
add_go_to_stored_position_action(create_workflow_service_add_go_to_stored_position_action_request: CreateWorkflowServiceAddGoToStoredPositionActionRequest) -> CreateWorkflowServiceAddGoToStoredPositionActionResponse
Adds an action that moves the stage to a stored point.
async
#
add_initialize_action(create_workflow_service_add_initialize_action_request: CreateWorkflowServiceAddInitializeActionRequest) -> CreateWorkflowServiceAddInitializeActionResponse
Add action that initializes the stage.
async
#
add_move_stage_relative_action(create_workflow_service_add_move_stage_relative_action_request: CreateWorkflowServiceAddMoveStageRelativeActionRequest) -> CreateWorkflowServiceAddMoveStageRelativeActionResponse
Add Move Stage Relative action to the specified workflow. The action will be added at the last position of the specified workflow. When specified workflow is not present, it will be automatically created.
async
#
add_position_controlled_tilt_action(create_workflow_service_add_position_controlled_tilt_action_request: CreateWorkflowServiceAddPositionControlledTiltActionRequest) -> CreateWorkflowServiceAddPositionControlledTiltActionResponse
Creates a position-controlled tilt action as part of an automated engine workflow. This method generates an action based on specified tilt angles and step sizes, and appends it to a given workflow. When specified workflow is not present, it will be automatically created.
async
#
add_restore_fib_probe_action(create_workflow_service_add_restore_fib_probe_action_request: CreateWorkflowServiceAddRestoreFibProbeActionRequest) -> CreateWorkflowServiceAddRestoreFibProbeActionResponse
Creates an action to restore the FIB probe to a previously stored state in an automated engine workflow. This method generates an action for restoring the FIB probe configuration from a named storage and appends it to an existing workflow.
async
#
add_set_fib_probe_action(create_workflow_service_add_set_fib_probe_action_request: CreateWorkflowServiceAddSetFibProbeActionRequest) -> CreateWorkflowServiceAddSetFibProbeActionResponse
Creates an action to set a specific FIB probe in an automated engine workflow. This method generates an action to configure the FIB system to use a specified probe and appends it to an existing workflow.
async
#
add_set_fib_with_values_action(create_workflow_service_add_set_fib_with_values_action_request: CreateWorkflowServiceAddSetFibWithValuesActionRequest) -> CreateWorkflowServiceAddSetFibWithValuesActionResponse
Creates an action to set the FIB with specified voltage and current values in an automated engine workflow. This method generates an action for setting the FIB parameters and appends it to an existing workflow.
async
#
add_set_vacuum_parameter_action(create_workflow_service_add_set_vacuum_parameter_action_request: CreateWorkflowServiceAddSetVacuumParameterActionRequest) -> CreateWorkflowServiceAddSetVacuumParameterActionResponse
Creates an action to set a specific vacuum parameter in an automated engine workflow. This method generates an action to adjust a vacuum parameter to a specified value and appends it to an existing workflow.
async
#
add_spot_parameter_action(create_workflow_service_add_spot_parameter_action_request: CreateWorkflowServiceAddSpotParameterActionRequest) -> CreateWorkflowServiceAddSpotParameterActionResponse
Creates an action to set parameters for a specific spot in an automated engine workflow. This method generates an action to configure a beam spot with a given ID and beam position, using specified X and Y coordinates, and appends it to an existing workflow.
async
#
add_store_fib_probe_action(create_workflow_service_add_store_fib_probe_action_request: CreateWorkflowServiceAddStoreFibProbeActionRequest) -> CreateWorkflowServiceAddStoreFibProbeActionResponse
Creates an action to store the current state of the FIB probe in an automated engine workflow. This method generates an action for storing the FIB probe configuration and appends it to an existing workflow.
async
#
add_touch_alarm_generator_action(create_workflow_service_add_touch_alarm_generator_action_request: CreateWorkflowServiceAddTouchAlarmGeneratorActionRequest) -> CreateWorkflowServiceAddTouchAlarmGeneratorActionResponse
Creates an action to enable or disable the touch alarm in an automated engine workflow. This method generates an action for toggling the touch alarm state and appends it to an existing workflow.
async
#
add_vacuum_command_action(create_workflow_service_add_vacuum_command_action_request: CreateWorkflowServiceAddVacuumCommandActionRequest) -> CreateWorkflowServiceAddVacuumCommandActionResponse
Creates an action to send a vacuum command in an automated engine workflow. This method generates an action for sending a specified vacuum command and appends it to an existing workflow.
Bases: ServiceBase
Methods:
-
define_and_run_complete_workflow–Trigger a run of the complete workflow.
-
get_workflow_by_id–Retrieves the workflow by the given id. If workflow is not yet defined an Empty.String will be returned.
-
get_workflow_state–Gets Workflow State.
-
next–Execution of Next command.
-
pause–Trigger pauses the currently running workflow.
-
register_on_action_execution_id_changed–Notification about change of the currently executed action id.
-
register_on_workflow_state_changed–Notification about change of the Workflow state.
-
resume–Trigger resumes the currently paused workflow.
-
run_workflow–Trigger a run of the specified workflow.
-
set_normal_mode–Execution of set normal / step mode command.
-
set_step_mode–Execution of set normal / step mode command.
-
start–Trigger starts the stopped workflow.
-
step–Execution of Step command in step mode.
-
stop–Trigger stops the currently running workflow. The workflow not necessary was started from API.
-
stop_emergency–Trigger stops emergency.
async
#
define_and_run_complete_workflow(run_workflow_service_define_and_run_complete_workflow_request: RunWorkflowServiceDefineAndRunCompleteWorkflowRequest) -> RunWorkflowServiceDefineAndRunCompleteWorkflowResponse
Trigger a run of the complete workflow.
async
#
get_workflow_by_id(run_workflow_service_get_workflow_by_id_request: RunWorkflowServiceGetWorkflowByIdRequest) -> RunWorkflowServiceGetWorkflowByIdResponse
Retrieves the workflow by the given id. If workflow is not yet defined an Empty.String will be returned.
async
#
get_workflow_state(run_workflow_service_get_workflow_state_request: RunWorkflowServiceGetWorkflowStateRequest) -> RunWorkflowServiceGetWorkflowStateResponse
Gets Workflow State.
async
#
next(run_workflow_service_next_request: RunWorkflowServiceNextRequest) -> RunWorkflowServiceNextResponse
Execution of Next command.
async
#
pause(run_workflow_service_pause_request: RunWorkflowServicePauseRequest) -> RunWorkflowServicePauseResponse
Trigger pauses the currently running workflow.
async
#
register_on_action_execution_id_changed(run_workflow_service_register_on_action_execution_id_changed_request: RunWorkflowServiceRegisterOnActionExecutionIdChangedRequest) -> AsyncIterator[RunWorkflowServiceRegisterOnActionExecutionIdChangedResponse]
Notification about change of the currently executed action id.
async
#
register_on_workflow_state_changed(run_workflow_service_register_on_workflow_state_changed_request: RunWorkflowServiceRegisterOnWorkflowStateChangedRequest) -> AsyncIterator[RunWorkflowServiceRegisterOnWorkflowStateChangedResponse]
Notification about change of the Workflow state.
async
#
resume(run_workflow_service_resume_request: RunWorkflowServiceResumeRequest) -> RunWorkflowServiceResumeResponse
Trigger resumes the currently paused workflow.
async
#
run_workflow(run_workflow_service_run_workflow_request: RunWorkflowServiceRunWorkflowRequest) -> RunWorkflowServiceRunWorkflowResponse
Trigger a run of the specified workflow.
async
#
set_normal_mode(run_workflow_service_set_normal_mode_request: RunWorkflowServiceSetNormalModeRequest) -> RunWorkflowServiceSetNormalModeResponse
Execution of set normal / step mode command.
async
#
set_step_mode(run_workflow_service_set_step_mode_request: RunWorkflowServiceSetStepModeRequest) -> RunWorkflowServiceSetStepModeResponse
Execution of set normal / step mode command.
async
#
start(run_workflow_service_start_request: RunWorkflowServiceStartRequest) -> RunWorkflowServiceStartResponse
Trigger starts the stopped workflow.
async
#
step(run_workflow_service_step_request: RunWorkflowServiceStepRequest) -> RunWorkflowServiceStepResponse
Execution of Step command in step mode.
async
#
stop(run_workflow_service_stop_request: RunWorkflowServiceStopRequest) -> RunWorkflowServiceStopResponse
Trigger stops the currently running workflow. The workflow not necessary was started from API.
async
#
stop_emergency(run_workflow_service_stop_emergency_request: RunWorkflowServiceStopEmergencyRequest) -> RunWorkflowServiceStopEmergencyResponse
Trigger stops emergency.
Bases: ServiceBase
Methods:
-
delete_workflow_by_id–Delete specified workflow by workflowId.
-
get_available_workflow_ids–Gets all available workflowIds.
async
#
delete_workflow_by_id(workflow_admin_service_delete_workflow_by_id_request: WorkflowAdminServiceDeleteWorkflowByIdRequest) -> WorkflowAdminServiceDeleteWorkflowByIdResponse
Delete specified workflow by workflowId.
async
#
get_available_workflow_ids(workflow_admin_service_get_available_workflow_ids_request: WorkflowAdminServiceGetAvailableWorkflowIdsRequest) -> WorkflowAdminServiceGetAvailableWorkflowIdsResponse
Gets all available workflowIds.