Skip to content
Start free evaluation

PDComm.GemFormattedProgramExecutionAction

Class

An action that a formatted process program execution asks the application to perform.

public sealed class GemFormattedProgramExecutionAction : GemOwnedSnapshot

GemFormattedPrograms.StartExecution returns the start action in GemFormattedProgramExecutionStart.Action; GemFormattedPrograms.StepExecution and GemFormattedPrograms.CancelExecution return step and cancel actions. Perform the action, then report its outcome with GemFormattedPrograms.SubmitActionResult using the token from GemFormattedPrograms.GetActionToken. The caller owns the action and must dispose it.

Members

GetCommandCode

Method

Gets the command code (CCODE) of the command that a step action performs.

public SecsItem GetCommandCode()

Only a step action carries a command; other actions fail with PdcommStatus.InvalidState.

Returns

A new SecsItem holding the ASCII or unsigned integer command code (CCODE). The caller owns the returned item and must dispose it.

Notes

  • Throws ObjectDisposedException: The snapshot has been disposed.
  • Throws PdcommException: The native accessor failed, for example with PdcommStatus.InvalidState when the snapshot does not hold the requested data.

GetInfo

Method

Gets the description of the action.

public GemFormattedProgramExecutionActionInfo GetInfo()

Returns

The action kind and token values and the fields that apply to that kind.

Notes

  • Throws ObjectDisposedException: The snapshot has been disposed.
  • Throws PdcommException: The native accessor failed, for example with PdcommStatus.InvalidState when the snapshot does not hold the requested data.

GetModel

Method

Gets the equipment model type (MDLN) of the program that a start action starts.

public string GetModel()

Only a start action carries the program; other actions fail with PdcommStatus.InvalidState.

Returns

The equipment model type (MDLN) text.

Notes

  • Throws ObjectDisposedException: The snapshot has been disposed.
  • Throws PdcommException: The native accessor failed, for example with PdcommStatus.InvalidState when the snapshot does not hold the requested data.

GetParameter

Method

Gets one parameter (PPARM) of the command that a step action performs.

public SecsItem GetParameter(nuint parameter_index)

Only a step action carries a command; other actions fail with PdcommStatus.InvalidState.

Parameters

NameDescription
parameter_indexThe zero-based index of the parameter, less than GemFormattedProgramExecutionActionInfo.ParameterCount.

Returns

A new SecsItem holding the parameter (PPARM). The caller owns the returned item and must dispose it.

Notes

  • Throws ObjectDisposedException: The snapshot has been disposed.
  • Throws PdcommException: The native accessor failed, for example with PdcommStatus.InvalidState when the snapshot does not hold the requested data, or with PdcommStatus.OutOfRange when an index is past the end or the indexed entry is absent.

GetProgramId

Method

Gets the process program ID (PPID) of the program that a start action starts.

public SecsItem GetProgramId()

Only a start action carries the program; other actions fail with PdcommStatus.InvalidState.

Returns

A new ASCII or binary SecsItem holding the PPID. The caller owns the returned item and must dispose it.

Notes

  • Throws ObjectDisposedException: The snapshot has been disposed.
  • Throws PdcommException: The native accessor failed, for example with PdcommStatus.InvalidState when the snapshot does not hold the requested data.

GetSoftwareRevision

Method

Gets the software revision (SOFTREV) of the program that a start action starts.

public string GetSoftwareRevision()

Only a start action carries the program; other actions fail with PdcommStatus.InvalidState.

Returns

The software revision (SOFTREV) text.

Notes

  • Throws ObjectDisposedException: The snapshot has been disposed.
  • Throws PdcommException: The native accessor failed, for example with PdcommStatus.InvalidState when the snapshot does not hold the requested data.

Privacy Policy