Skip to content
Start free evaluation

PDComm.GemFormattedProgramDryRunReport

Class

The result of a read-only structural check of the selected formatted process program.

public sealed class GemFormattedProgramDryRunReport : GemOwnedSnapshot

GemFormattedPrograms.DryRun or its GemFormattedProgramsWorker counterpart returns it. The report compares the selected program with the equipment's capability catalog and holds the outcome, the issues and the identity of the evaluated program; it does not perform or guarantee physical execution. GemFormattedPrograms.StartExecution needs a report that is not rejected and still matches the selection and the catalog. The caller owns the report and must dispose it, but not before a start that uses it returns.

Members

GetInfo

Method

Gets the summary of the dry run report.

public GemFormattedProgramDryRunInfo GetInfo()

Returns

The outcome, the identity of the evaluated selection and the size and counts of the evaluated program.

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.

GetIssueInfo

Method

Gets one issue of the dry run report.

public GemFormattedProgramDryRunIssueInfo GetIssueInfo(nuint index)

Parameters

NameDescription
indexThe zero-based index of the issue, less than GemFormattedProgramDryRunInfo.IssueCount.

Returns

The issue code, its outcome and its optional command index and values.

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.

GetModel

Method

Gets the equipment model type (MDLN) of the evaluated program.

public string GetModel()

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.

GetProgramId

Method

Gets the process program ID (PPID) of the evaluated program.

public SecsItem GetProgramId()

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.

GetProgramIdBytes

Method

Gets the raw bytes of the evaluated program's PPID.

public byte[] GetProgramIdBytes()

Returns

The ASCII characters or binary bytes of the PPID, as GemFormattedProgramDryRunInfo.IdFormat tells.

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 evaluated program.

public string GetSoftwareRevision()

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