SECS/GEM API reference

• C 1806 symbols
• C++ 1376 symbols
• .NET 2084 symbols

AllCC++.NETAll kindsClassConstructorDelegateEnumEnumeratorFieldFunctionMacroMethodPropertyStructTypedef5266 symbols

• PDCOMM_BACKPRESSURE C Macro — Work cannot be accepted until earlier work is drained.
• PDCOMM_GEM300_CAPABILITY_INFO_VERSION C Macro — Value for the version field of the catalog, profile, and capability info structures.
• PDCOMM_GEM300_CAPABILITY_OPTIONS_VERSION C Macro — Value for PdcommGem300CapabilityOptions::version.
• PDCOMM_GEM300_CARRIER C Macro — Capability axis: carrier management (SEMI E87).
• PDCOMM_GEM300_CONTROL_JOB C Macro — Capability axis: control job management (SEMI E94).
• PDCOMM_GEM300_EXPERIMENTAL C Macro — Capability status label 3 (experimental) that the application assigns to its own capability; the catalog stores it without interpreting it.
• PDCOMM_GEM300_MODEL_ONLY C Macro — Capability status label 2 (model only) that the application assigns to its own capability; the catalog stores it without interpreting it.
• PDCOMM_GEM300_PLANNED C Macro — Capability status label 1 (planned) that the application assigns to its own capability; the catalog stores it without interpreting it.
• PDCOMM_GEM300_PROCESS_JOB C Macro — Capability axis: process job management (SEMI E40).
• PDCOMM_GEM300_SUBSTRATE C Macro — Capability axis: substrate tracking (SEMI E90).
• PDCOMM_GEM300_UNVERIFIED C Macro — Verification label value 1, currently the only defined value; the catalog accepts and reports it.
• PDCOMM_GEM_ALARM_ACK C Macro — Outcome: an Equipment received the S5F2 acknowledgement (ACKC5) of a W=1 alarm report.
• PDCOMM_GEM_ALARM_ENABLE_ACK C Macro — Outcome: an alarm enable/disable acknowledgement (ACKC5) was handled.
• PDCOMM_GEM_ALARM_LIST C Macro — Request kind of an S5F5 List Alarms Request.
• PDCOMM_GEM_ALARM_LIST_RECEIVED C Macro — Outcome: a Host received a validated S5F6 List Alarm Data reply.
• PDCOMM_GEM_ALARM_LIST_REPLIED C Macro — Outcome: an Equipment answered an S5F5 request with S5F6 from its alarm store.
• PDCOMM_GEM_ALARM_OPTIONS_VERSION C Macro — Required value of PdcommGemAlarmOptions::version.
• PDCOMM_GEM_ALARM_RECEIVED C Macro — Outcome: a Host received a validated S5F1 Alarm Report Send.
• PDCOMM_GEM_ALARM_REPORT C Macro — Request kind of an S5F1 Alarm Report Send published with W=1.
• PDCOMM_GEM_ALREADY_ONLINE C Macro — Outcome: equipment already ON-LINE received S1F17 and answered S1F18 with ONLACK 2.
• PDCOMM_GEM_ANNOTATED_QUERY C Macro — Query kind and request kind for an Annotated Individual Report Request (S6F21) by RPTID.
• PDCOMM_GEM_ANNOTATED_QUERY_RECEIVED C Macro — Outcome: a Host received a validated Annotated Individual Report Data reply (S6F22).
• PDCOMM_GEM_ARE_YOU_ONLINE C Macro — Request kind: S1F1 Are You There Request.
• PDCOMM_GEM_ATTEMPT_ONLINE C Macro — Control state: E30 ATTEMPT ON-LINE.
• PDCOMM_GEM_BINDING_OPTIONS_VERSION C Macro — Version value for PdcommGemBindingOptions::version.
• PDCOMM_GEM_CHANGE_CONSTANTS C Macro — Request kind for a New Equipment Constant Send (S2F15) from pdcomm_gem_host_change_constants().
• PDCOMM_GEM_COMMAND_ACCEPTED_LATER C Macro — HCACK 4: acknowledged, the command will be performed and completion is signaled later by an event.
• PDCOMM_GEM_COMMAND_ACK C Macro — Outcome: a Host received a validated S2F42 Host Command Acknowledge.
• PDCOMM_GEM_COMMAND_ALREADY_IN_CONDITION C Macro — HCACK 5: rejected, the equipment is already in the desired condition.
• PDCOMM_GEM_COMMAND_CANNOT_PERFORM C Macro — HCACK 2: the command cannot be performed now.
• PDCOMM_GEM_COMMAND_COMPLETED C Macro — HCACK 0: acknowledged, the command has been performed.
• PDCOMM_GEM_COMMAND_NO_SUCH_OBJECT C Macro — HCACK 6: no such object exists (used by S2F50 for an unknown OBJSPEC).
• PDCOMM_GEM_COMMAND_OPTIONS_VERSION C Macro — Required value of PdcommGemCommandOptions::version.
• PDCOMM_GEM_COMMAND_PARAMETER_ERRORS C Macro — HCACK 3: at least one parameter is invalid; CPACK entries describe the problems.
• PDCOMM_GEM_COMMAND_RECEIVED C Macro — Outcome: an Equipment received a validated S2F41 Host Command Send.
• PDCOMM_GEM_COMMAND_UNKNOWN C Macro — HCACK 1: the command does not exist.
• PDCOMM_GEM_COMMUNICATING C Macro — Communication state: E30 COMMUNICATING; GEM requests are allowed.
• PDCOMM_GEM_COMMUNICATION_ESTABLISHED C Macro — Outcome: communication was established (E30 COMMUNICATING).
• PDCOMM_GEM_COMMUNICATION_REJECTED C Macro — Outcome: S1F14 with a nonzero COMMACK (1, denied) was received.
• PDCOMM_GEM_CONSTANT_APPLY C Macro — Equipment decision and EAC 0: accept and apply the new values.
• PDCOMM_GEM_CONSTANT_CANNOT_PERFORM C Macro — Equipment decision and EAC 2: denied, busy (cannot perform now).
• PDCOMM_GEM_CONSTANT_CHANGES_RECEIVED C Macro — Outcome: an Equipment received a validated S2F15 that awaits a decision.
• PDCOMM_GEM_CONSTANT_CHANGE_ACK C Macro — Outcome: a Host received the New Equipment Constant Acknowledge (S2F16); the EAC (0 to 63) is in PdcommGemResultInfo::acknowledgement.
• PDCOMM_GEM_CONSTANT_CURRENT C Macro — Field selector: the current value (ECV); valid only for the local pdcomm_gem_equipment_constant_get().
• PDCOMM_GEM_CONSTANT_DEFAULT C Macro — Field selector: the default value (ECDEF).
• PDCOMM_GEM_CONSTANT_ID C Macro — Field selector: the constant ID (ECID).
• PDCOMM_GEM_CONSTANT_MAXIMUM C Macro — Field selector: the maximum value (ECMAX).
• PDCOMM_GEM_CONSTANT_METADATA C Macro — Request kind for an Equipment Constant Namelist Request (S2F29); used by pdcomm_gem_host_constant_request().
• PDCOMM_GEM_CONSTANT_METADATA_RECEIVED C Macro — Outcome: a Host received a validated Equipment Constant Namelist reply (S2F30).
• PDCOMM_GEM_CONSTANT_METADATA_REPLIED C Macro — Outcome: an Equipment answered an S2F29 automatically with S2F30 from its constant store.
• PDCOMM_GEM_CONSTANT_MINIMUM C Macro — Field selector: the minimum value (ECMIN).
• PDCOMM_GEM_CONSTANT_NAME C Macro — Field selector: the name (ECNAME), as an ASCII item.
• PDCOMM_GEM_CONSTANT_OPTIONS_VERSION C Macro — Version value for PdcommGemConstantOptions::version.
• PDCOMM_GEM_CONSTANT_OUT_OF_RANGE C Macro — Equipment decision and EAC 3: denied, at least one value is out of range.
• PDCOMM_GEM_CONSTANT_UNITS C Macro — Field selector: the units, as an ASCII item.
• PDCOMM_GEM_CONSTANT_VALUES C Macro — Request kind for an Equipment Constant Request (S2F13); used by pdcomm_gem_host_constant_request().
• PDCOMM_GEM_CONSTANT_VALUES_RECEIVED C Macro — Outcome: a Host received a validated Equipment Constant Data reply (S2F14).
• PDCOMM_GEM_CONSTANT_VALUES_REPLIED C Macro — Outcome: an Equipment answered an S2F13 automatically with S2F14 from its constant store.
• PDCOMM_GEM_CONTROL_UNAVAILABLE C Macro — Control state and online mode value reported for a host role.
• PDCOMM_GEM_DATA_CACHED C Macro — pdcomm_gem_equipment_data_get() field selector: the cached value, or NULL when no value is cached.
• PDCOMM_GEM_DATA_DIRECTORY C Macro — Request kind for a Data Variable Namelist Request (S1F21).
• PDCOMM_GEM_DATA_DIRECTORY_RECEIVED C Macro — Outcome: a Host received a validated Data Variable Namelist reply (S1F22).
• PDCOMM_GEM_DATA_DIRECTORY_REPLIED C Macro — Outcome: an Equipment answered an S1F21 automatically with S1F22.
• PDCOMM_GEM_DATA_NAME C Macro — pdcomm_gem_equipment_data_get() field selector: the name, as an owned ASCII item.
• PDCOMM_GEM_DATA_OPTIONS_VERSION C Macro — Version value for PdcommGemDataOptions::version.
• PDCOMM_GEM_DATA_UNITS C Macro — pdcomm_gem_equipment_data_get() field selector: the units, as an owned ASCII item.
• PDCOMM_GEM_DEFINE_REPORTS C Macro — Request kind for a Host Define Report request (S2F33).
• PDCOMM_GEM_DEFINE_REPORTS_ACK C Macro — Outcome: a Define Report Acknowledge (S2F34) was exchanged.
• PDCOMM_GEM_DIRECTORY_NAME C Macro — Directory field selector: the name (DVVALNAME or CENAME), as an ASCII item.
• PDCOMM_GEM_DIRECTORY_OPTIONS_VERSION C Macro — Version value for PdcommGemDirectoryOptions::version.
• PDCOMM_GEM_DIRECTORY_UNITS C Macro — Directory field selector: the units of a data variable entry, as an ASCII item.
• PDCOMM_GEM_DIRECTORY_VARIABLE_IDS C Macro — Directory field selector: the VIDs of an event entry, as one U4 array item.
• PDCOMM_GEM_DISCONNECTED C Macro — Communication state: the HSMS session is not SELECTED.
• PDCOMM_GEM_ENABLED_ALARM_LIST C Macro — Request kind of an S5F7 List Enabled Alarm Request.
• PDCOMM_GEM_ENABLED_ALARM_LIST_RECEIVED C Macro — Outcome: a Host received a validated S5F8 List Enabled Alarm Data reply.
• PDCOMM_GEM_ENABLED_ALARM_LIST_REPLIED C Macro — Outcome: an Equipment answered an S5F7 request with S5F8 from its alarm store.
• PDCOMM_GEM_ENABLE_ALARM C Macro — Request kind of an S5F3 Enable/Disable Alarm Send sent with W=1.
• PDCOMM_GEM_ENABLE_EVENTS C Macro — Request kind for a Host Enable/Disable Event Report request (S2F37).
• PDCOMM_GEM_ENABLE_EVENTS_ACK C Macro — Outcome: an Enable/Disable Event Report Acknowledge (S2F38) was exchanged.
• PDCOMM_GEM_ENHANCED_COMMAND_ACK C Macro — Outcome: a Host received a validated S2F50 Enhanced Remote Command Acknowledge.
• PDCOMM_GEM_ENHANCED_COMMAND_OPTIONS_VERSION C Macro — Required value of PdcommGemEnhancedCommandOptions::version.
• PDCOMM_GEM_ENHANCED_COMMAND_RECEIVED C Macro — Outcome: an Equipment received a validated S2F49 Enhanced Remote Command.
• PDCOMM_GEM_ENHANCED_REMOTE_COMMAND C Macro — Request kind of an S2F49 Enhanced Remote Command.
• PDCOMM_GEM_EQUIPMENT C Macro — GEM role value for equipment (::PdcommGemState::role).
• PDCOMM_GEM_EQUIPMENT_IDENTITY C Macro — Outcome: a host received S1F2 with the equipment model (MDLN) and software revision (SOFTREV); read them with pdcomm_gem_result_body().
• PDCOMM_GEM_EQUIPMENT_OFFLINE C Macro — Control state: E30 EQUIPMENT OFF-LINE (operator has the equipment off-line).
• PDCOMM_GEM_ERROR_ABORTED C Macro — GEM error: the peer aborted the transaction with a function 0 (SxF0) reply.
• PDCOMM_GEM_ERROR_ACK C Macro — GEM error: an acknowledgement code is outside the range the message defines.
• PDCOMM_GEM_ERROR_BODY C Macro — GEM error: the body structure, item formats, or item counts do not match the message definition.
• PDCOMM_GEM_ERROR_CODEC C Macro — GEM error: the body is not valid SECS-II or exceeds the configured item limits.
• PDCOMM_GEM_ERROR_CORRELATION C Macro — GEM error: reply entries do not correspond to the requested identifiers (count or identifier mismatch).
• PDCOMM_GEM_ERROR_DISCONNECTED C Macro — GEM error: the GEM role saw no SELECTED HSMS session when it processed the message.
• PDCOMM_GEM_ERROR_MISSING_BODY C Macro — GEM error: the message requires a body but has none.
• PDCOMM_GEM_ERROR_RESPONSE C Macro — GEM error: the reply does not fit the pending request, or another GEM protocol rule failed without a more specific code.
• PDCOMM_GEM_ERROR_STATE C Macro — GEM error: the message is not allowed in the current communication or control state.
• PDCOMM_GEM_ERROR_UNEXPECTED_BODY C Macro — GEM error: the message must be header-only but has a body.
• PDCOMM_GEM_ERROR_UNSUPPORTED C Macro — GEM error: this role or configuration does not support the stream and function, or a reply has an unexpected stream or function.
• PDCOMM_GEM_ERROR_WAIT C Macro — GEM error: the W-bit (reply expected) does not match the message definition.
• PDCOMM_GEM_ESTABLISH C Macro — Request kind: S1F13 Establish Communications Request, from pdcomm_gem_begin_communication().
• PDCOMM_GEM_EVENT_ACK C Macro — Outcome: an Equipment received the Event Report Acknowledge (S6F12).
• PDCOMM_GEM_EVENT_DIRECTORY C Macro — Request kind for a Collection Event Namelist Request (S1F23).
• PDCOMM_GEM_EVENT_DIRECTORY_RECEIVED C Macro — Outcome: a Host received a validated Collection Event Namelist reply (S1F24).
• PDCOMM_GEM_EVENT_DIRECTORY_REPLIED C Macro — Outcome: an Equipment answered an S1F23 automatically with S1F24 from its event directory.
• PDCOMM_GEM_EVENT_QUERY C Macro — Query kind and request kind for an Event Report Request (S6F15) by CEID.
• PDCOMM_GEM_EVENT_QUERY_RECEIVED C Macro — Outcome: a Host received a validated Event Report Data reply (S6F16).
• PDCOMM_GEM_EVENT_RECEIVED C Macro — Outcome: a Host received a validated Event Report Send (S6F11).
• PDCOMM_GEM_EVENT_REPORT C Macro — Request kind for an Equipment Event Report Send (S6F11) from pdcomm_gem_equipment_publish_event().
• PDCOMM_GEM_FAILED C Macro — Result kind: a pending GEM request ended without a valid reply.
• PDCOMM_GEM_FORMATTED_PROGRAM_ACK_RECEIVED C Macro — GEM result outcome: the equipment received the S7F28 acknowledge.
• PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_BEFORE C Macro — Dependency field selector for BCDS (before command codes).
• PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_IMMEDIATE_AFTER C Macro — Dependency field selector for IACDS (immediately-after command codes).
• PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_IMMEDIATE_BEFORE C Macro — Dependency field selector for IBCDS (immediately-before command codes).
• PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_NON_AFTER C Macro — Dependency field selector for NACDS (not-after command codes).
• PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_NON_BEFORE C Macro — Dependency field selector for NBCDS (not-before command codes).
• PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_OPTIONS_VERSION C Macro — Required value of PdcommGemFormattedProgramCapabilityOptions::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_RECEIVED C Macro — GEM result outcome: the equipment received an S7F21 request.
• PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_RESULT C Macro — GEM result outcome: the host received valid S7F22 capability data.
• PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_SEND C Macro — GEM request kind of an S7F21 capability request.
• PDCOMM_GEM_FORMATTED_PROGRAM_CREATE_ONLY C Macro — Store action: add the program; fails when the PPID already exists.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_CAPABILITY_MISSING C Macro — Issue (indeterminate): no capability catalog is installed or capabilities are not configured.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_CAPABILITY_PARAMETER_UNVERIFIED C Macro — Issue (indeterminate): a catalog command has parameter descriptors, whose meaning the dry run does not evaluate; command_index is the catalog command index and observed the descriptor count.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_COMMAND_COUNT_EXCEEDED C Macro — Issue (reject): the program has more commands than CMDMAX; observed is the count and expected is CMDMAX.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_DEPENDENCY_UNVERIFIED C Macro — Issue (indeterminate): a catalog command declares a nonzero BLKDEF or dependencies, which the dry run does not evaluate; command_index is the catalog command index.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_ENCODED_BYTES_EXCEEDED C Macro — Issue (reject): the encoded program is larger than BYTMAX; observed is the size and expected is BYTMAX.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_INDETERMINATE C Macro — Dry-run outcome: at least one check is indeterminate; execution may still be started.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_INFO_VERSION C Macro — Required input value of PdcommGemFormattedProgramDryRunInfo::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_ISSUE_COMMAND_INDEX_PRESENT C Macro — Issue presence bit: PdcommGemFormattedProgramDryRunIssueInfo::command_index is valid.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_ISSUE_EXPECTED_PRESENT C Macro — Issue presence bit: PdcommGemFormattedProgramDryRunIssueInfo::expected is valid.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_ISSUE_FIELD_INDEX_PRESENT C Macro — Issue presence bit: PdcommGemFormattedProgramDryRunIssueInfo::field_index is valid.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_ISSUE_INFO_VERSION C Macro — Required input value of PdcommGemFormattedProgramDryRunIssueInfo::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_ISSUE_OBSERVED_PRESENT C Macro — Issue presence bit: PdcommGemFormattedProgramDryRunIssueInfo::observed is valid.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_MODEL_MISMATCH C Macro — Issue (reject): the program's MDLN differs from the catalog's MDLN.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_OPTIONS_VERSION C Macro — Required value of PdcommGemFormattedProgramDryRunOptions::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_PASS C Macro — Dry-run outcome: no issue was found.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_POLICY_V1 C Macro — Dry-run policy version 1, the only supported policy.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_PROGRAM_PARAMETER_UNVERIFIED C Macro — Issue (indeterminate): a program command has parameters, whose meaning the dry run does not evaluate; command_index is the program command index and observed the parameter count.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_REJECT C Macro — Dry-run outcome: the program contradicts the capability catalog; execution is refused.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_REQUIRED_COMMAND_MISSING C Macro — Issue (reject): a required catalog command is absent from the program.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_SOFTWARE_REVISION_MISMATCH C Macro — Issue (reject): the program's SOFTREV differs from the catalog's SOFTREV.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_UNKNOWN_ASCII_COMMAND C Macro — Issue (reject): an ASCII command code is not in the catalog; command_index is the program command index.
• PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_UNSIGNED_COMMAND_UNMAPPED C Macro — Issue (indeterminate): an unsigned-integer command code cannot be matched against ASCII catalog codes; command_index is the program command index.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_CANCEL C Macro — Action kind: cancel the execution; carries the index of the first command not applied.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_CANCEL_NEXT_COMMAND_INDEX_PRESENT C Macro — Action presence bit: cancel_next_command_index is valid (Cancel).
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_COMMAND_PRESENT C Macro — Action presence bit: a command code and parameters are available (Step).
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_INFO_VERSION C Macro — Required input value of PdcommGemFormattedProgramExecutionActionInfo::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_MODEL_PRESENT C Macro — Action presence bit: the program MDLN is available (Start).
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_NONE C Macro — Action kind: no action (used when nothing is pending).
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_PROGRAM_ID_PRESENT C Macro — Action presence bit: the program identifier is available (Start).
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_RESULT_ACCEPTED C Macro — Action result for Start only: started; the state becomes RUNNING.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_RESULT_APPLIED C Macro — Action result for Step only: the command was applied; the next command index advances.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_RESULT_CANCELLED C Macro — Action result for Cancel only: cancelled; the state becomes CANCELLED.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_RESULT_FAILED C Macro — Action result for any action: the action failed; the state becomes FAILED.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_RESULT_OUTCOME_UNKNOWN C Macro — Action result for any action: the effect is unknown; the state becomes OUTCOME_UNKNOWN.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_RESULT_REJECTED C Macro — Action result: refused.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_SOFTWARE_REVISION_PRESENT C Macro — Action presence bit: the program SOFTREV is available (Start).
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_START C Macro — Action kind: start the program; carries the program identity and the dry-run admission data.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_STEP C Macro — Action kind: apply one program command; carries the command code and parameters.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_TOKEN_VERSION C Macro — Required value of PdcommGemFormattedProgramExecutionActionToken::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_APPLICATION_DETAIL_PRESENT C Macro — Snapshot presence bit: the terminal report has nonempty detail bytes.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_APPLICATION_REJECTED C Macro — Terminal state: the application rejected a Start or Step action.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_APPLICATION_REPORT_PRESENT C Macro — Snapshot presence bit: a terminal report was recorded (application_report_kind and application_report_id are valid).
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_CANCELLED C Macro — Terminal state: the application confirmed a Cancel action.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_CANCEL_PENDING C Macro — Execution state: a Cancel action waits for the application's result.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_COMPLETED C Macro — Terminal state: the application reported completion after every command was applied.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_EMPTY C Macro — Execution state: no execution has been started on this endpoint.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_FAILED C Macro — Terminal state: the application reported a failed action or a failed execution.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_INFO_VERSION C Macro — Required input value of PdcommGemFormattedProgramExecutionInfo::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_OUTCOME_UNKNOWN C Macro — Terminal state: the application could not determine what the machine did.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_PENDING_ACTION_PRESENT C Macro — Snapshot presence bit: an action is pending (pending_kind and pending_action_sequence are valid).
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_RUNNING C Macro — Execution state: started, with no action pending.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_START_PENDING C Macro — Execution state: the Start action waits for the application's result.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_STEP_PENDING C Macro — Execution state: a Step action waits for the application's result.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_TERMINAL_COMPLETE C Macro — Terminal report: the execution completed.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_TERMINAL_FAIL C Macro — Terminal report: the execution failed.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_TERMINAL_OUTCOME_UNKNOWN C Macro — Terminal report: the outcome is unknown.
• PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_TOKEN_VERSION C Macro — Required value of PdcommGemFormattedProgramExecutionToken::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_OPTIONS_VERSION C Macro — Value for #PdcommGemFormattedProgramOptions::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_QUERY_OPTIONS_VERSION C Macro — Value for #PdcommGemFormattedProgramQueryOptions::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_QUERY_RECEIVED C Macro — GEM result outcome: the equipment received an S7F25 request.
• PDCOMM_GEM_FORMATTED_PROGRAM_QUERY_RESULT C Macro — GEM result outcome: the host received the S7F26 program data.
• PDCOMM_GEM_FORMATTED_PROGRAM_QUERY_SEND C Macro — GEM request kind of an S7F25 Formatted Process Program Request.
• PDCOMM_GEM_FORMATTED_PROGRAM_RECEIVED C Macro — GEM result outcome: the host received an S7F27 verification report.
• PDCOMM_GEM_FORMATTED_PROGRAM_REPLACE_ONLY C Macro — Store action: replace an existing program; fails when the PPID is absent.
• PDCOMM_GEM_FORMATTED_PROGRAM_RESPOND_ONLY C Macro — Store action: send the S7F24 acknowledge without changing the store.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_EMPTY C Macro — Selection state: no program is selected.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_INFO_VERSION C Macro — Value for #PdcommGemFormattedProgramSelectionInfo::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_READY C Macro — Selection state: the selected program is unchanged in the store and in the current session.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE C Macro — Selection state: a program is selected but is no longer valid; see the stale reason.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE_CLEARED C Macro — Validation result: no program is selected.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE_DISCONNECTED C Macro — Stale reason: the HSMS session in which the selection was made has ended.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE_ENTRY_CHANGED C Macro — Stale reason: the selected store entry was replaced.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE_ENTRY_DELETED C Macro — Stale reason: the selected PPID was removed from the store.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE_NONE C Macro — Stale reason: the selection is not stale.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE_SESSION_CHANGED C Macro — Stale reason: the current HSMS session generation differs from the one the selection was made in.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE_TOKEN_MISMATCH C Macro — Validation result: the token does not match the current selection.
• PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_TOKEN_VERSION C Macro — Value for #PdcommGemFormattedProgramSelectionToken::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_SEND C Macro — GEM request kind of an S7F27 Process Program Verification Send.
• PDCOMM_GEM_FORMATTED_PROGRAM_STORE_INFO_VERSION C Macro — Value for the version field of the store info structures.
• PDCOMM_GEM_FORMATTED_PROGRAM_TRANSFER_ACK_RECEIVED C Macro — GEM result outcome: the host received the S7F24 acknowledge.
• PDCOMM_GEM_FORMATTED_PROGRAM_TRANSFER_OPTIONS_VERSION C Macro — Value for #PdcommGemFormattedProgramTransferOptions::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_TRANSFER_RECEIVED C Macro — GEM result outcome: the equipment received an S7F23 program.
• PDCOMM_GEM_FORMATTED_PROGRAM_TRANSFER_SEND C Macro — GEM request kind of an S7F23 Formatted Process Program Send.
• PDCOMM_GEM_FORMATTED_PROGRAM_UPSERT C Macro — Store action: add the program, or replace the entry with the same PPID.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_ACK_RECEIVED C Macro — GEM result outcome: the equipment received the S7F28 acknowledgement of its S7F27 report.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_GRANT_RECEIVED C Macro — GEM result outcome: the equipment received an S7F30 grant (granted or denied).
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_OPTIONS_VERSION C Macro — Required value of PdcommGemFormattedProgramVerificationNegotiationOptions::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_RECEIVED C Macro — GEM result outcome: the host received an S7F29 inquiry.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_SEND C Macro — GEM request kind of an S7F29 verification inquiry.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_STATE_PREPARED C Macro — Negotiation state: an equipment-side record (prepared, grant, acknowledgement, or failure result).
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_STATE_RECEIVED C Macro — Negotiation state: a host-side S7F29 inquiry that has not been answered yet.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_STATE_RESPONDED C Macro — Negotiation state: a host-side S7F29 inquiry answered with S7F30.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_TERMINAL_DENIED C Macro — Terminal value: denied with a nonzero PPGNT code.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_TERMINAL_DISCONNECTED C Macro — Terminal value: the HSMS session was disconnected or deselected first.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_TERMINAL_GRANTED C Macro — Terminal value: granted.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_TERMINAL_NONE C Macro — Terminal value: not finished, or finished by a protocol error without a more specific reason.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_TERMINAL_TIMED_OUT C Macro — Terminal value: the transaction ended with a T3 reply timeout or T6 control timeout.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_REQUEST_ACK_RECEIVED C Macro — GEM result outcome: the host received the S7F32 acknowledge.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_REQUEST_OPTIONS_VERSION C Macro — Value for #PdcommGemFormattedProgramVerificationRequestOptions::version.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_REQUEST_RECEIVED C Macro — GEM result outcome: the equipment received an S7F31 request.
• PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_REQUEST_SEND C Macro — GEM request kind of an S7F31 Verification Request Send.
• PDCOMM_GEM_HOST C Macro — GEM role value for a host (::PdcommGemState::role).
• PDCOMM_GEM_HOST_OFFLINE C Macro — Control state: E30 HOST OFF-LINE (equipment is willing to go on-line; the host has not accepted).
• PDCOMM_GEM_IGNORED C Macro — Result kind: the event is not GEM traffic for this role.
• PDCOMM_GEM_INDIVIDUAL_QUERY C Macro — Query kind and request kind for an Individual Report Request (S6F19) by RPTID.
• PDCOMM_GEM_INDIVIDUAL_QUERY_RECEIVED C Macro — Outcome: a Host received a validated Individual Report Data reply (S6F20).
• PDCOMM_GEM_INVALID_RESPONSE C Macro — Result kind: a reply matched a pending request but failed validation.
• PDCOMM_GEM_LINK_REPORTS C Macro — Request kind for a Host Link Event Report request (S2F35).
• PDCOMM_GEM_LINK_REPORTS_ACK C Macro — Outcome: a Link Event Report Acknowledge (S2F36) was exchanged.
• PDCOMM_GEM_LOCAL C Macro — Online mode: an accepted ON-LINE transition enters ON-LINE LOCAL.
• PDCOMM_GEM_NAMES_RECEIVED C Macro — Outcome: a host received a valid S1F12; read the entries with pdcomm_gem_result_status_name().
• PDCOMM_GEM_NOT_COMMUNICATING C Macro — Communication state: E30 NOT COMMUNICATING.
• PDCOMM_GEM_OFFLINE C Macro — Request kind: S1F15 Request OFF-LINE.
• PDCOMM_GEM_OFFLINE_ACCEPTED C Macro — Outcome: equipment received S1F15 and answered S1F16 with OFLACK 0; an ON-LINE control state changes to HOST OFF-LINE, other states are unchanged.
• PDCOMM_GEM_OFFLINE_ACK C Macro — Outcome: a host received S1F16; acknowledgement holds OFLACK (0).
• PDCOMM_GEM_ONLINE C Macro — Request kind: S1F17 Request ON-LINE.
• PDCOMM_GEM_ONLINE_ACCEPTED C Macro — Outcome: the equipment went ON-LINE.
• PDCOMM_GEM_ONLINE_ACK C Macro — Outcome: a host received S1F18; acknowledgement holds ONLACK (0 accepted, 1 not allowed, 2 already ON-LINE).
• PDCOMM_GEM_ONLINE_LOCAL C Macro — Control state: E30 ON-LINE LOCAL.
• PDCOMM_GEM_ONLINE_REJECTED C Macro — Outcome: equipment in EQUIPMENT OFF-LINE or ATTEMPT ON-LINE received S1F17 and answered S1F18 with ONLACK 1 (not allowed).
• PDCOMM_GEM_ONLINE_REMOTE C Macro — Control state: E30 ON-LINE REMOTE.
• PDCOMM_GEM_OPERATOR_ONLINE C Macro — Request kind: the equipment's operator-initiated S1F1 ON-LINE attempt.
• PDCOMM_GEM_OPTIONS_VERSION C Macro — Current version of ::PdcommGemHostOptions and ::PdcommGemEquipmentOptions.
• PDCOMM_GEM_OUTCOME_NONE C Macro — Outcome: none (ignored, failed, invalid, and unhandled results, and results without a specific outcome).
• PDCOMM_GEM_PRIMARY C Macro — Result kind: a received primary message was processed.
• PDCOMM_GEM_PROGRAM_ACK_RECEIVED C Macro — Result outcome: an S7F4 or S7F18 acknowledgement (ACKC7) was received.
• PDCOMM_GEM_PROGRAM_BODY C Macro — Field selector for pdcomm_gem_result_program_item(): the PPBODY.
• PDCOMM_GEM_PROGRAM_CONFIRMED C Macro — Durability: an unconfirmed installation was accepted with pdcomm_gem_program_confirm_reply().
• PDCOMM_GEM_PROGRAM_CREATE C Macro — Put mode: create a new program; fail if the PPID exists.
• PDCOMM_GEM_PROGRAM_DATA_RECEIVED C Macro — Result outcome: an S7F6 program data reply was received.
• PDCOMM_GEM_PROGRAM_DELETE C Macro — Request kind of S7F17 delete process program send.
• PDCOMM_GEM_PROGRAM_DIRECTORY C Macro — Request kind of S7F19 current equipment process program directory request.
• PDCOMM_GEM_PROGRAM_DIRECTORY_RECEIVED C Macro — Result outcome: an S7F20 directory reply was received.
• PDCOMM_GEM_PROGRAM_DURABILITY_NONE C Macro — Durability: no change was installed.
• PDCOMM_GEM_PROGRAM_GRANT C Macro — Request kind of S7F1 process program load inquire (grant request).
• PDCOMM_GEM_PROGRAM_GRANT_OPTIONAL C Macro — Grant policy: an incoming S7F3 without a grant is accepted when no other grant is active.
• PDCOMM_GEM_PROGRAM_GRANT_RECEIVED C Macro — Result outcome: an S7F2 grant (PPGNT) was received.
• PDCOMM_GEM_PROGRAM_GRANT_REQUIRED C Macro — Grant policy: an incoming S7F3 needs a prior accepted S7F1 grant for the same PPID.
• PDCOMM_GEM_PROGRAM_ID C Macro — Field selector for pdcomm_gem_result_program_item(): a PPID.
• PDCOMM_GEM_PROGRAM_OPTIONS_VERSION C Macro — Required version of ::PdcommGemProgramOptions.
• PDCOMM_GEM_PROGRAM_RECEIVED C Macro — Result outcome: a valid incoming S7F1, F3, F5, F17, or F19 request was received.
• PDCOMM_GEM_PROGRAM_REPLACE C Macro — Put mode: replace an existing program; fail if the PPID does not exist.
• PDCOMM_GEM_PROGRAM_REQUEST C Macro — Request kind of S7F5 process program request.
• PDCOMM_GEM_PROGRAM_SEND C Macro — Request kind of S7F3 process program send.
• PDCOMM_GEM_PROGRAM_SYNCED C Macro — Durability: the snapshot file was replaced and its parent directory synchronized.
• PDCOMM_GEM_PROGRAM_UNCONFIRMED C Macro — Durability: the snapshot file was replaced, but the directory sync failed (#PDCOMM_PROGRAM_UNCONFIRMED).
• PDCOMM_GEM_PROGRAM_UPSERT C Macro — Put mode: create the program or replace an existing one.
• PDCOMM_GEM_PROGRAM_VOLATILE C Macro — Durability: the change was applied to a RAM store.
• PDCOMM_GEM_REMOTE C Macro — Online mode: an accepted ON-LINE transition enters ON-LINE REMOTE.
• PDCOMM_GEM_REMOTE_COMMAND C Macro — Request kind of an S2F41 Host Command Send.
• PDCOMM_GEM_REPLIED C Macro — Outcome: a received primary was answered automatically and has no more specific outcome, for example S1F1 answered with S1F2.
• PDCOMM_GEM_REPORT_OPTIONS_VERSION C Macro — Version value for PdcommGemReportOptions::version.
• PDCOMM_GEM_REPORT_QUERY_RECEIVED C Macro — Outcome: an Equipment received a valid S6F15, S6F19, or S6F21 that awaits pdcomm_gem_equipment_respond_report_query().
• PDCOMM_GEM_RESPONSE C Macro — Result kind: a valid reply completed a pending GEM request.
• PDCOMM_GEM_SOURCE_CONSTANT C Macro — Binding source kind: the current value of an equipment constant from pdcomm_gem_equipment_configure_constants().
• PDCOMM_GEM_SOURCE_DATA C Macro — Binding source kind: a data variable from pdcomm_gem_equipment_configure_data_variables().
• PDCOMM_GEM_SOURCE_STATUS C Macro — Binding source kind: a status variable registered with pdcomm_gem_equipment_status_register().
• PDCOMM_GEM_SPOOL_ACTIVATED C Macro — Mutation: spooling became active because communication is down and spooling is enabled.
• PDCOMM_GEM_SPOOL_CAPTURED C Macro — Mutation: a message was stored; entry_id names it and affected_count counts overwritten entries.
• PDCOMM_GEM_SPOOL_CONFIGURE C Macro — Request kind of an S2F43 reset spooling streams and functions request.
• PDCOMM_GEM_SPOOL_CONFIGURED C Macro — Mutation: spool policy and selection were replaced (initial snapshot, local configuration, or accepted S2F43).
• PDCOMM_GEM_SPOOL_CONFIG_ACK C Macro — Result outcome: Host received a valid S2F44 reset spooling acknowledge.
• PDCOMM_GEM_SPOOL_CONFIG_DATA C Macro — Result outcome: Host received a valid S2F60 carrying the current selection.
• PDCOMM_GEM_SPOOL_CONFIRMED C Macro — Durability: an unconfirmed reply was accepted with pdcomm_gem_spool_confirm_reply().
• PDCOMM_GEM_SPOOL_CONTROL C Macro — Request kind of an S6F23 request spooled data (transmit or purge).
• PDCOMM_GEM_SPOOL_CONTROL_ACK C Macro — Result outcome: Host received a valid S6F24 request spooled data acknowledge.
• PDCOMM_GEM_SPOOL_DELIVERY C Macro — Request kind of a spooled message sent by pdcomm_gem_spool_send_next().
• PDCOMM_GEM_SPOOL_DELIVERY_FAILED C Macro — Result outcome: a delivery attempt failed (T3, cancellation, disconnect, write failure, or invalid reply).
• PDCOMM_GEM_SPOOL_DELIVERY_RESPONSE C Macro — Result outcome: the matching secondary reply to a W1 spooled message arrived.
• PDCOMM_GEM_SPOOL_DELIVERY_WRITTEN C Macro — Result outcome: a W0 spooled message was completely written to the local socket.
• PDCOMM_GEM_SPOOL_DISCARDED C Macro — Mutation: a selected message was discarded because the spool is full; only statistics changed.
• PDCOMM_GEM_SPOOL_DISCARD_NEW C Macro — Overflow policy: when the spool is full, discard the new message (E30 OverWriteSpool false).
• PDCOMM_GEM_SPOOL_DURABILITY_NONE C Macro — Durability: no change was installed.
• PDCOMM_GEM_SPOOL_MUTATION_NONE C Macro — Mutation: nothing was changed.
• PDCOMM_GEM_SPOOL_OPTIONS_VERSION C Macro — Required version of ::PdcommGemSpoolOptions and ::PdcommGemSpoolHostOptions.
• PDCOMM_GEM_SPOOL_OVERWRITE_OLDEST C Macro — Overflow policy: when the spool is full, remove the oldest messages to make room (E30 OverWriteSpool true).
• PDCOMM_GEM_SPOOL_PROOF_NONE C Macro — Delivery proof: the result carries no delivery proof.
• PDCOMM_GEM_SPOOL_PROOF_RESPONSE C Macro — Delivery proof: a matching secondary reply to a W1 spooled message was received.
• PDCOMM_GEM_SPOOL_PROOF_WRITTEN C Macro — Delivery proof: the complete frame of a W0 spooled message was written locally.
• PDCOMM_GEM_SPOOL_PURGE C Macro — S6F23 RSDC command 1: purge spooled messages.
• PDCOMM_GEM_SPOOL_PURGED C Macro — Mutation: all spooled messages were purged; affected_count counts them.
• PDCOMM_GEM_SPOOL_QUERY C Macro — Request kind of an S2F59 spool configuration request (current selection).
• PDCOMM_GEM_SPOOL_RECEIVED C Macro — Result outcome: Equipment received a valid S2F43, S2F59, or S6F23 primary.
• PDCOMM_GEM_SPOOL_REMOVED C Macro — Mutation: a delivered head entry was dequeued; entry_id names it.
• PDCOMM_GEM_SPOOL_SYNCED C Macro — Durability: the snapshot file was replaced and its parent directory synchronized.
• PDCOMM_GEM_SPOOL_TRANSMIT C Macro — S6F23 RSDC command 0: transmit spooled messages.
• PDCOMM_GEM_SPOOL_UNCONFIRMED C Macro — Durability: the snapshot file was replaced, but the directory sync failed (#PDCOMM_SPOOL_UNCONFIRMED).
• PDCOMM_GEM_SPOOL_VOLATILE C Macro — Durability: the change was applied to a RAM spool.
• PDCOMM_GEM_STATUS_NAMES C Macro — Request kind: S1F11 Status Variable Namelist Request.
• PDCOMM_GEM_STATUS_REPLIED C Macro — Outcome: equipment answered S1F3 with S1F4 or S1F11 with S1F12 from its status variable registry.
• PDCOMM_GEM_STATUS_VALUES C Macro — Request kind: S1F3 Selected Equipment Status Request (status variable values).
• PDCOMM_GEM_UNHANDLED C Macro — Result kind: a received primary was not processed and no reply was sent.
• PDCOMM_GEM_VALUES_RECEIVED C Macro — Outcome: a host received a valid S1F4; read the values with pdcomm_gem_result_status_value().
• PDCOMM_GEM_WAITING_ACK C Macro — Communication state: S1F13 sent, waiting for S1F14 (E30 WAIT CRA).
• PDCOMM_INVALID_STATE C Macro — The call is not valid in the endpoint's current state or context.
• PDCOMM_POISONED C Macro — The endpoint is permanently unusable after a contained panic.
• PDCOMM_PROGRAM_UNCONFIRMED C Macro — The program store change was installed, but its durability is unconfirmed.
• PDCOMM_SECS1_EVENT_FAULT C Macro — Event kind: a terminal fault stopped the endpoint.
• PDCOMM_SECS1_EVENT_INBOUND C Macro — Event kind: a complete message was received.
• PDCOMM_SECS1_EVENT_OUTBOUND_COMPLETE C Macro — Event kind: the peer acknowledged every block of a submitted message.
• PDCOMM_SECS1_EVENT_OUTBOUND_FAILED C Macro — Event kind: a submitted message was not delivered.
• PDCOMM_SECS1_FAULT_BLOCK C Macro — Fault kind reserved for block faults; not produced by this release.
• PDCOMM_SECS1_FAULT_CLOSED C Macro — Fault kind: the read callback reported end of stream.
• PDCOMM_SECS1_FAULT_IO C Macro — Fault kind: a read or write callback failed.
• PDCOMM_SECS1_FAULT_LINE C Macro — Fault kind reserved for line-control faults; not produced by this release.
• PDCOMM_SECS1_FAULT_REASSEMBLY C Macro — Fault kind: memory for reassembling an inbound message could not be allocated.
• PDCOMM_SECS1_FAULT_UNKNOWN_CONTROL C Macro — Fault kind retained for compatibility; no longer produced.
• PDCOMM_SECS1_IO_ABORTED C Macro — I/O result or fault detail: the connection was aborted.
• PDCOMM_SECS1_IO_ADDRESS_IN_USE C Macro — I/O result or fault detail: the address is already in use.
• PDCOMM_SECS1_IO_ADDRESS_UNAVAILABLE C Macro — I/O result or fault detail: the address is not available.
• PDCOMM_SECS1_IO_BROKEN_PIPE C Macro — I/O result or fault detail: the pipe or line is broken.
• PDCOMM_SECS1_IO_CLOSED C Macro — I/O result or fault detail: the stream is closed.
• PDCOMM_SECS1_IO_INTERRUPTED C Macro — I/O result: the operation was interrupted before any transfer.
• PDCOMM_SECS1_IO_INVALID_DATA C Macro — I/O result or fault detail: invalid data.
• PDCOMM_SECS1_IO_INVALID_INPUT C Macro — I/O result or fault detail: the device layer rejected an input parameter.
• PDCOMM_SECS1_IO_NOT_CONNECTED C Macro — I/O result or fault detail: the stream is not connected.
• PDCOMM_SECS1_IO_NOT_FOUND C Macro — I/O result or fault detail: the device or entity was not found.
• PDCOMM_SECS1_IO_OK C Macro — I/O result: the operation succeeded.
• PDCOMM_SECS1_IO_OTHER C Macro — I/O result or fault detail: any other failure.
• PDCOMM_SECS1_IO_PERMISSION C Macro — I/O result or fault detail: permission was denied.
• PDCOMM_SECS1_IO_REFUSED C Macro — I/O result or fault detail: the connection was refused.
• PDCOMM_SECS1_IO_RESET C Macro — I/O result or fault detail: the connection was reset by the peer.
• PDCOMM_SECS1_IO_TIMED_OUT C Macro — I/O result or fault detail: the operation timed out in the device layer.
• PDCOMM_SECS1_IO_WOULD_BLOCK C Macro — I/O result: no progress is possible now.
• PDCOMM_SECS1_IO_WRITE_ZERO C Macro — I/O result or fault detail: a write made no progress.
• PDCOMM_SECS1_MASTER C Macro — Line priority of the SEMI E4 master.
• PDCOMM_SECS1_MESSAGE_VERSION C Macro — Value for PdcommSecs1Message::version.
• PDCOMM_SECS1_OPTIONS_VERSION C Macro — Value for PdcommSecs1Options::version.
• PDCOMM_SECS1_SLAVE C Macro — Line priority of the SEMI E4 slave.
• PDCOMM_SECS1_TO_EQUIPMENT C Macro — Message direction host to equipment: the block header R-bit is 0.
• PDCOMM_SECS1_TO_HOST C Macro — Message direction equipment to host: the block header R-bit is 1.
• PDCOMM_SECS_ASCII C Macro — SECS-II format code for ASCII (E5 format 20, octal); bytes must be 0x00 to 0x7F.
• PDCOMM_SECS_BINARY C Macro — SECS-II format code for Binary (E5 format 10, octal), 1-byte elements.
• PDCOMM_SECS_BOOLEAN C Macro — SECS-II format code for Boolean (E5 format 11, octal), 1-byte elements.
• PDCOMM_SECS_F4 C Macro — SECS-II format code for 4-byte IEEE 754 floats (E5 format 44, octal).
• PDCOMM_SECS_F8 C Macro — SECS-II format code for 8-byte IEEE 754 floats (E5 format 40, octal).
• PDCOMM_SECS_I1 C Macro — SECS-II format code for 1-byte signed integers (E5 format 31, octal).
• PDCOMM_SECS_I2 C Macro — SECS-II format code for 2-byte signed integers (E5 format 32, octal).
• PDCOMM_SECS_I4 C Macro — SECS-II format code for 4-byte signed integers (E5 format 34, octal).
• PDCOMM_SECS_I8 C Macro — SECS-II format code for 8-byte signed integers (E5 format 30, octal).
• PDCOMM_SECS_JIS8 C Macro — SECS-II format code for JIS-8 text (E5 format 21, octal); bytes are not validated.
• PDCOMM_SECS_LIST C Macro — SECS-II format code for a List (E5 format 00).
• PDCOMM_SECS_U1 C Macro — SECS-II format code for 1-byte unsigned integers (E5 format 51, octal).
• PDCOMM_SECS_U2 C Macro — SECS-II format code for 2-byte unsigned integers (E5 format 52, octal).
• PDCOMM_SECS_U4 C Macro — SECS-II format code for 4-byte unsigned integers (E5 format 54, octal).
• PDCOMM_SECS_U8 C Macro — SECS-II format code for 8-byte unsigned integers (E5 format 50, octal).
• PDCOMM_SPOOL_UNCONFIRMED C Macro — The spool change was installed, but its durability is unconfirmed.
• PDCOMM_STALE_TOKEN C Macro — The token or event belongs to another endpoint or to an earlier connection generation.
• PDCOMM_TCP_ACTIVE C Macro — Connection mode: the endpoint connects to the peer (HSMS active entity).
• PDCOMM_TCP_CANCELLED C Macro — Failure reason: cancelled by pdcomm_tcp_cancel() or pdcomm_tcp_stop().
• PDCOMM_TCP_CONNECTING C Macro — State: active mode; a connection attempt is due and runs inside pdcomm_tcp_poll().
• PDCOMM_TCP_DESELECTED C Macro — Failure reason: a Deselect procedure (local or remote) completed while the transaction was open.
• PDCOMM_TCP_DESELECT_STATUS C Macro — Failure reason: Deselect.rsp carried a nonzero DeselectStatus, stored in PdcommTcpEventInfo::value1.
• PDCOMM_TCP_DISCONNECTED C Macro — Failure reason: the connection ended while the transaction was open.
• PDCOMM_TCP_DUPLICATE_PRIMARY C Macro — Protocol error: a W-bit primary reuses the system bytes of a received primary that is still unanswered.
• PDCOMM_TCP_FAILED C Macro — Event kind: an outgoing transaction ended without a reply.
• PDCOMM_TCP_FRAME_BUFFER_TOO_SMALL C Macro — Frame error: the frame buffer is too small.
• PDCOMM_TCP_FRAME_CONTROL_BODY C Macro — Frame error: a control message has a body; PdcommTcpEventInfo::value1 holds its length.
• PDCOMM_TCP_FRAME_CONTROL_SESSION C Macro — Frame error: a control message has a session ID other than 0xFFFF; PdcommTcpEventInfo::value1 holds it.
• PDCOMM_TCP_FRAME_HEADER_FIELD C Macro — Frame error: a header byte has an invalid value.
• PDCOMM_TCP_FRAME_INVALID_LENGTH C Macro — Frame error: the message length field is smaller than the 10-byte HSMS header; PdcommTcpEventInfo::value1 holds the declared length.
• PDCOMM_TCP_FRAME_LENGTH_OVERFLOW C Macro — Frame error: the frame length does not fit in the platform's size type.
• PDCOMM_TCP_FRAME_LIMIT C Macro — Protocol error code reserved for received frames above PdcommTcpOptions::max_frame_bytes.
• PDCOMM_TCP_FRAME_LIMIT_EXCEEDED C Macro — Frame error: the frame exceeds the frame limit.
• PDCOMM_TCP_FRAME_NEED_MORE C Macro — Frame error: more bytes are needed.
• PDCOMM_TCP_FRAME_NOT_DATA C Macro — Frame error: a data message was expected but the frame is a control message.
• PDCOMM_TCP_FRAME_READER_FAILED C Macro — Frame error: the frame reader failed earlier and cannot continue.
• PDCOMM_TCP_FRAME_SECS_BODY C Macro — Frame error: a data message body is not exactly one valid SECS-II item within PdcommTcpOptions::item_limits.
• PDCOMM_TCP_FRAME_TRAILING_DATA C Macro — Frame error: bytes follow the frame.
• PDCOMM_TCP_FRAME_UNSUPPORTED_PTYPE C Macro — Frame error: unsupported PType; PdcommTcpEventInfo::value1 holds it.
• PDCOMM_TCP_FRAME_UNSUPPORTED_STYPE C Macro — Frame error: unsupported SType; PdcommTcpEventInfo::value1 holds it.
• PDCOMM_TCP_INCOMING_LIMIT C Macro — Protocol error: a W-bit primary arrived while #PDCOMM_TCP_MAX_TRANSACTIONS received primaries were unanswered.
• PDCOMM_TCP_INVALID_FRAME C Macro — Protocol error: a received frame is malformed.
• PDCOMM_TCP_INVALID_REJECT C Macro — Protocol error: a Reject.req matches no open transaction, or its rejected type or session ID does not match the transaction.
• PDCOMM_TCP_INVALID_REPLY C Macro — Protocol error code reserved for invalid replies; this version does not produce it.
• PDCOMM_TCP_IO_ABORTED C Macro — I/O error kind: the connection was aborted.
• PDCOMM_TCP_IO_ADDRESS_IN_USE C Macro — I/O error kind: the address is already in use.
• PDCOMM_TCP_IO_ADDRESS_UNAVAILABLE C Macro — I/O error kind: the address is not available on this host.
• PDCOMM_TCP_IO_BROKEN_PIPE C Macro — I/O error kind: the connection's write side is closed (broken pipe).
• PDCOMM_TCP_IO_INTERRUPTED C Macro — I/O error kind: the operation was interrupted.
• PDCOMM_TCP_IO_INVALID_DATA C Macro — I/O error kind: invalid data, including HSMS framing failures.
• PDCOMM_TCP_IO_INVALID_INPUT C Macro — I/O error kind: an invalid parameter was passed to the operating system.
• PDCOMM_TCP_IO_NOT_CONNECTED C Macro — I/O error kind: the socket is not connected.
• PDCOMM_TCP_IO_NOT_FOUND C Macro — I/O error kind: an entity was not found.
• PDCOMM_TCP_IO_OTHER C Macro — I/O error kind: any error without a more specific portable kind.
• PDCOMM_TCP_IO_PERMISSION C Macro — I/O error kind: permission denied.
• PDCOMM_TCP_IO_REFUSED C Macro — I/O error kind: the peer refused the connection.
• PDCOMM_TCP_IO_RESET C Macro — I/O error kind: the peer reset the connection.
• PDCOMM_TCP_IO_TIMED_OUT C Macro — I/O error kind: the operation timed out.
• PDCOMM_TCP_IO_UNEXPECTED_EOF C Macro — I/O error kind: the stream ended unexpectedly.
• PDCOMM_TCP_IO_WOULD_BLOCK C Macro — I/O error kind: the operation would block.
• PDCOMM_TCP_IO_WRITE_ZERO C Macro — I/O error kind: a write accepted zero bytes.
• PDCOMM_TCP_LISTENING C Macro — State: passive mode; waiting to accept a connection.
• PDCOMM_TCP_MAX_TRANSACTIONS C Macro — Number of transaction slots per endpoint.
• PDCOMM_TCP_NOT_SELECTED C Macro — State: TCP connected, HSMS NOT SELECTED.
• PDCOMM_TCP_OPTIONS_VERSION C Macro — Required value of PdcommTcpOptions::version.
• PDCOMM_TCP_OP_ACCEPT C Macro — Socket operation: accepting a connection (passive mode).
• PDCOMM_TCP_OP_BIND C Macro — Socket operation: binding the passive listening socket.
• PDCOMM_TCP_OP_CONFIGURE C Macro — Socket operation: configuring a socket (non-blocking mode, TCP_NODELAY) or allocating its buffers.
• PDCOMM_TCP_OP_CONNECT C Macro — Socket operation: connecting to the peer (active mode).
• PDCOMM_TCP_OP_LOCAL_ADDRESS C Macro — Socket operation: reading the local socket address.
• PDCOMM_TCP_OP_READ C Macro — Socket operation: reading from the connection.
• PDCOMM_TCP_OP_WRITE C Macro — Socket operation: writing to the connection.
• PDCOMM_TCP_PASSIVE C Macro — Connection mode: the endpoint listens and accepts the peer's connection (HSMS passive entity).
• PDCOMM_TCP_PROTOCOL_ERROR C Macro — Event kind: the peer violated the HSMS protocol.
• PDCOMM_TCP_RECEIVED C Macro — Event kind: a data message (primary or reply) was received.
• PDCOMM_TCP_REJECTED C Macro — Failure reason: the peer answered with Reject.req.
• PDCOMM_TCP_RETRY_WAIT C Macro — State: active mode; waiting for the T5 connect separation timeout before the next attempt.
• PDCOMM_TCP_SELECTED C Macro — State: HSMS SELECTED; data messages can be exchanged.
• PDCOMM_TCP_SELECT_STATUS C Macro — Failure reason: Select.rsp carried a nonzero SelectStatus, stored in PdcommTcpEventInfo::value1.
• PDCOMM_TCP_STATE_CHANGED C Macro — Event kind: the HSMS state changed.
• PDCOMM_TCP_STOPPED C Macro — State: not started, or stopped by pdcomm_tcp_stop().
• PDCOMM_TCP_T3_TIMEOUT C Macro — Failure reason: no reply to a W-bit data request within the T3 reply timeout.
• PDCOMM_TCP_T6_TIMEOUT C Macro — Failure reason: no response to Select.req, Deselect.req, or Linktest.req within the T6 control transaction timeout.
• PDCOMM_TCP_TRANSPORT_ERROR C Macro — Event kind: a socket operation failed.
• PDCOMM_TCP_UNEXPECTED_CONTROL C Macro — Protocol error code reserved for unexpected control responses.
• PDCOMM_TCP_UNEXPECTED_REPLY C Macro — Protocol error: a reply data message matches no open request, for example after a T3 timeout or a cancellation.
• PDCOMM_TCP_W0_WRITTEN C Macro — Event kind: a primary sent without the W-bit was completely written to the local socket.
• PDCOMM_TCP_WRONG_SESSION C Macro — Protocol error: a data message carries a session ID other than PdcommTcpOptions::session_id.
• PdcommGem300Capability C Struct — Input description of one capability, read by pdcomm_gem300_capability_catalog_replace().
• axis C Field — Axis: one of #PDCOMM_GEM300_PROCESS_JOB, #PDCOMM_GEM300_CARRIER, #PDCOMM_GEM300_SUBSTRATE, or #PDCOMM_GEM300_CONTROL_JOB; unique in the profile.
• id C Field — Identifier bytes, not NUL-terminated; printable ASCII 0x21 to 0x7E.
• id_length C Field — Number of bytes at id; nonzero and at most max_capability_id_bytes.
• reserved C Field — Reserved; must be zero.
• status C Field — Status label: #PDCOMM_GEM300_PLANNED, #PDCOMM_GEM300_MODEL_ONLY, or #PDCOMM_GEM300_EXPERIMENTAL.
• verification C Field — Verification label; must be #PDCOMM_GEM300_UNVERIFIED.
• PdcommGem300CapabilityCatalog C Typedef — Opaque, mutable capability catalog.
• PdcommGem300CapabilityCatalogInfo C Struct — Totals of a catalog or snapshot, filled by pdcomm_gem300_capability_catalog_info() or pdcomm_gem300_capability_snapshot_info().
• capability_count C Field — Number of capabilities across all profiles.
• identifier_bytes C Field — Sum of all profile and capability identifier lengths in bytes.
• profile_count C Field — Number of profiles.
• reserved C Field — Reserved; set to zero before the call.
• revision C Field — Catalog revision: 0 for a new catalog, incremented by each change.
• struct_size C Field — Structure size in bytes.
• version C Field — Structure version; set to #PDCOMM_GEM300_CAPABILITY_INFO_VERSION before the call.
• PdcommGem300CapabilityInfo C Struct — Description of one snapshot capability, filled by pdcomm_gem300_capability_snapshot_capability_info().
• axis C Field — Capability axis, one of the axis macros such as #PDCOMM_GEM300_PROCESS_JOB.
• id_length C Field — Length of the capability identifier in bytes.
• reserved C Field — Reserved; set to zero before the call.
• reserved2 C Field — Reserved; set to zero before the call.
• status C Field — Status label, one of #PDCOMM_GEM300_PLANNED, #PDCOMM_GEM300_MODEL_ONLY, or #PDCOMM_GEM300_EXPERIMENTAL.
• struct_size C Field — Structure size in bytes.
• verification C Field — Verification label; #PDCOMM_GEM300_UNVERIFIED, the defined value.
• version C Field — Structure version; set to #PDCOMM_GEM300_CAPABILITY_INFO_VERSION before the call.
• PdcommGem300CapabilityOptions C Struct — Catalog limits for pdcomm_gem300_capability_catalog_create().
• max_capabilities_per_profile C Field — Largest number of capabilities in one profile; from 1 to 4, one per axis.
• max_capability_id_bytes C Field — Largest capability identifier length in bytes.
• max_profile_id_bytes C Field — Largest profile identifier length in bytes.
• max_profiles C Field — Largest number of profiles in the catalog.
• max_total_capabilities C Field — Largest number of capabilities across all profiles.
• max_total_identifier_bytes C Field — Largest sum of all profile and capability identifier lengths in bytes.
• reserved C Field — Reserved; must be zero.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGem300CapabilityOptions) or larger.
• version C Field — Structure version; must be #PDCOMM_GEM300_CAPABILITY_OPTIONS_VERSION.
• PdcommGem300CapabilityProfile C Struct — Input description of one profile, read by pdcomm_gem300_capability_catalog_replace().
• capabilities C Field — Array of capability_count capabilities, in the order to keep.
• capability_count C Field — Number of capabilities; from 1 to max_capabilities_per_profile.
• id C Field — Identifier bytes, not NUL-terminated; printable ASCII 0x21 to 0x7E, unique in the catalog.
• id_length C Field — Number of bytes at id; nonzero and at most max_profile_id_bytes.
• PdcommGem300CapabilityProfileInfo C Struct — Description of one snapshot profile, filled by pdcomm_gem300_capability_snapshot_profile_info().
• capability_count C Field — Number of capabilities in the profile.
• id_length C Field — Length of the profile identifier in bytes.
• reserved C Field — Reserved; set to zero before the call.
• struct_size C Field — Structure size in bytes.
• version C Field — Structure version; set to #PDCOMM_GEM300_CAPABILITY_INFO_VERSION before the call.
• PdcommGem300CapabilitySnapshot C Typedef — Opaque, immutable, owned copy of a catalog's contents.
• PdcommGemAlarmChange C Struct — Result of an alarm observation, filled by pdcomm_gem_equipment_observe_alarm().
• active C Field — Alarm state after the observation: 1 for set, 0 for cleared.
• changed C Field — 1 when the observation changed the alarm state, 0 when the state was already the observed one.
• event_id C Field — CEID of the transition that occurred; 0 when event_present is 0.
• event_present C Field — 1 when the transition has a configured set or clear CEID in event_id, otherwise 0 (always 0 without a transition).
• id C Field — Alarm ID (ALID) that was observed.
• reporting_enabled C Field — Snapshot of the reporting-enabled flag: 1 when an S5F1 report may be published for this alarm.
• struct_size C Field — Structure size; set to sizeof(PdcommGemAlarmChange) or larger, receives the size written.
• PdcommGemAlarmDefinition C Struct — One alarm definition passed to pdcomm_gem_equipment_configure_alarms().
• category C Field — Alarm category, 1 to 63.
• clear_event C Field — Collection event ID (CEID) linked to the clear transition; read only when clear_event_present is 1.
• clear_event_present C Field — 1 when clear_event is present, otherwise 0.
• id C Field — Alarm ID (ALID); must be unique within the store.
• set_event C Field — Collection event ID (CEID) linked to the set transition; read only when set_event_present is 1.
• set_event_present C Field — 1 when set_event is present, otherwise 0.
• text C Field — Alarm text (ALTX) as ASCII bytes, not NUL-terminated; may be NULL when text_length is 0.
• text_length C Field — Number of bytes at text.
• PdcommGemAlarmInfo C Struct — Definition and current state of one stored alarm, filled by pdcomm_gem_equipment_alarm_at().
• active C Field — 1 when the alarm is currently set, otherwise 0.
• category C Field — Alarm category, 1 to 63.
• clear_event C Field — Clear-transition CEID; 0 when clear_event_present is 0.
• clear_event_present C Field — 1 when a clear-transition CEID is configured, otherwise 0.
• enabled C Field — 1 when the Host has enabled reporting of this alarm, otherwise 0.
• id C Field — Alarm ID (ALID).
• set_event C Field — Set-transition CEID; 0 when set_event_present is 0.
• set_event_present C Field — 1 when a set-transition CEID is configured, otherwise 0.
• struct_size C Field — Structure size; set to sizeof(PdcommGemAlarmInfo) or larger, receives the size written.
• PdcommGemAlarmOptions C Struct — Limits for the alarm store, passed to pdcomm_gem_equipment_configure_alarms().
• max_alarms C Field — Largest number of alarm definitions; must be at least 1.
• max_text_bytes C Field — Largest alarm text length of one alarm, in bytes; the effective limit is min(max_text_bytes, 120).
• max_total_text_bytes C Field — Largest sum of the alarm text lengths of all alarms, in bytes.
• reserved C Field — Reserved; must be 0.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGemAlarmOptions) or larger.
• version C Field — Options version; must be #PDCOMM_GEM_ALARM_OPTIONS_VERSION.
• PdcommGemAlarmResultInfo C Struct — Summary of an alarm result, filled by pdcomm_gem_result_alarm_info().
• acknowledged C Field — 1 after pdcomm_gem_host_acknowledge_alarm() sent S5F2 for this report; always 0 for list replies.
• count C Field — Number of alarm entries: 1 for an S5F1 report, the list length for an S5F6 or S5F8 reply.
• is_report C Field — 1 for a received S5F1 alarm report, 0 for an alarm list reply.
• reply_expected C Field — W bit of the received S5F1 report; always 0 for list replies.
• struct_size C Field — Structure size; set to sizeof(PdcommGemAlarmResultInfo) or larger, receives the size written.
• PdcommGemAlarmState C Struct — Summary of the alarm store, filled by pdcomm_gem_equipment_alarm_state().
• active_count C Field — Number of alarms currently set (active).
• alarm_count C Field — Number of configured alarms.
• enabled_count C Field — Number of alarms whose reporting the Host has enabled with S5F3.
• struct_size C Field — Structure size; set to sizeof(PdcommGemAlarmState) or larger, receives the size written.
• text_bytes C Field — Sum of the alarm text lengths of all alarms, in bytes.
• PdcommGemAlarmValue C Struct — One alarm tuple from a received report or list, filled by pdcomm_gem_result_alarm_at().
• active C Field — 1 when the ALCD alarm-set bit (0x80) is set, otherwise 0.
• category C Field — Alarm category from the low six bits of ALCD (ALCD & 0x3F).
• id C Field — Alarm ID (ALID).
• struct_size C Field — Structure size; set to sizeof(PdcommGemAlarmValue) or larger, receives the size written.
• PdcommGemBindingInfo C Struct — One binding, filled by pdcomm_gem_equipment_binding_at().
• source_id C Field — Status variable ID or DVID; 0 for a CONSTANT source.
• source_kind C Field — Source kind (PDCOMM_GEM_SOURCE_*).
• struct_size C Field — Structure size in bytes; set before the call, receives the size written.
• vid C Field — Variable ID (VID).
• PdcommGemBindingOptions C Struct — Limits of an explicit report binding store.
• max_bindings C Field — Largest number of bindings.
• max_identifier_bytes C Field — Largest ASCII constant ID of one binding, in bytes (numeric IDs count as 0).
• max_total_identifier_bytes C Field — Largest total of ASCII constant ID bytes across all bindings.
• reserved C Field — Must be 0.
• struct_size C Field — Structure size in bytes; set to sizeof(PdcommGemBindingOptions) or larger.
• version C Field — Must be #PDCOMM_GEM_BINDING_OPTIONS_VERSION.
• PdcommGemBindingState C Struct — Counters of the binding store, filled by pdcomm_gem_equipment_binding_state().
• binding_count C Field — Number of bindings.
• explicit_mode C Field — 1 when a binding store is installed (explicit mode, possibly empty); 0 for legacy VID-to-status resolution.
• identifier_bytes C Field — Total ASCII constant ID bytes.
• struct_size C Field — Structure size in bytes; set before the call, receives the size written.
• PdcommGemCommandDefinition C Struct — Definition of one remote command (RCMD).
• completion_event C Field — CEID reported to the application when the command is acknowledged with HCACK 0 or 4.
• completion_event_present C Field — 1 when completion_event is present, otherwise 0.
• count C Field — Number of parameter definitions; names must be unique within the command.
• name C Field — RCMD item: nonempty ASCII or an integer scalar from -128 to 255; must not be NULL.
• parameters C Field — Array of count parameter definitions; may be NULL when count is 0.
• require_online_remote C Field — 1 to answer HCACK 2 unless the control state is ONLINE REMOTE at receipt, otherwise 0.
• PdcommGemCommandInfo C Struct — Definition summary of one stored command.
• completion_event C Field — Completion CEID; 0 when completion_event_present is 0.
• completion_event_present C Field — 1 when a completion CEID is configured.
• parameter_count C Field — Number of parameter definitions of the command.
• require_online_remote C Field — 1 when the command requires the ONLINE REMOTE control state.
• struct_size C Field — Structure size; set to sizeof(PdcommGemCommandInfo) or larger, receives the size written.
• PdcommGemCommandIssue C Struct — One CPACK entry for an application S2F42 response.
• code C Field — CPACK code: 1 name does not exist, 2 illegal value, 3 illegal format.
• name C Field — CPNAME item (ASCII or integer scalar) that the entry refers to; must not be NULL.
• PdcommGemCommandOptions C Struct — Limits for the remote command store, passed to pdcomm_gem_equipment_configure_commands().
• max_commands C Field — Largest number of command definitions; must be at least 1.
• max_errors C Field — Largest number of CPACK entries in a frozen validation or an application response.
• max_identifier_bytes C Field — Largest length of one ASCII RCMD or CPNAME, in bytes; numeric names count as 0 bytes.
• max_parameters_per_command C Field — Largest number of parameters of one command, in definitions and in a received S2F41.
• max_total_identifier_bytes C Field — Largest sum of the ASCII name lengths of all configured commands and parameters, in bytes.
• max_total_parameters C Field — Largest number of parameter definitions across all commands.
• reserved C Field — Reserved; must be 0.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGemCommandOptions) or larger.
• version C Field — Options version; must be #PDCOMM_GEM_COMMAND_OPTIONS_VERSION.
• PdcommGemCommandParameter C Struct — One CPNAME/CPVAL pair to send with pdcomm_gem_host_remote_command() or pdcomm_gem_host_enhanced_remote_command().
• name C Field — CPNAME item (ASCII or integer scalar); must not be NULL.
• value C Field — CPVAL (or CEPVAL) item, sent as a copy; must not be NULL.
• PdcommGemCommandParameterDefinition C Struct — Definition of one remote command parameter (CPNAME and its CPVAL rules).
• format C Field — Exact SECS-II format code required for the CPVAL item.
• format_present C Field — 1 when format is enforced, otherwise 0.
• max_count C Field — Largest allowed element count of the CPVAL item; must not be less than min_count.
• maximum C Field — Inclusive upper bound for every integer element; read only when maximum_present is 1.
• maximum_present C Field — 1 when maximum is enforced; requires an integer format.
• min_count C Field — Smallest allowed element count of the CPVAL item (bytes for ASCII and Binary).
• minimum C Field — Inclusive lower bound for every integer element; read only when minimum_present is 1.
• minimum_present C Field — 1 when minimum is enforced; requires an integer format.
• name C Field — CPNAME item (ASCII or integer scalar); borrowed for the call and must not be NULL.
• required C Field — 1 when the parameter must be present in the request, otherwise 0.
• PdcommGemCommandParameterInfo C Struct — Definition of one stored command parameter.
• format C Field — Required SECS-II format code; 0 when format_present is 0.
• format_present C Field — 1 when format is enforced.
• max_count C Field — Largest allowed element count of the CPVAL item.
• maximum C Field — Inclusive upper bound; 0 when maximum_present is 0.
• maximum_present C Field — 1 when maximum is enforced.
• min_count C Field — Smallest allowed element count of the CPVAL item.
• minimum C Field — Inclusive lower bound; 0 when minimum_present is 0.
• minimum_present C Field — 1 when minimum is enforced.
• required C Field — 1 when the parameter is required.
• struct_size C Field — Structure size; set to sizeof(PdcommGemCommandParameterInfo) or larger, receives the size written.
• PdcommGemCommandReply C Struct — Outcome of a sent S2F42 or S2F50 response.
• acknowledgement C Field — HCACK actually sent.
• completion_event C Field — Completion CEID to report after the work completes; 0 when completion_event_present is 0.
• completion_event_present C Field — 1 when the sent HCACK was 0 or 4 and the command has a completion CEID.
• struct_size C Field — Structure size; set to sizeof(PdcommGemCommandReply) or larger, receives the size written.
• PdcommGemCommandResultInfo C Struct — Summary of a remote command result, filled by pdcomm_gem_result_command_info().
• completion_event C Field — Completion CEID of an accepted request; 0 when completion_event_present is 0.
• completion_event_present C Field — 1 when an accepted request has a completion CEID.
• is_request C Field — 1 for an Equipment-received S2F41 request, 0 for a Host-received S2F42 reply.
• issue_count C Field — Number of frozen validation issues of a request, or of received CPACK entries of a reply.
• parameter_count C Field — Number of CPNAME/CPVAL pairs of a received request; 0 for a reply.
• responded C Field — 1 after pdcomm_gem_equipment_respond_command() sent S2F42 for the request.
• struct_size C Field — Structure size; set to sizeof(PdcommGemCommandResultInfo) or larger, receives the size written.
• validation_accepted C Field — 1 when the request passed validation at receipt; always 0 for a reply.
• validation_acknowledgement C Field — HCACK frozen at receipt for a request (0 when accepted), or the received HCACK of a reply.
• PdcommGemCommandState C Struct — Summary of the command store, filled by pdcomm_gem_equipment_command_state().
• command_count C Field — Number of configured commands.
• identifier_bytes C Field — Sum of the ASCII name lengths of all commands and parameters, in bytes.
• struct_size C Field — Structure size; set to sizeof(PdcommGemCommandState) or larger, receives the size written.
• total_parameters C Field — Number of parameter definitions across all commands.
• PdcommGemConstantChange C Struct — One ECID/ECV pair for pdcomm_gem_host_change_constants().
• id C Field — Constant ID (ECID): an ASCII item or a single-element integer item.
• value C Field — New value (ECV).
• PdcommGemConstantChangeInfo C Struct — Receipt and decision state of an S2F15 result, filled by pdcomm_gem_result_constant_change_info().
• applied C Field — 1 when an EAC 0 reply with at least one pair swapped in the new values.
• change_count C Field — Number of ECID/ECV pairs in the received S2F15; 0 for an S2F16 reply result.
• is_request C Field — 1 for a received S2F15 on an Equipment; 0 for an S2F16 reply received by a Host.
• responded C Field — 1 after pdcomm_gem_equipment_respond_constants() sent S2F16.
• struct_size C Field — Structure size in bytes; set before the call, receives the size written.
• validation_accepted C Field — 1 when every pair passed receipt validation against the constant store.
• validation_acknowledgement C Field — EAC from receipt validation: 0 accepted, 1 unknown ECID, 3 invalid value or format.
• PdcommGemConstantDefinition C Struct — Definition of one equipment constant for pdcomm_gem_equipment_configure_constants().
• current C Field — Current value (ECV).
• default_value C Field — Optional default value (ECDEF); NULL means absent.
• id C Field — Constant ID (ECID): an ASCII item or a single-element integer item.
• max_count C Field — Largest allowed element count; must be at least min_count.
• maximum C Field — Optional maximum value (ECMAX); NULL means absent.
• min_count C Field — Smallest allowed element count of current, default, and new values.
• minimum C Field — Optional minimum value (ECMIN); NULL means absent.
• name C Field — Name as ASCII bytes, not NUL-terminated.
• name_length C Field — Number of bytes at name.
• units C Field — Units as ASCII bytes, not NUL-terminated.
• units_length C Field — Number of bytes at units.
• PdcommGemConstantInfo C Struct — Definition summary of one constant, filled by pdcomm_gem_equipment_constant_at().
• default_present C Field — 1 when a default value is defined, else 0.
• format C Field — Format code of the current value.
• max_count C Field — Largest allowed element count.
• maximum_present C Field — 1 when a maximum value is defined, else 0.
• min_count C Field — Smallest allowed element count.
• minimum_present C Field — 1 when a minimum value is defined, else 0.
• struct_size C Field — Structure size in bytes; set before the call, receives the size written.
• PdcommGemConstantOptions C Struct — Limits of an Equipment constant store.
• item_limits C Field — SECS-II limits for each stored value; every field must be nonzero.
• max_changes_per_request C Field — Largest number of ECID/ECV pairs accepted in one incoming S2F15.
• max_constants C Field — Largest number of constants; must be at least 1.
• max_identifier_bytes C Field — Largest ASCII ECID length in bytes, for definitions and incoming requests.
• max_metadata_bytes C Field — Largest total of ASCII ID, name, and units bytes across all constants.
• max_query_ids C Field — Largest number of ECIDs accepted in one incoming S2F13 or S2F29.
• max_value_bytes C Field — Largest total encoded size of current, default, minimum, and maximum values; must be at least 1.
• reserved C Field — Must be 0.
• struct_size C Field — Structure size in bytes; set to sizeof(PdcommGemConstantOptions) or larger.
• version C Field — Must be #PDCOMM_GEM_CONSTANT_OPTIONS_VERSION.
• PdcommGemConstantReply C Struct — Reply that pdcomm_gem_equipment_respond_constants() sent.
• acknowledgement C Field — EAC sent in S2F16 (0 on failure).
• applied C Field — 1 when the new values were applied to the store, else 0.
• struct_size C Field — Structure size in bytes; set before the call, receives the size written.
• PdcommGemConstantState C Struct — Counters of the constant store, filled by pdcomm_gem_equipment_constant_state().
• constant_count C Field — Number of constants.
• metadata_bytes C Field — Total ASCII ID, name, and units bytes.
• struct_size C Field — Structure size in bytes; set before the call, receives the size written.
• value_bytes C Field — Total encoded size of all stored values.
• PdcommGemDataDefinition C Struct — Definition of one data variable for pdcomm_gem_equipment_configure_data_variables().
• cached C Field — Optional initial cached value, copied; NULL leaves the cache empty.
• format C Field — Required top-level format of every value, one of the PDCOMM_SECS_* format codes (List included).
• id C Field — Data variable ID (DVID); unique within the store.
• max_count C Field — Largest allowed element count; must be at least min_count.
• min_count C Field — Smallest allowed element count (List children or primitive elements).
• name C Field — Name as ASCII bytes, not NUL-terminated.
• name_length C Field — Number of bytes at name.
• units C Field — Units as ASCII bytes, not NUL-terminated.
• units_length C Field — Number of bytes at units.
• PdcommGemDataInfo C Struct — Definition summary of one data variable, filled by pdcomm_gem_equipment_data_at().
• cached_present C Field — 1 when a value is cached, else 0.
• format C Field — Declared format code.
• id C Field — Data variable ID (DVID).
• max_count C Field — Largest allowed element count.
• min_count C Field — Smallest allowed element count.
• struct_size C Field — Structure size in bytes; set before the call, receives the size written.
• PdcommGemDataOptions C Struct — Limits of an Equipment data variable store.
• item_limits C Field — SECS-II limits for each cached value and sample; every field must be nonzero.
• max_metadata_bytes C Field — Largest total of name and units bytes across all variables.
• max_sample_bytes C Field — Largest total encoded size of the samples supplied with one call, in bytes.
• max_samples_per_event C Field — Largest number of samples supplied with one publication or query response.
• max_value_bytes C Field — Largest total encoded size of all cached values, in bytes.
• max_variables C Field — Largest number of data variables; must be at least 1.
• reserved C Field — Must be 0.
• struct_size C Field — Structure size in bytes; set to sizeof(PdcommGemDataOptions) or larger.
• version C Field — Must be #PDCOMM_GEM_DATA_OPTIONS_VERSION.
• PdcommGemDataSample C Struct — A data variable value sampled for one publication or query response.
• id C Field — Data variable ID (DVID), not the report VID.
• value C Field — Sampled value; borrowed for the call and never stored in the cache.
• PdcommGemDataState C Struct — Counters of the data variable store, filled by pdcomm_gem_equipment_data_state().
• metadata_bytes C Field — Total name and units bytes.
• struct_size C Field — Structure size in bytes; set before the call, receives the size written.
• value_bytes C Field — Total encoded size of the cached values.
• variable_count C Field — Number of data variables.
• PdcommGemDirectoryEntryInfo C Struct — One directory entry, filled by the *_directory_at functions.
• id C Field — VID for a data variable entry, CEID for an event entry.
• struct_size C Field — Structure size in bytes; set before the call, receives the size written.
• variable_count C Field — Number of VIDs of an event entry; 0 for a data variable entry.
• PdcommGemDirectoryOptions C Struct — Limits of an Equipment event directory.
• max_events C Field — Largest number of event entries.
• max_metadata_bytes C Field — Largest total of name bytes across all entries.
• max_name_bytes C Field — Largest name of one entry, in bytes.
• max_total_variables C Field — Largest total number of VIDs across all entries.
• max_variables_per_event C Field — Largest number of VIDs in one entry.
• reserved C Field — Must be 0.
• struct_size C Field — Structure size in bytes; set to sizeof(PdcommGemDirectoryOptions) or larger.
• version C Field — Must be #PDCOMM_GEM_DIRECTORY_OPTIONS_VERSION.
• PdcommGemDirectoryState C Struct — Counters of the event directory, filled by pdcomm_gem_equipment_directory_state().
• configured C Field — 1 when a directory is configured (possibly empty), else 0.
• event_count C Field — Number of event entries.
• metadata_bytes C Field — Total name bytes.
• struct_size C Field — Structure size in bytes; set before the call, receives the size written.
• total_variables C Field — Total number of VIDs across all entries.
• PdcommGemEnhancedCommandOptions C Struct — Limits for the enhanced command store, passed to pdcomm_gem_equipment_configure_enhanced_commands().
• item_limits C Field — SECS-II limits applied to each received CEPVAL item.
• max_commands_per_object C Field — Largest number of commands of one object.
• max_errors C Field — Largest number of nonzero CEPACK values in a frozen validation or an application response.
• max_identifier_bytes C Field — Largest length of one ASCII RCMD or CPNAME, in bytes; numeric names count as 0 bytes.
• max_object_bytes C Field — Largest length of one object name, in bytes, in definitions and in a received S2F49.
• max_objects C Field — Largest number of objects (OBJSPEC values).
• max_parameters_per_command C Field — Largest number of parameters of one command, in definitions and in a received S2F49.
• max_request_value_bytes C Field — Largest sum of the encoded CEPVAL sizes of one received S2F49, in bytes.
• max_total_commands C Field — Largest number of commands across all objects.
• max_total_identifier_bytes C Field — Largest sum of the ASCII name lengths of all configured commands and parameters, in bytes.
• max_total_object_bytes C Field — Largest sum of the lengths of all object names, in bytes.
• max_total_parameters C Field — Largest number of parameter definitions across all commands.
• reserved C Field — Reserved; must be 0.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGemEnhancedCommandOptions) or larger.
• version C Field — Options version; must be #PDCOMM_GEM_ENHANCED_COMMAND_OPTIONS_VERSION.
• PdcommGemEnhancedCommandResultInfo C Struct — Summary of an enhanced command result, filled by pdcomm_gem_result_enhanced_command_info().
• completion_event C Field — Completion CEID of an accepted request; 0 when completion_event_present is 0.
• completion_event_present C Field — 1 when an accepted request has a completion CEID.
• data_id C Field — DATAID of a received request; 0 for a reply.
• is_request C Field — 1 for an Equipment-received S2F49 request, 0 for a Host-received S2F50 reply.
• issue_count C Field — Number of outer acknowledgement entries: frozen errors of a request (0 when accepted), or received entries of a reply.
• parameter_count C Field — Number of CPNAME/CEPVAL pairs of a received request; 0 for a reply.
• responded C Field — 1 after pdcomm_gem_equipment_respond_enhanced_command() sent S2F50 for the request.
• struct_size C Field — Structure size; set to sizeof(PdcommGemEnhancedCommandResultInfo) or larger, receives the size written.
• validation_accepted C Field — 1 when the request passed admission at receipt; always 0 for a reply.
• validation_acknowledgement C Field — HCACK frozen at receipt for a request (0 when accepted), or the received HCACK of a reply.
• PdcommGemEnhancedCommandState C Struct — Summary of the enhanced command store, filled by pdcomm_gem_equipment_enhanced_command_state().
• command_count C Field — Number of commands across all objects.
• identifier_bytes C Field — Sum of the ASCII name lengths of all commands and parameters, in bytes.
• object_count C Field — Number of configured objects.
• struct_size C Field — Structure size; set to sizeof(PdcommGemEnhancedCommandState) or larger, receives the size written.
• total_object_bytes C Field — Sum of the lengths of all object names, in bytes.
• total_parameters C Field — Number of parameter definitions across all commands.
• PdcommGemEnhancedObjectDefinition C Struct — Definition of one object (OBJSPEC) and its commands.
• commands C Field — Array of count command definitions; may be NULL when count is 0.
• count C Field — Number of command definitions; RCMD names must be unique within the object.
• name C Field — Object name: an ASCII item, possibly empty; must not be NULL and must be unique.
• PdcommGemEnhancedObjectInfo C Struct — Summary of one stored object, filled by pdcomm_gem_equipment_enhanced_object_at().
• command_count C Field — Number of commands of the object.
• struct_size C Field — Structure size; set to sizeof(PdcommGemEnhancedObjectInfo) or larger, receives the size written.
• PdcommGemEquipmentOptions C Struct — Options for pdcomm_gem_configure_equipment().
• initial_control C Field — Initial control state.
• item_limits C Field — SECS-II limits for every message the equipment builds or parses.
• max_metadata_bytes C Field — Largest total size in bytes of all registered status variable names and units; may be 0.
• max_value_bytes C Field — Largest total encoded size in bytes of all registered status variable values; must be nonzero.
• max_variables C Field — Largest number of registered status variables; must be nonzero.
• model C Field — Equipment model type (MDLN) as ASCII bytes, without a terminator; may be NULL when model_length is 0.
• model_length C Field — Number of bytes at model.
• online_mode C Field — Online mode, #PDCOMM_GEM_LOCAL or #PDCOMM_GEM_REMOTE: the ON-LINE substate entered when going on-line.
• reserved C Field — Reserved; must be 0.
• software_revision C Field — Software revision (SOFTREV) as ASCII bytes, without a terminator; may be NULL when software_revision_length is 0.
• software_revision_length C Field — Number of bytes at software_revision.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGemEquipmentOptions) or larger.
• version C Field — Options version; must be #PDCOMM_GEM_OPTIONS_VERSION.
• PdcommGemEventDefinition C Struct — One collection event entry for pdcomm_gem_equipment_configure_event_directory().
• id C Field — Collection event ID (CEID); unique and registered in the report store.
• name C Field — Event name (CENAME) as ASCII bytes, not NUL-terminated; may be empty.
• name_length C Field — Number of bytes at name.
• variable_count C Field — Number of elements in variable_ids.
• variable_ids C Field — Array of variable_count unique VIDs; each must be bound to a data variable.
• PdcommGemEventInfo C Struct — Header of a received event report (S6F11), filled by pdcomm_gem_result_event_info().
• acknowledged C Field — 1 after pdcomm_gem_host_acknowledge_event() sent S6F12 for this result, otherwise 0.
• data_id C Field — DATAID of the report message.
• event_id C Field — Collection event ID (CEID) that was reported.
• report_count C Field — Number of reports in the message.
• struct_size C Field — Structure size in bytes.
• PdcommGemFixedEventSpec C Struct — One collection event of a fixed report catalog.
• count C Field — Number of elements in report_ids; 0 registers the event without links.
• enabled C Field — 1 to enable the event report initially, 0 to leave it disabled.
• event_id C Field — Collection event ID (CEID).
• report_ids C Field — Array of count report IDs linked to the event.
• PdcommGemFormattedProgramCapabilityCommand C Struct — One command definition passed to pdcomm_gem_formatted_program_capability_catalog_replace().
• after_dependency C Field — ACDS: the single U2 value sent as the after-command field.
• before_dependencies C Field — BCDS values; stored and sent verbatim.
• before_dependency_count C Field — Number of values in before_dependencies.
• block_definition C Field — BLKDEF block definition: +1, 0, or -1 as defined by SEMI E5.
• code C Field — CCODE command code: ASCII bytes, at most max_command_code_bytes long.
• code_length C Field — Length of code in bytes.
• immediate_after_dependencies C Field — IACDS values; stored and sent verbatim.
• immediate_after_dependency_count C Field — Number of values in immediate_after_dependencies.
• immediate_before_dependencies C Field — IBCDS values; stored and sent verbatim.
• immediate_before_dependency_count C Field — Number of values in immediate_before_dependencies.
• name C Field — CNAME command name: ASCII bytes, at most 16 long.
• name_length C Field — Length of name in bytes.
• non_after_dependencies C Field — NACDS values; stored and sent verbatim.
• non_after_dependency_count C Field — Number of values in non_after_dependencies.
• non_before_dependencies C Field — NBCDS values; stored and sent verbatim.
• non_before_dependency_count C Field — Number of values in non_before_dependencies.
• parameter_count C Field — Number of handles in parameters.
• parameters C Field — Parameter descriptors as live SECS-II item handles.
• required C Field — RQCMD: 1 when the command is required in every program, 0 otherwise.
• reserved C Field — Reserved; all bytes must be 0.
• PdcommGemFormattedProgramCapabilityCommandInfo C Struct — Fixed-size fields of one capability command, filled by pdcomm_gem_result_formatted_program_capability_command_info().
• after_dependency C Field — ACDS value.
• before_dependency_count C Field — Number of BCDS values.
• block_definition C Field — BLKDEF block definition: +1, 0, or -1.
• immediate_after_dependency_count C Field — Number of IACDS values.
• immediate_before_dependency_count C Field — Number of IBCDS values.
• non_after_dependency_count C Field — Number of NACDS values.
• non_before_dependency_count C Field — Number of NBCDS values.
• parameter_count C Field — Number of parameter descriptors.
• required C Field — RQCMD: 1 when the command is required.
• reserved C Field — Reserved; written as 0.
• struct_size C Field — Structure size; set to sizeof(PdcommGemFormattedProgramCapabilityCommandInfo) or larger.
• PdcommGemFormattedProgramCapabilityInfo C Struct — Summary of a capability result, filled by pdcomm_gem_result_formatted_program_capability_info().
• byte_maximum C Field — BYTMAX: maximum process program size in bytes; 0 when the result holds no capability.
• command_count C Field — Number of commands in the capability; 0 when the result holds no capability.
• command_maximum C Field — CMDMAX: maximum number of commands in a process program; 0 when the result holds no capability.
• is_request C Field — 1 when the result is a received S7F21 request (equipment side), 0 for host data results.
• reply_ready C Field — 1 when the result is a received request that still needs pdcomm_gem_formatted_program_capability_respond().
• request_kind C Field — GEM request kind copied from the result, normally #PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_SEND.
• reserved C Field — Reserved; written as 0.
• responded C Field — 1 when S7F22 has been sent for a received request, or for a host data result.
• struct_size C Field — Structure size; set to sizeof(PdcommGemFormattedProgramCapabilityInfo) or larger.
• PdcommGemFormattedProgramCapabilityOptions C Struct — Limits for the formatted program capability service.
• max_capability_bytes C Field — Largest encoded size of the whole S7F22 capability body, in bytes.
• max_command_code_bytes C Field — Largest CCODE (command code) length in bytes.
• max_commands C Field — Largest number of commands in one capability.
• max_dependencies_per_field C Field — Largest number of values in one dependency vector (BCDS, IBCDS, NBCDS, IACDS, or NACDS).
• max_history C Field — Number of finished transactions remembered for replay detection; must be nonzero.
• max_parameters_per_command C Field — Largest number of parameter descriptors in one command.
• max_pending C Field — Largest number of S7F21 requests the host can have outstanding; must be nonzero.
• max_received C Field — Largest number of received S7F21 requests the equipment can hold unanswered; must be nonzero.
• max_results C Field — Number of completed host results the service retains; must be nonzero.
• max_total_dependencies C Field — Largest number of dependency values across all commands; each command's ACDS value counts as one.
• max_total_parameter_bytes C Field — Largest total encoded size of all parameter descriptors, in bytes.
• max_total_parameters C Field — Largest number of parameter descriptors across all commands.
• reserved C Field — Reserved; must be 0.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGemFormattedProgramCapabilityOptions) or larger.
• version C Field — Must be #PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_OPTIONS_VERSION.
• PdcommGemFormattedProgramDryRunInfo C Struct — Summary of a dry-run report, filled by pdcomm_gem_formatted_program_dry_run_info().
• capability_present C Field — 1 when a capability catalog was installed at analysis time.
• capability_revision C Field — Capability catalog revision at analysis time (0 when capabilities are not configured).
• command_count C Field — Number of commands in the program.
• encoded_bytes C Field — Encoded size of the program body (PPID, MDLN, SOFTREV, and commands) in bytes.
• endpoint_id C Field — Identifier of the endpoint that produced the report.
• entry_generation C Field — Store entry generation captured by the selection.
• id_format C Field — SECS-II format code of the program identifier (#PDCOMM_SECS_ASCII or #PDCOMM_SECS_BINARY).
• issue_count C Field — Number of issues in the report.
• outcome C Field — Overall outcome: a PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_* outcome value.
• policy_version C Field — Policy version used for the analysis.
• reserved C Field — Input: must be zero; written as zero.
• selection_generation C Field — Selection generation of the analyzed selection token.
• session_generation C Field — HSMS session generation of the analyzed selection.
• store_revision C Field — Program store revision captured by the selection.
• struct_size C Field — Input: size of this structure, at least sizeof(PdcommGemFormattedProgramDryRunInfo).
• version C Field — Input: must be #PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_INFO_VERSION.
• PdcommGemFormattedProgramDryRunIssueInfo C Struct — One dry-run issue, filled by pdcomm_gem_formatted_program_dry_run_issue_info().
• code C Field — Issue code, one of the PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_* issue codes (1 to 11).
• command_index C Field — Program or catalog command index, as described by the issue code.
• expected C Field — Expected limit (CMDMAX or BYTMAX), as described by the issue code.
• field_index C Field — Field index within the command; not used by policy version 1.
• observed C Field — Observed count or size, as described by the issue code.
• outcome C Field — Outcome contributed by this issue (indeterminate or reject).
• presence_mask C Field — Bit set of PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_ISSUE_*_PRESENT flags.
• reserved C Field — Input: must be 0; written as 0.
• struct_size C Field — Input: size of this structure, at least sizeof(PdcommGemFormattedProgramDryRunIssueInfo).
• version C Field — Input: must be #PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_ISSUE_INFO_VERSION.
• PdcommGemFormattedProgramDryRunOptions C Struct — Options for pdcomm_gem_formatted_program_dry_run().
• max_issues C Field — Largest number of issues the report may hold; more issues fail the call with #PDCOMM_LIMIT_EXCEEDED.
• max_program_encoded_bytes C Field — Largest encoded program size in bytes; a larger program fails the call with #PDCOMM_LIMIT_EXCEEDED.
• policy_version C Field — Analysis policy; must be #PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_POLICY_V1.
• reserved C Field — Reserved; must be 0.
• reserved2 C Field — Reserved; must be 0.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGemFormattedProgramDryRunOptions) or larger.
• version C Field — Must be #PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_OPTIONS_VERSION.
• PdcommGemFormattedProgramDryRunReportHandle C Typedef — Opaque, immutable dry-run report.
• PdcommGemFormattedProgramExecutionActionHandle C Typedef — Opaque, immutable copy of one execution action.
• PdcommGemFormattedProgramExecutionActionInfo C Struct — Description of an action, filled by pdcomm_gem_formatted_program_execution_action_info().
• action_sequence C Field — Action sequence number; copy into the action token.
• cancel_next_command_index C Field — Cancel only: index of the first command that was not applied.
• capability_revision C Field — Start only: capability catalog revision of the admitting dry run.
• code_format C Field — Step only: SECS-II format code of the command code (#PDCOMM_SECS_ASCII, #PDCOMM_SECS_U1, #PDCOMM_SECS_U2, #PDCOMM_SECS_U4, or #PDCOMM_SECS_U8).
• command_count C Field — Number of commands in the program, for every kind.
• command_index C Field — Step only: zero-based index of the command to apply.
• dry_run_outcome C Field — Start only: outcome of the admitting dry run.
• endpoint_id C Field — Endpoint identifier; copy into the action token.
• execution_generation C Field — Execution generation; copy into the action token.
• id_format C Field — Start only: SECS-II format code of the program identifier.
• kind C Field — Action kind: START, STEP, or CANCEL.
• parameter_count C Field — Step only: number of parameters of the command.
• policy_version C Field — Start only: dry-run policy version.
• presence_mask C Field — Bit set of action presence flags.
• reserved C Field — Input: must be zero; written as zero.
• session_generation C Field — HSMS session generation; copy into the action token.
• struct_size C Field — Input: size of this structure, at least sizeof(PdcommGemFormattedProgramExecutionActionInfo).
• version C Field — Input: must be #PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_INFO_VERSION.
• PdcommGemFormattedProgramExecutionActionToken C Struct — Identifies one action of an execution.
• action_sequence C Field — Action sequence number: 1 for Start, then increasing for each new Step or Cancel.
• endpoint_id C Field — Endpoint identifier of the execution.
• execution_generation C Field — Execution generation of the execution.
• kind C Field — Action kind: START, STEP, or CANCEL.
• reserved C Field — Reserved; must be 0.
• session_generation C Field — HSMS session generation of the execution.
• struct_size C Field — Size of this structure; set to sizeof(PdcommGemFormattedProgramExecutionActionToken) or larger.
• version C Field — Must be #PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_TOKEN_VERSION.
• PdcommGemFormattedProgramExecutionInfo C Struct — State of the endpoint's execution, filled by pdcomm_gem_formatted_program_execution_snapshot_info().
• application_detail_length C Field — Length of the terminal report's detail bytes, or 0.
• application_report_id C Field — Application-defined identifier of the recorded terminal report, or 0.
• application_report_kind C Field — Kind of the recorded terminal report (a TERMINAL_* value), or 0 when none was recorded.
• capability_present C Field — 1 when a capability catalog was installed at dry-run time.
• capability_revision C Field — Capability catalog revision of the admitting dry run.
• command_count C Field — Number of commands in the executed program.
• dry_run_outcome C Field — Outcome of the admitting dry run (PASS or INDETERMINATE); 0 in the EMPTY state.
• endpoint_id C Field — Endpoint identifier from the execution token.
• entry_generation C Field — Store entry generation captured by the admitted selection.
• execution_generation C Field — Execution generation from the execution token.
• id_format C Field — SECS-II format code of the program identifier (#PDCOMM_SECS_ASCII or #PDCOMM_SECS_BINARY); 0 in the EMPTY state.
• next_command_index C Field — Number of commands applied so far, which is also the index of the next command.
• pending_action_sequence C Field — Sequence number of the pending action, or 0.
• pending_kind C Field — Kind of the pending action, or #PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_NONE.
• policy_version C Field — Dry-run policy version of the admitting report; 0 in the EMPTY state.
• presence_mask C Field — Bit set of snapshot presence flags.
• reserved C Field — Input: must be zero; written as zero.
• selection_generation C Field — Selection generation of the admitted selection.
• session_generation C Field — HSMS session generation from the execution token.
• state C Field — Execution state, a PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_* state value.
• store_revision C Field — Program store revision captured by the admitted selection.
• struct_size C Field — Input: size of this structure, at least sizeof(PdcommGemFormattedProgramExecutionInfo).
• version C Field — Input: must be #PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_INFO_VERSION.
• PdcommGemFormattedProgramExecutionSnapshotHandle C Typedef — Opaque, immutable snapshot of the endpoint's execution state.
• PdcommGemFormattedProgramExecutionToken C Struct — Identifies one execution on one endpoint.
• endpoint_id C Field — Identifier of the endpoint that started the execution.
• execution_generation C Field — Execution generation; increases by one for each started execution.
• reserved C Field — Reserved; must be 0.
• session_generation C Field — HSMS session generation at start.
• struct_size C Field — Size of this structure; set to sizeof(PdcommGemFormattedProgramExecutionToken) or larger.
• version C Field — Must be #PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_TOKEN_VERSION.
• PdcommGemFormattedProgramInfo C Struct — Summary of a verification report result, filled by pdcomm_gem_result_formatted_program_info().
• id_format C Field — Format of the PPID: #PDCOMM_SECS_ASCII or #PDCOMM_SECS_BINARY; 0 when the result has no report.
• is_request C Field — 1 when the result is a received S7F27 primary (host side), 0 for an S7F28 acknowledge.
• issue_count C Field — Number of issues in the received report; 0 for an S7F28 acknowledge result.
• reply_ready C Field — 1 when the result is an S7F27 primary that still needs pdcomm_gem_formatted_program_respond().
• request_kind C Field — GEM request kind, #PDCOMM_GEM_FORMATTED_PROGRAM_SEND for these results.
• responded C Field — 1 when S7F28 has been sent for this primary, or the result is itself an acknowledge.
• struct_size C Field — Structure size; set it to at least sizeof(PdcommGemFormattedProgramInfo).
• PdcommGemFormattedProgramIssue C Struct — One verification issue of an S7F27 report.
• code C Field — ACKC7A code, from 0 to 5.
• length C Field — Length of text in bytes.
• sequence C Field — SEQNUM: the number of the process program command the issue refers to; sent as U4.
• text C Field — ERRW7 text as ASCII bytes, not NUL-terminated.
• PdcommGemFormattedProgramOptions C Struct — Limits for the S7F27/S7F28 verification report service.
• max_history C Field — Number of completed transactions remembered to reject replays; the oldest is discarded first.
• max_issue_text_bytes C Field — Largest ERRW7 text of a single issue, in bytes.
• max_issues C Field — Largest number of issues in one S7F27 report; 0 allows only reports without issues.
• max_pending C Field — Largest number of sent S7F27 reports awaiting S7F28; must be nonzero.
• max_received C Field — Largest number of received S7F27 reports awaiting a reply; must be nonzero.
• max_results C Field — Number of completed report outcomes the service retains; the oldest is discarded first.
• max_total_issue_text_bytes C Field — Largest sum of all ERRW7 text lengths in one report, in bytes.
• reserved C Field — Reserved; must be 0.
• struct_size C Field — Size of this structure in bytes; at least sizeof(PdcommGemFormattedProgramOptions).
• version C Field — Options layout version; must be #PDCOMM_GEM_FORMATTED_PROGRAM_OPTIONS_VERSION.
• PdcommGemFormattedProgramQueryCommand C Struct — One process command (CCODE and PPARM list) passed to pdcomm_gem_formatted_program_query_seed().
• code C Field — CCODE item; must be a non-NULL ASCII item.
• parameter_count C Field — Number of PPARM items in parameters.
• parameters C Field — Array of parameter_count PPARM items of any format; NULL when the count is 0.
• PdcommGemFormattedProgramQueryInfo C Struct — Summary of a query result, filled by pdcomm_gem_result_formatted_program_query_info().
• command_count C Field — Number of process commands in the returned program; 0 when no program is present.
• id_format C Field — Format of the requested PPID, #PDCOMM_SECS_ASCII or #PDCOMM_SECS_BINARY.
• is_request C Field — 1 when the result is a received S7F25 primary (equipment side), 0 for an S7F26 result.
• present C Field — 1 when the answer contains the program; 0 when it is absent or not yet known.
• present_known C Field — 1 when the answer is known: always for an S7F26 result, and after the reply for a received S7F25.
• reply_ready C Field — 1 when the result is an S7F25 primary that still needs pdcomm_gem_formatted_program_query_respond().
• request_kind C Field — GEM request kind, #PDCOMM_GEM_FORMATTED_PROGRAM_QUERY_SEND for these results.
• reserved C Field — Reserved; written as zero.
• responded C Field — 1 when S7F26 has been sent for this primary, or the result is itself an S7F26.
• struct_size C Field — Structure size; set it to at least sizeof(PdcommGemFormattedProgramQueryInfo).
• PdcommGemFormattedProgramQueryOptions C Struct — Limits for the S7F25/S7F26 service and the Equipment program store.
• max_catalog_entries C Field — Largest number of programs in the store.
• max_catalog_identifier_bytes C Field — Largest sum of the PPID lengths of all stored programs, in bytes.
• max_commands C Field — Largest number of process commands in one program; must be below SIZE_MAX - 1.
• max_history C Field — Number of completed transactions remembered to reject replays; the oldest is discarded first.
• max_parameters_per_command C Field — Largest number of PPARM items in one command.
• max_pending C Field — Largest number of sent S7F25 requests awaiting S7F26; must be nonzero.
• max_received C Field — Largest number of received S7F25 requests awaiting a reply; must be nonzero.
• max_results C Field — Number of completed query outcomes the service retains; the oldest is discarded first.
• max_total_parameter_bytes C Field — Largest sum of the encoded sizes of all PPARM items in one program, in bytes.
• max_total_parameters C Field — Largest number of PPARM items in one program.
• reserved C Field — Reserved; must be 0.
• struct_size C Field — Size of this structure in bytes; at least sizeof(PdcommGemFormattedProgramQueryOptions).
• version C Field — Options layout version; must be #PDCOMM_GEM_FORMATTED_PROGRAM_QUERY_OPTIONS_VERSION.
• PdcommGemFormattedProgramSelectionInfo C Struct — Summary of a selection snapshot, filled by pdcomm_gem_formatted_program_selection_snapshot_info().
• command_count C Field — Number of process commands in the selected program; 0 when none is selected.
• entry_generation C Field — Entry generation captured at selection; 0 when no program is selected.
• id_format C Field — PPID format, #PDCOMM_SECS_ASCII or #PDCOMM_SECS_BINARY; 0 when no program is selected.
• reserved C Field — Reserved; all bytes must be 0 before the call and are written as zero.
• selection_generation C Field — Selection revision of the selection, or the current revision when no program is selected.
• session_generation C Field — Session generation of the selection; 0 when no program is selected.
• stale_reason C Field — For the STALE state, one of the reasons 1 to 4; otherwise #PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE_NONE.
• state C Field — Selection state: #PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_EMPTY, _READY, or _STALE.
• store_revision C Field — Store revision captured at selection; 0 when no program is selected.
• struct_size C Field — Structure size; set it to at least sizeof(PdcommGemFormattedProgramSelectionInfo).
• valid_for_execution C Field — 1 when the state was READY at snapshot time.
• version C Field — Set to #PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_INFO_VERSION before the call.
• PdcommGemFormattedProgramSelectionSnapshot C Typedef — Opaque, immutable, owned copy of the selection state and program.
• PdcommGemFormattedProgramSelectionToken C Struct — Identity of one selection, returned by pdcomm_gem_formatted_program_select().
• endpoint_id C Field — Identity of the endpoint that made the selection.
• entry_generation C Field — Generation of the selected store entry at the time of selection.
• reserved C Field — Set to 0.
• selection_generation C Field — Selection revision; increases with every new selection and every clear.
• session_generation C Field — HSMS session generation in which the selection was made.
• store_revision C Field — Store revision at the time of selection.
• struct_size C Field — Structure size; set it to at least sizeof(PdcommGemFormattedProgramSelectionToken).
• version C Field — Set to #PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_TOKEN_VERSION.
• PdcommGemFormattedProgramStoreCommand C Struct — One process command (CCODE and PPARM list) passed to pdcomm_gem_formatted_program_store_put().
• code C Field — CCODE item: ASCII, or a single-element U1, U2, U4, or U8 item.
• parameter_count C Field — Number of PPARM items in parameters.
• parameters C Field — Array of parameter_count PPARM items of any format; NULL when the count is 0.
• PdcommGemFormattedProgramStoreEntryInfo C Struct — Summary of one program in a store snapshot, filled by pdcomm_gem_formatted_program_store_entry_info().
• command_count C Field — Number of process commands in the program.
• id_format C Field — PPID format: #PDCOMM_SECS_ASCII or #PDCOMM_SECS_BINARY.
• reserved C Field — Set to 0 before the call.
• reserved_bytes C Field — Reserved; written as zero.
• struct_size C Field — Structure size; set it to at least sizeof(PdcommGemFormattedProgramStoreEntryInfo).
• version C Field — Set to #PDCOMM_GEM_FORMATTED_PROGRAM_STORE_INFO_VERSION before the call.
• PdcommGemFormattedProgramStoreInfo C Struct — Store totals and limits, filled by pdcomm_gem_formatted_program_store_info() and pdcomm_gem_formatted_program_store_snapshot_info().
• encoded_bytes C Field — Sum of the encoded S7F23 body sizes of all stored programs, in bytes.
• entry_count C Field — Number of stored programs.
• identifier_bytes C Field — Sum of the PPID lengths of all stored programs, in bytes.
• max_encoded_bytes C Field — Largest encoded_bytes: the endpoint's SECS-II message_bytes limit times max_entries.
• max_entries C Field — Largest number of programs; the query option max_catalog_entries.
• max_identifier_bytes C Field — Largest identifier_bytes; the query option max_catalog_identifier_bytes.
• reserved C Field — Set to 0 before the call.
• revision C Field — Store revision: 0 for a new store, increased by one for every change that alters the stored programs.
• struct_size C Field — Structure size; set it to at least sizeof(PdcommGemFormattedProgramStoreInfo).
• version C Field — Set to #PDCOMM_GEM_FORMATTED_PROGRAM_STORE_INFO_VERSION before the call.
• PdcommGemFormattedProgramStoreSnapshot C Typedef — Opaque, immutable, owned copy of the whole program store.
• PdcommGemFormattedProgramTransferCommand C Struct — One process command (CCODE and PPARM list) passed to pdcomm_gem_formatted_program_transfer_submit().
• code C Field — CCODE item; must be a non-NULL ASCII item for an outgoing S7F23.
• parameter_count C Field — Number of PPARM items in parameters.
• parameters C Field — Array of parameter_count PPARM items of any format; NULL when the count is 0.
• PdcommGemFormattedProgramTransferInfo C Struct — Summary of a transfer result, filled by pdcomm_gem_result_formatted_program_transfer_info().
• acknowledgement C Field — ACKC7 code: the code received in S7F24, or the code this side sent for a received S7F23.
• acknowledgement_present C Field — 1 when acknowledgement holds a code.
• command_count C Field — Number of process commands in the received program; 0 for an S7F24 result.
• id_format C Field — PPID format, #PDCOMM_SECS_ASCII or #PDCOMM_SECS_BINARY; 0 when the result carries no program.
• is_request C Field — 1 when the result is a received S7F23 primary (equipment side), 0 for an S7F24 result.
• reply_ready C Field — 1 when the result is an S7F23 primary that still needs an S7F24 reply.
• request_kind C Field — GEM request kind, #PDCOMM_GEM_FORMATTED_PROGRAM_TRANSFER_SEND for these results.
• reserved C Field — Reserved; written as zero.
• responded C Field — 1 when S7F24 has been sent for this primary, or the result is itself an S7F24.
• struct_size C Field — Structure size; set it to at least sizeof(PdcommGemFormattedProgramTransferInfo).
• PdcommGemFormattedProgramTransferOptions C Struct — Limits for the S7F23/S7F24 transfer service.
• max_commands C Field — Largest number of process commands in one program.
• max_history C Field — Number of completed transactions remembered to reject replays; the oldest is discarded first.
• max_parameters_per_command C Field — Largest number of PPARM items in one command.
• max_pending C Field — Largest number of sent S7F23 messages awaiting S7F24; must be nonzero.
• max_received C Field — Largest number of received S7F23 messages awaiting a reply; must be nonzero.
• max_results C Field — Number of completed transfer outcomes the service retains; the oldest is discarded first.
• max_total_parameter_bytes C Field — Largest sum of the encoded sizes of all PPARM items in one program, in bytes.
• max_total_parameters C Field — Largest number of PPARM items in one program.
• reserved C Field — Reserved; must be 0.
• struct_size C Field — Size of this structure in bytes; at least sizeof(PdcommGemFormattedProgramTransferOptions).
• version C Field — Options layout version; must be #PDCOMM_GEM_FORMATTED_PROGRAM_TRANSFER_OPTIONS_VERSION.
• PdcommGemFormattedProgramVerificationNegotiationInfo C Struct — Negotiation details of a GEM result, filled by pdcomm_gem_result_formatted_program_verification_negotiation_info().
• correlation C Field — Sequence number shared by every result of the same negotiation on this endpoint.
• length C Field — LENGTH: byte length of the S7F27 body, computed by the equipment or received by the host.
• negotiation_terminal C Field — Outcome of the S7F29/S7F30 exchange, a TERMINAL_* value.
• pp_gnt C Field — PPGNT grant code; valid only when pp_gnt_present is 1. 0 means granted.
• pp_gnt_present C Field — 1 when a PPGNT code was sent (host) or received (equipment).
• prepared C Field — 1 for equipment-side records, 0 for host-side S7F29 records.
• reply_ready C Field — 1 when the result is a host-side inquiry that still needs pdcomm_gem_formatted_program_verification_respond().
• request_kind C Field — GEM request kind copied from the result; see #PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_SEND.
• reserved C Field — Reserved; written as 0.
• responded C Field — 1 when the host has answered the inquiry with S7F30.
• state C Field — Record state, a PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_STATE_* value.
• struct_size C Field — Structure size; set to sizeof(PdcommGemFormattedProgramVerificationNegotiationInfo) or larger.
• submitted C Field — 1 when the equipment has sent the S7F29 inquiry for this negotiation.
• verification_terminal C Field — Outcome of the S7F27/S7F28 exchange after a grant, a TERMINAL_* value (GRANTED means acknowledged).
• PdcommGemFormattedProgramVerificationNegotiationIssue C Struct — One issue of the S7F27 report passed to pdcomm_gem_formatted_program_verification_prepare().
• code C Field — ACKC7A acknowledgement code, from 0 to 5 as defined by SEMI E5; other values are rejected.
• sequence C Field — SEQNUM: the process program command sequence number the issue refers to.
• text C Field — ERRW7 error text: ASCII bytes, copied.
• text_length C Field — Length of text in bytes.
• PdcommGemFormattedProgramVerificationNegotiationOptions C Struct — Limits for the verification negotiation service.
• max_history C Field — Number of finished negotiations remembered for replay detection; must be nonzero.
• max_issue_text_bytes C Field — Largest ERRW7 text length of one issue, in bytes.
• max_issues C Field — Largest number of issues in a prepared S7F27 report.
• max_pending C Field — Largest number of submitted equipment-side negotiations awaiting a grant or acknowledgement; must be nonzero.
• max_prepared C Field — Largest number of unfinished equipment-side negotiations (prepared, submitted, or granted); must be nonzero.
• max_received C Field — Largest number of unanswered host-side S7F29 inquiries; must be nonzero.
• max_results C Field — Number of finished negotiations the service retains; must be nonzero.
• max_total_issue_text_bytes C Field — Largest total ERRW7 text length of all issues, in bytes.
• reserved C Field — Reserved; must be 0.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGemFormattedProgramVerificationNegotiationOptions) or larger.
• version C Field — Must be #PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_OPTIONS_VERSION.
• PdcommGemFormattedProgramVerificationRequestCommand C Struct — One process command (CCODE and PPARM list) passed to pdcomm_gem_formatted_program_verification_request_submit().
• code C Field — CCODE item; must be a non-NULL ASCII item for an outgoing S7F31.
• parameter_count C Field — Number of PPARM items in parameters.
• parameters C Field — Array of parameter_count PPARM items of any format; NULL when the count is 0.
• PdcommGemFormattedProgramVerificationRequestInfo C Struct — Summary of a verification request result, filled by pdcomm_gem_result_formatted_program_verification_request_info().
• acknowledgement C Field — ACKC7 code: the code received in S7F32, or the code this side sent for a received S7F31.
• acknowledgement_present C Field — 1 when acknowledgement holds a code.
• command_count C Field — Number of process commands in the received program; 0 for an S7F32 result.
• id_format C Field — PPID format, #PDCOMM_SECS_ASCII or #PDCOMM_SECS_BINARY; 0 when the result carries no program.
• is_request C Field — 1 when the result is a received S7F31 primary (equipment side), 0 for an S7F32 result.
• reply_ready C Field — 1 when the result is an S7F31 primary that still needs an S7F32 reply.
• request_kind C Field — GEM request kind, #PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_REQUEST_SEND for these results.
• reserved C Field — Reserved; written as zero.
• responded C Field — 1 when S7F32 has been sent for this primary, or the result is itself an S7F32.
• struct_size C Field — Structure size; set it to at least sizeof(PdcommGemFormattedProgramVerificationRequestInfo).
• PdcommGemFormattedProgramVerificationRequestOptions C Struct — Limits for the S7F31/S7F32 verification request service.
• max_commands C Field — Largest number of process commands in one program.
• max_history C Field — Number of completed transactions remembered to reject replays; the oldest is discarded first.
• max_parameters_per_command C Field — Largest number of PPARM items in one command.
• max_pending C Field — Largest number of sent S7F31 requests awaiting S7F32; must be nonzero.
• max_received C Field — Largest number of received S7F31 requests awaiting a reply; must be nonzero.
• max_results C Field — Number of completed request outcomes the service retains; the oldest is discarded first.
• max_total_parameter_bytes C Field — Largest sum of the encoded sizes of all PPARM items in one program, in bytes.
• max_total_parameters C Field — Largest number of PPARM items in one program.
• reserved C Field — Reserved; must be 0.
• struct_size C Field — Size of this structure in bytes; at least sizeof(PdcommGemFormattedProgramVerificationRequestOptions).
• version C Field — Options layout version; must be #PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_REQUEST_OPTIONS_VERSION.
• PdcommGemHostOptions C Struct — Options for pdcomm_gem_configure_host().
• item_limits C Field — SECS-II limits for every message the host builds or parses; item_limits.struct_size must be valid.
• max_pending_ids C Field — Largest total number of identifiers copied by pending host requests.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGemHostOptions) or larger.
• version C Field — Options version; must be #PDCOMM_GEM_OPTIONS_VERSION.
• PdcommGemInt128 C Struct — Signed 128-bit integer split into two 64-bit halves.
• high C Field — High 64 bits of the two's-complement value; carries the sign.
• low C Field — Low 64 bits of the two's-complement value.
• PdcommGemLinkSpec C Struct — One event link: a CEID and the reports to link to it (S2F35).
• count C Field — Number of elements in report_ids.
• event_id C Field — Collection event ID (CEID), sent as U4.
• report_ids C Field — Array of count report IDs (RPTID).
• PdcommGemProgramInfo C Struct — Process program details of a GEM result, filled by pdcomm_gem_result_program_info().
• acknowledgement C Field — PPGNT (S7F2) or ACKC7 (S7F4, S7F18), sent or received.
• acknowledgement_present C Field — 1 when acknowledgement is valid.
• applied C Field — 1 when responding to this request changed the store.
• confirmation_required C Field — 1 when a retained reply waits for pdcomm_gem_program_confirm_reply() after #PDCOMM_PROGRAM_UNCONFIRMED.
• declared_length C Field — LENGTH declared in an incoming S7F1, in PPBODY payload bytes; otherwise 0.
• durability C Field — Durability of the installation made while responding: one of the PDCOMM_GEM_PROGRAM_* durability values.
• grant_activated C Field — 1 when answering this S7F1 activated a grant; it reports the original activation, not whether the grant is still live.
• id_count C Field — Number of PPIDs available through #PDCOMM_GEM_PROGRAM_ID.
• is_request C Field — 1 for an incoming request; 0 for a response to this endpoint's request.
• persistence_status C Field — #PDCOMM_OK, or the persistence error of an unconfirmed installation.
• reply_ready C Field — 1 when a prepared reply is retained and can be sent by pdcomm_gem_program_respond().
• request_kind C Field — Request kind: one of #PDCOMM_GEM_PROGRAM_GRANT to #PDCOMM_GEM_PROGRAM_DIRECTORY.
• responded C Field — 1 after the reply to an incoming request was queued.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGemProgramInfo) or larger before the call.
• PdcommGemProgramOptions C Struct — Store limits, request budgets, and grant policy for process programs.
• grant_policy C Field — S7F3 grant policy: #PDCOMM_GEM_PROGRAM_GRANT_REQUIRED or #PDCOMM_GEM_PROGRAM_GRANT_OPTIONAL.
• max_body_bytes C Field — Largest PPBODY payload of one program in bytes.
• max_grants C Field — Largest number of concurrently active S7F1 grants; storage for them is reserved at configuration.
• max_identifier_bytes C Field — Largest PPID length in bytes; the effective limit is at most 120.
• max_pending_identifier_bytes C Field — Largest total PPID bytes across this endpoint's outstanding program requests.
• max_pending_ids C Field — Largest total number of PPIDs across this endpoint's outstanding program requests.
• max_programs C Field — Largest number of stored programs.
• max_request_ids C Field — Largest number of PPIDs in one delete, local or S7F17.
• max_reserved_body_bytes C Field — Largest total declared LENGTH bytes reserved by active grants.
• max_serialized_bytes C Field — Largest snapshot file size in bytes; used only with a file path.
• max_total_body_bytes C Field — Largest total PPBODY payload bytes of all stored programs.
• max_total_identifier_bytes C Field — Largest total PPID bytes of all stored programs.
• reserved C Field — Reserved; must be 0.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGemProgramOptions) or larger.
• version C Field — Structure version; must be #PDCOMM_GEM_PROGRAM_OPTIONS_VERSION.
• PdcommGemProgramState C Struct — Usage snapshot of the program store, filled by pdcomm_gem_program_state().
• body_bytes C Field — Total PPBODY payload bytes of the stored programs.
• grant_count C Field — Number of active S7F1 grants.
• identifier_bytes C Field — Total PPID bytes of the stored programs.
• persistent C Field — 1 when the store is backed by a snapshot file; 0 for RAM.
• program_count C Field — Number of stored programs.
• reserved_body_bytes C Field — Total declared LENGTH bytes reserved by active grants.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGemProgramState) or larger before the call.
• PdcommGemProgramWriteInfo C Struct — Outcome of a local store mutation.
• applied C Field — 1 when the store was changed and the change installed.
• durability C Field — #PDCOMM_GEM_PROGRAM_VOLATILE, #PDCOMM_GEM_PROGRAM_SYNCED, #PDCOMM_GEM_PROGRAM_UNCONFIRMED, or #PDCOMM_GEM_PROGRAM_DURABILITY_NONE.
• persistence_status C Field — #PDCOMM_OK, or the persistence error (for example #PDCOMM_IO_ERROR) when durability is #PDCOMM_GEM_PROGRAM_UNCONFIRMED.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGemProgramWriteInfo) or larger before the call.
• PdcommGemQueryInfo C Struct — Summary of a report query request or response, filled by pdcomm_gem_result_query_info().
• data_id C Field — DATAID from an S6F16 reply; 0 when data_id_present is 0.
• data_id_present C Field — 1 for an S6F16 reply, which carries a DATAID; otherwise 0.
• id C Field — Requested ID: the CEID for an event query, otherwise the RPTID.
• is_request C Field — 1 for a query received by an Equipment, 0 for a response received by a Host.
• query_kind C Field — #PDCOMM_GEM_EVENT_QUERY, #PDCOMM_GEM_INDIVIDUAL_QUERY, or #PDCOMM_GEM_ANNOTATED_QUERY.
• report_count C Field — Number of reports in an S6F16 reply; 0 for requests and for S6F20/S6F22.
• responded C Field — 1 after pdcomm_gem_equipment_respond_report_query() sent the reply for this request.
• struct_size C Field — Structure size in bytes; set before the call, receives the size written.
• value_count C Field — Number of values: summed over all reports for S6F16, the entry count for S6F20/S6F22, 0 for requests.
• PdcommGemQueryReportInfo C Struct — One report of an S6F16 reply, filled by pdcomm_gem_result_query_report().
• id C Field — Report ID (RPTID).
• struct_size C Field — Structure size in bytes; set before the call, receives the size written.
• value_count C Field — Number of values in the report.
• PdcommGemQueryValueInfo C Struct — Metadata of one query value, filled by pdcomm_gem_result_query_value().
• struct_size C Field — Structure size in bytes; set before the call, receives the size written.
• vid C Field — VID of an S6F22 entry; 0 when vid_present is 0.
• vid_present C Field — 1 only for S6F22 entries, which carry a VID on the wire.
• PdcommGemReportBinding C Struct — Binding of one report VID to its value source.
• constant_id C Field — Equipment constant ID (ECID) for a CONSTANT source; must be NULL otherwise.
• source_id C Field — Status variable ID or DVID for STATUS and DATA sources; must be 0 for CONSTANT.
• source_kind C Field — Source kind: #PDCOMM_GEM_SOURCE_STATUS, #PDCOMM_GEM_SOURCE_DATA, or #PDCOMM_GEM_SOURCE_CONSTANT.
• vid C Field — Variable ID (VID) used in reports; unique within the store.
• PdcommGemReportOptions C Struct — Capacity limits of an Equipment report store.
• max_events C Field — Largest number of collection events (CEIDs) in the store.
• max_reports C Field — Largest number of defined reports (RPTIDs).
• max_reports_per_event C Field — Largest number of reports linked to one event.
• max_total_links C Field — Largest total number of event-to-report links.
• max_total_variables C Field — Largest total number of VIDs across all reports.
• max_variables_per_report C Field — Largest number of VIDs in one report.
• reserved C Field — Must be 0.
• struct_size C Field — Structure size in bytes; set to sizeof(PdcommGemReportOptions) or larger.
• version C Field — Must be #PDCOMM_GEM_REPORT_OPTIONS_VERSION.
• PdcommGemReportSpec C Struct — One report definition: an RPTID and its ordered VIDs.
• count C Field — Number of elements in variable_ids.
• id C Field — Report ID (RPTID), sent as U4.
• variable_ids C Field — Array of count variable IDs (VID), sent as U4.
• PdcommGemReportState C Struct — Counters of an Equipment report store, filled by pdcomm_gem_equipment_report_state().
• event_count C Field — Number of registered collection events.
• report_count C Field — Number of defined reports.
• struct_size C Field — Structure size in bytes.
• total_links C Field — Total number of event-to-report links.
• total_variables C Field — Total number of VIDs across all reports.
• PdcommGemResult C Typedef — Opaque, immutable snapshot produced by pdcomm_gem_handle_event().
• PdcommGemResultInfo C Struct — Fixed fields of a ::PdcommGemResult, read with pdcomm_gem_result_info().
• acknowledgement C Field — Acknowledgement code of the exchange (such as COMMACK, OFLACK, or ONLACK); valid only when acknowledgement_present is nonzero.
• acknowledgement_present C Field — Nonzero when acknowledgement holds a value.
• code C Field — Failure or error detail; 0 when there is none.
• entry_count C Field — Number of entries in list-type results, such as the values of #PDCOMM_GEM_VALUES_RECEIVED or the entries of #PDCOMM_GEM_NAMES_RECEIVED; 0 otherwise.
• kind C Field — Result kind: #PDCOMM_GEM_IGNORED, #PDCOMM_GEM_PRIMARY, #PDCOMM_GEM_RESPONSE, #PDCOMM_GEM_FAILED, #PDCOMM_GEM_INVALID_RESPONSE, or #PDCOMM_GEM_UNHANDLED.
• outcome C Field — What the message did, as a PDCOMM_GEM_* outcome value.
• reply_sent C Field — Nonzero when this side has sent the reply to the primary of this result.
• request_kind C Field — Request kind of the matched pending request for response, failed, and invalid-response results; 0 otherwise.
• state C Field — GEM state of the endpoint after the event was processed.
• struct_size C Field — Structure size in bytes.
• token C Field — Transaction token.
• PdcommGemSpoolEntryInfo C Struct — Header of one spooled message, filled by pdcomm_gem_spool_entry_at().
• body_present C Field — 1 when the message has a body; 0 for a header-only message.
• entry_id C Field — Entry ID, unique within the spool.
• function C Field — Function of the spooled message.
• reply_expected C Field — 1 when the message is sent with the W bit (a reply is expected).
• stream C Field — Stream of the spooled message.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGemSpoolEntryInfo) or larger before the call.
• PdcommGemSpoolHostOptions C Struct — Request limits for Host spooling requests.
• max_functions_per_stream C Field — Largest number of functions for one stream in a request or accepted reply.
• max_pending_items C Field — Largest item budget of one S2F43 request.
• max_streams C Field — Largest number of streams in one S2F43 request or accepted reply.
• reserved C Field — Reserved; must be 0.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGemSpoolHostOptions) or larger.
• version C Field — Structure version; must be #PDCOMM_GEM_SPOOL_OPTIONS_VERSION.
• PdcommGemSpoolInfo C Struct — Spooling details of a GEM result, filled by pdcomm_gem_result_spool_info().
• acknowledgement C Field — Acknowledgement code: RSPACK (S2F44), RSDA (S6F24), or ACKC5/ACKC6 from a delivered S5F1/S6F11 reply.
• acknowledgement_present C Field — 1 when acknowledgement is valid.
• applied C Field — 1 when processing this result installed a spool change.
• command C Field — S6F23 command (#PDCOMM_GEM_SPOOL_TRANSMIT or #PDCOMM_GEM_SPOOL_PURGE) for control kinds; otherwise 0.
• confirmation_required C Field — 1 when a retained reply waits for pdcomm_gem_spool_confirm_reply() after #PDCOMM_SPOOL_UNCONFIRMED.
• delivery_attempt C Field — Delivery attempt number for delivery results; otherwise 0.
• delivery_completed C Field — 1 when pdcomm_gem_spool_complete_delivery() finished with this delivery result.
• delivery_proof C Field — Delivery proof: #PDCOMM_GEM_SPOOL_PROOF_NONE, #PDCOMM_GEM_SPOOL_PROOF_RESPONSE, or #PDCOMM_GEM_SPOOL_PROOF_WRITTEN.
• dequeue_pending C Field — 1 when delivery succeeded but the dequeue failed before installation and is still pending.
• durability C Field — Durability of the change applied by a response or delivery, as in ::PdcommGemSpoolWriteInfo, or #PDCOMM_GEM_SPOOL_CONFIRMED.
• entry_id C Field — Entry ID of the delivered message for delivery results; otherwise 0.
• error_count C Field — Number of stream errors in a received S2F44.
• is_request C Field — 1 for an incoming request (Equipment side); 0 for a response or delivery result.
• persistence_status C Field — #PDCOMM_OK, or the persistence error of an unconfirmed or failed installation or dequeue.
• reply_ready C Field — 1 when a prepared reply is retained and can be sent by pdcomm_gem_spool_respond().
• request_kind C Field — Request kind: #PDCOMM_GEM_SPOOL_CONFIGURE, #PDCOMM_GEM_SPOOL_QUERY, #PDCOMM_GEM_SPOOL_CONTROL, or #PDCOMM_GEM_SPOOL_DELIVERY.
• responded C Field — 1 after the reply to an incoming request was queued.
• selection_count C Field — Number of stream selections in an incoming S2F43 or a received S2F60.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGemSpoolInfo) or larger before the call.
• success_accepted C Field — 1 when the application reported this delivery as successful.
• PdcommGemSpoolMessageKey C Struct — One spoolable primary message type in the Equipment catalog.
• function C Field — Primary function number: odd and nonzero.
• stream C Field — Stream number, 2 to 127.
• PdcommGemSpoolOptions C Struct — Storage limits and persistence bound for an Equipment spool.
• max_body_bytes C Field — Largest encoded body of one captured message in bytes; larger bodies are rejected.
• max_catalog_entries C Field — Largest number of catalog entries; also bounds the total functions listed in an incoming S2F43 or an outgoing S2F60.
• max_functions_per_stream C Field — Largest number of functions listed for one stream in a selection.
• max_messages C Field — Largest number of spooled messages; reaching it makes the spool full.
• max_serialized_bytes C Field — Largest snapshot file size in bytes; used only with a file path.
• max_streams C Field — Largest number of streams in a selection, locally or in S2F43 and S2F60.
• max_total_body_bytes C Field — Largest total encoded body bytes of all spooled messages; reaching it makes the spool full.
• reserved C Field — Reserved; must be 0.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGemSpoolOptions) or larger.
• version C Field — Structure version; must be #PDCOMM_GEM_SPOOL_OPTIONS_VERSION.
• PdcommGemSpoolPolicy C Struct — Local spool policy, set with pdcomm_gem_spool_configure_local().
• enabled C Field — 1 enables spooling globally (E30 EnableSpooling), 0 disables it, and other values are rejected.
• max_transmit C Field — Largest number of messages delivered per transmission run (E30 MaxSpoolTransmit); 0 means unbounded.
• overflow C Field — Overflow policy: #PDCOMM_GEM_SPOOL_DISCARD_NEW or #PDCOMM_GEM_SPOOL_OVERWRITE_OLDEST.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGemSpoolPolicy) or larger.
• PdcommGemSpoolSelection C Struct — Spool selection for one stream, as in S2F43.
• function_count C Field — Number of entries in functions; 0 selects the whole stream.
• functions C Field — Array of function_count function numbers; may be NULL when function_count is 0.
• stream C Field — Stream number.
• PdcommGemSpoolState C Struct — Snapshot of an Equipment spool, filled by pdcomm_gem_spool_state().
• active C Field — 1 when spooling is active (E30 SPOOL ACTIVE): messages are being stored or are still waiting for delivery.
• body_bytes C Field — Total encoded body bytes of the spooled messages.
• catalog_count C Field — Number of catalog entries.
• connected C Field — 1 when the last sync observed a Selected, Communicating connection.
• delivery_pending C Field — 1 while a delivery attempt is in flight or an acknowledged dequeue is pending.
• dequeue_pending C Field — 1 when a delivered head entry still has to be dequeued with pdcomm_gem_spool_retry_dequeue().
• discarded C Field — Messages discarded or overwritten because the spool was full.
• enabled C Field — 1 when spooling is enabled.
• full_time C Field — Application timestamp when the spool became full (E30 SpoolFullTime); valid when full_time_present is 1.
• full_time_present C Field — 1 when full_time holds a value.
• max_transmit C Field — Current per-run transmit limit; 0 means unbounded.
• message_count C Field — Number of spooled messages (E30 SpoolCountActual).
• next_id C Field — Entry ID that the next stored message receives.
• overflow C Field — Current overflow policy: #PDCOMM_GEM_SPOOL_DISCARD_NEW or #PDCOMM_GEM_SPOOL_OVERWRITE_OLDEST.
• persistent C Field — 1 when the spool is backed by a snapshot file; 0 for RAM.
• received C Field — Selected messages offered for spooling while active, stored or discarded.
• selection_count C Field — Number of streams in the current selection.
• start_time C Field — Application timestamp when spooling started (E30 SpoolStartTime); valid when start_time_present is 1.
• start_time_present C Field — 1 when start_time holds a value.
• stored C Field — Messages stored in the spool.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGemSpoolState) or larger before the call.
• synchronized C Field — 1 when the last pdcomm_gem_spool_sync() still matches the current connection state.
• transmitted C Field — Spooled messages delivered and dequeued.
• transmitted_in_run C Field — Messages dequeued in the current transmission run.
• transmitting C Field — 1 while a transmission run accepted by S6F23 is in progress.
• PdcommGemSpoolWriteInfo C Struct — Outcome of a spool mutation.
• affected_count C Field — Overwritten entries for a capture, purged entries for a purge, 1 for a dequeue; otherwise 0.
• applied C Field — 1 when a change was installed; 0 otherwise.
• durability C Field — Durability of the change: #PDCOMM_GEM_SPOOL_DURABILITY_NONE, #PDCOMM_GEM_SPOOL_VOLATILE, #PDCOMM_GEM_SPOOL_SYNCED, or #PDCOMM_GEM_SPOOL_UNCONFIRMED.
• entry_id C Field — Entry ID of a captured (#PDCOMM_GEM_SPOOL_CAPTURED) or removed (#PDCOMM_GEM_SPOOL_REMOVED) entry; otherwise 0.
• mutation C Field — Kind of change: one of the PDCOMM_GEM_SPOOL_MUTATION_NONE to PDCOMM_GEM_SPOOL_PURGED values.
• persistence_status C Field — #PDCOMM_OK, or the persistence error (for example #PDCOMM_IO_ERROR) when durability is #PDCOMM_GEM_SPOOL_UNCONFIRMED.
• selected C Field — 1 when a change was installed; 0 when a captured message was not selected for spooling.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommGemSpoolWriteInfo) or larger before the call.
• PdcommGemState C Struct — GEM state of an endpoint, filled by pdcomm_gem_state() and embedded in ::PdcommGemResultInfo.
• communication C Field — Communication state, one of #PDCOMM_GEM_DISCONNECTED through #PDCOMM_GEM_COMMUNICATING.
• control C Field — Equipment control state (#PDCOMM_GEM_EQUIPMENT_OFFLINE through #PDCOMM_GEM_ONLINE_REMOTE), or #PDCOMM_GEM_CONTROL_UNAVAILABLE for a host.
• endpoint_id C Field — Identifier of the TCP endpoint, as carried in ::PdcommTcpToken.
• generation C Field — Current connection generation of the TCP endpoint.
• online_mode C Field — Equipment online mode (#PDCOMM_GEM_LOCAL or #PDCOMM_GEM_REMOTE), or #PDCOMM_GEM_CONTROL_UNAVAILABLE for a host.
• pending_count C Field — Number of occupied pending-request slots, at most 32.
• pending_ids C Field — Number of identifiers held by pending requests, counted against max_pending_ids for a host.
• role C Field — Configured role: #PDCOMM_GEM_HOST or #PDCOMM_GEM_EQUIPMENT.
• struct_size C Field — Structure size in bytes.
• variable_count C Field — Number of registered status variables; 0 for a host.
• PdcommSecs1Endpoint C Typedef — Opaque SECS-I endpoint bound to one caller-provided byte stream.
• PdcommSecs1Event C Typedef — Opaque, immutable, owned SECS-I event snapshot.
• PdcommSecs1EventInfo C Struct — Description of an event, filled by pdcomm_secs1_event_info().
• body_length C Field — Inbound only: message body length in bytes.
• device_id C Field — Inbound only: device ID from the block header.
• direction C Field — Inbound only: #PDCOMM_SECS1_TO_HOST or #PDCOMM_SECS1_TO_EQUIPMENT, from the R-bit.
• discarded_partial C Field — Fault only: 1 when a partially received block or message was discarded.
• fault_detail C Field — Fault only: detail for fault_kind.
• fault_kind C Field — Fault only: one of the PDCOMM_SECS1_FAULT_* values.
• function C Field — Inbound only: SECS-II function number.
• kind C Field — Event kind, one of the PDCOMM_SECS1_EVENT_* values.
• reply_expected C Field — Inbound only: 1 when the W-bit is set, otherwise 0.
• reserved C Field — Reserved; written as zero.
• stream C Field — Inbound only: SECS-II stream number.
• struct_size C Field — Structure size in bytes.
• system_bytes C Field — Inbound only: system bytes from the block header, in host byte order.
• token C Field — Submission the event refers to.
• PdcommSecs1Io C Struct — Caller-provided I/O callback table.
• context C Field — Opaque pointer passed to both callbacks; must not be NULL.
• read C Field — Nonblocking read callback; must not be NULL.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommSecs1Io) or larger.
• write C Field — Nonblocking write callback; must not be NULL.
• PdcommSecs1Message C Struct — A message to send with pdcomm_secs1_submit().
• body C Field — Message body, normally one encoded SECS-II item.
• body_length C Field — Number of bytes at body.
• device_id C Field — Device ID, 0 to 32767.
• direction C Field — Direction that sets the R-bit: #PDCOMM_SECS1_TO_HOST or #PDCOMM_SECS1_TO_EQUIPMENT.
• function C Field — SECS-II function number, 0 to 255.
• reply_expected C Field — W-bit: 1 when the sender expects a reply, otherwise 0.
• reserved C Field — Reserved; must be zero.
• stream C Field — SECS-II stream number, 0 to 127.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommSecs1Message) or larger.
• system_bytes C Field — System bytes of the block header.
• version C Field — Structure version; must be #PDCOMM_SECS1_MESSAGE_VERSION.
• PdcommSecs1Options C Struct — SECS-I line settings and resource limits for pdcomm_secs1_create().
• ack_wait_ticks C Field — T2 for a reply, in ticks; nonzero.
• grant_wait_ticks C Field — T2 for the EOT that grants the line after the endpoint sends ENQ, in ticks; nonzero.
• inbound_progress_ticks C Field — T1 inter-character timeout while a block is received, in ticks; nonzero.
• inter_block_ticks C Field — T4 inter-block timeout of a multi-block inbound message, in ticks; nonzero.
• max_blocks C Field — Largest number of blocks in an inbound message.
• max_body_bytes C Field — Largest inbound message body in bytes.
• max_event_body_bytes C Field — Largest total body bytes held by queued events; at least max_body_bytes.
• max_events C Field — Largest number of events queued for pdcomm_secs1_next_event(); nonzero.
• max_io_chunk C Field — Largest byte count passed to one read or write callback; nonzero.
• max_outbound_blocks C Field — Largest number of blocks of a submitted message; nonzero and at most max_blocks.
• max_outbound_body_bytes C Field — Largest body accepted by pdcomm_secs1_submit(); nonzero and at most max_body_bytes.
• poll_budget C Field — Number of processing steps in one pdcomm_secs1_poll() call; nonzero.
• priority C Field — Contention role: #PDCOMM_SECS1_MASTER or #PDCOMM_SECS1_SLAVE.
• reserved C Field — Reserved; must be zero.
• reserved2 C Field — Reserved; must be zero.
• retry_limit C Field — Retry limit (SEMI E4 RTY) for sending one block.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommSecs1Options) or larger.
• version C Field — Structure version; must be #PDCOMM_SECS1_OPTIONS_VERSION.
• PdcommSecs1Read C Typedef — Reads bytes from the serial stream without blocking.
• PdcommSecs1State C Struct — Snapshot of an endpoint, filled by pdcomm_secs1_state().
• endpoint_id C Field — Process-unique, nonzero endpoint identifier.
• faulted C Field — 1 while a terminal fault is active, until pdcomm_secs1_reset() or stop.
• generation C Field — Current generation; starts at 1 and grows with each restart after stop.
• poisoned C Field — 1 after a contained panic poisoned the endpoint; otherwise 0.
• started C Field — 1 after pdcomm_secs1_start() until pdcomm_secs1_stop(); otherwise 0.
• stopped C Field — 1 after pdcomm_secs1_stop() until the next start; otherwise 0.
• struct_size C Field — Structure size in bytes.
• PdcommSecs1Token C Struct — Identifies one accepted submission.
• endpoint_id C Field — Process-unique, nonzero endpoint identifier.
• generation C Field — Endpoint generation; 1 after create, incremented by each restart after stop.
• reserved C Field — Reserved; always zero.
• value C Field — Per-generation submission number, starting at 1; zero means no submission.
• PdcommSecs1Write C Typedef — Writes bytes to the serial stream without blocking.
• PdcommSecsInfo C Struct — Summary of a SECS-II item, filled by pdcomm_secs_info().
• count C Field — Number of child items for a List; number of elements (payload bytes divided by element width) for a primitive.
• depth C Field — Nesting depth: 1 for a primitive or an empty List.
• encoded_length C Field — Length of the minimal SECS-II encoding of the whole item, headers included.
• format C Field — Format code of the item, one of the PDCOMM_SECS_* format macros.
• node_count C Field — Number of items in the tree, including this item.
• struct_size C Field — Structure size in bytes.
• PdcommSecsItem C Typedef — Opaque, immutable, owned SECS-II item tree.
• PdcommSecsLimits C Struct — Resource limits for building, decoding, and copying SECS-II items.
• item_bytes C Field — Largest payload of a single primitive item in bytes.
• item_count C Field — Largest number of items in a tree, counting every List and primitive; must be at least 1.
• message_bytes C Field — Largest total encoded size of an item tree, headers included, in bytes.
• nesting_depth C Field — Largest nesting depth; capped at 64.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommSecsLimits) or larger.
• PdcommTcpEndpoint C Typedef — Opaque HSMS endpoint handle.
• PdcommTcpEvent C Typedef — Opaque, owned snapshot of one endpoint event.
• PdcommTcpEventInfo C Struct — Decoded description of an event, filled by pdcomm_tcp_event_info().
• aborted C Field — For a received reply: 1 when the reply is an SxF0 abort (function 0).
• body_length C Field — Length of the message body in bytes; nonzero only for #PDCOMM_TCP_RECEIVED.
• code C Field — Kind-specific code.
• detail C Field — Kind-specific detail.
• from_state C Field — Previous state for #PDCOMM_TCP_STATE_CHANGED.
• function C Field — Function (header byte 3); valid when PdcommTcpEventInfo::header_present is 1.
• header_present C Field — 1 when the header fields are valid.
• is_reply C Field — For #PDCOMM_TCP_RECEIVED: 1 for a reply to one of your requests, 0 for a primary.
• kind C Field — Event kind, such as #PDCOMM_TCP_RECEIVED.
• p_type C Field — Header PType; valid when PdcommTcpEventInfo::header_present is 1.
• reply_expected C Field — 1 when the header's W-bit is set (a reply is expected); valid when PdcommTcpEventInfo::header_present is 1.
• s_type C Field — Header SType (0 for data messages); valid when PdcommTcpEventInfo::header_present is 1.
• session_id C Field — Session ID from the message header; valid when PdcommTcpEventInfo::header_present is 1.
• stream C Field — Stream (header byte 2 without the W-bit); valid when PdcommTcpEventInfo::header_present is 1.
• struct_size C Field — Structure size in bytes.
• to_state C Field — New state for #PDCOMM_TCP_STATE_CHANGED.
• token C Field — Token of the event.
• value1 C Field — First code-specific value, as described for each failure reason, protocol error, and frame error.
• value2 C Field — Second code-specific value, as described for each failure reason, protocol error, and frame error.
• PdcommTcpOptions C Struct — Configuration for pdcomm_tcp_create().
• connect_timeout_ms C Field — Active-mode TCP connect timeout in milliseconds; must be nonzero.
• initial_system_bytes C Field — First system bytes value of each connection generation.
• item_limits C Field — SECS-II limits for message bodies.
• max_application_bytes C Field — Largest total body size of the events in the queue read by pdcomm_tcp_next_event(), in bytes; must be at least PdcommTcpOptions::max_frame_bytes minus 14.
• max_application_events C Field — Capacity of the queue read by pdcomm_tcp_next_event(); must be nonzero.
• max_events C Field — Capacity of the internal session event queue; must be at least 2 * #PDCOMM_TCP_MAX_TRANSACTIONS + 8 (72).
• max_frame_bytes C Field — Largest HSMS frame in bytes, including the 4-byte length field and the 10-byte header; must be at least 14.
• max_io_chunk C Field — Largest number of bytes passed to one socket read or write call; must be nonzero.
• max_queued_bytes C Field — Largest total size of message bodies held in the internal session queue, in bytes.
• max_write_bytes C Field — Largest total size of the socket write queue in bytes; must be at least 14 and at least PdcommTcpOptions::max_frame_bytes.
• max_write_frames C Field — Largest number of frames in the socket write queue; must be nonzero.
• mode C Field — Connection mode: #PDCOMM_TCP_ACTIVE or #PDCOMM_TCP_PASSIVE.
• poll_budget C Field — Largest number of internal actions one pdcomm_tcp_poll() call performs; must be nonzero.
• reserved C Field — Reserved; must be 0.
• session_id C Field — HSMS session ID (device ID) for data messages.
• shutdown_timeout_ms C Field — Graceful shutdown limit in milliseconds; must be nonzero.
• struct_size C Field — Size of this structure in bytes; set to sizeof(PdcommTcpOptions) or larger.
• t3_ms C Field — T3 reply timeout in milliseconds; must be nonzero.
• t5_ms C Field — T5 connect separation timeout in milliseconds; must be nonzero.
• t6_ms C Field — T6 control transaction timeout in milliseconds; must be nonzero.
• t7_ms C Field — T7 not-selected timeout in milliseconds; must be nonzero.
• t8_ms C Field — T8 network intercharacter timeout in milliseconds; must be nonzero.
• version C Field — Options layout version; must be #PDCOMM_TCP_OPTIONS_VERSION.
• write_timeout_ms C Field — Write timeout in milliseconds; must be nonzero.
• PdcommTcpState C Struct — Endpoint state snapshot, filled by pdcomm_tcp_state().
• closed C Field — 1 when a stopped endpoint has finished closing, otherwise 0.
• endpoint_id C Field — Process-unique, nonzero identity of the endpoint.
• generation C Field — Current connection generation; 0 before the first start.
• state C Field — Current HSMS state, one of the PDCOMM_TCP_* state values such as #PDCOMM_TCP_SELECTED.
• struct_size C Field — Structure size in bytes.
• PdcommTcpToken C Struct — Identifies one transaction or received message of one endpoint generation.
• endpoint_id C Field — Process-unique, nonzero endpoint identity; 0 in an empty token.
• generation C Field — Connection generation in which the transaction or message occurred.
• reserved C Field — Reserved; the library writes 0, and tokens you pass in must have 0.
• system_bytes C Field — HSMS system bytes of the message.
• pdcomm_gem300_capability_catalog_clear C Function — Removes every profile from the catalog.
• pdcomm_gem300_capability_catalog_create C Function — Creates an empty capability catalog with revision 0.
• pdcomm_gem300_capability_catalog_destroy C Function — Releases a catalog.
• pdcomm_gem300_capability_catalog_info C Function — Reads the revision and totals of a catalog.
• pdcomm_gem300_capability_catalog_replace C Function — Atomically replaces the catalog contents with an ordered list of profiles.
• pdcomm_gem300_capability_catalog_snapshot C Function — Copies the complete ordered catalog contents into a new snapshot.
• pdcomm_gem300_capability_snapshot_capability_id_copy C Function — Copies the identifier of one snapshot capability.
• pdcomm_gem300_capability_snapshot_capability_info C Function — Reads the axis, labels, and identifier length of one snapshot capability.
• pdcomm_gem300_capability_snapshot_destroy C Function — Releases a snapshot.
• pdcomm_gem300_capability_snapshot_info C Function — Reads the revision and totals recorded in a snapshot.
• pdcomm_gem300_capability_snapshot_profile_id_copy C Function — Copies the identifier of one snapshot profile.
• pdcomm_gem300_capability_snapshot_profile_info C Function — Reads the identifier length and capability count of one snapshot profile.
• pdcomm_gem_begin_communication C Function — Sends S1F13 Establish Communications Request.
• pdcomm_gem_configure_equipment C Function — Attaches a GEM equipment role to a stopped TCP endpoint.
• pdcomm_gem_configure_formatted_program_capabilities C Function — Enables the formatted program capability service on a GEM endpoint.
• pdcomm_gem_configure_formatted_program_queries C Function — Enables the S7F25/S7F26 service on an endpoint.
• pdcomm_gem_configure_formatted_program_transfers C Function — Enables the S7F23/S7F24 transfer service on an endpoint.
• pdcomm_gem_configure_formatted_program_verification_negotiation C Function — Enables the verification negotiation service on a GEM endpoint.
• pdcomm_gem_configure_formatted_program_verification_requests C Function — Enables the S7F31/S7F32 verification request service on an endpoint.
• pdcomm_gem_configure_formatted_programs C Function — Enables the S7F27/S7F28 verification report service on an endpoint.
• pdcomm_gem_configure_host C Function — Attaches a GEM host role to a stopped TCP endpoint.
• pdcomm_gem_configure_programs C Function — Attaches a process program store to a GEM endpoint.
• pdcomm_gem_configure_spool_host C Function — Enables Host spooling requests and sets their limits.
• pdcomm_gem_configure_spooling C Function — Attaches an Equipment spool to a GEM endpoint.
• pdcomm_gem_equipment_alarm_at C Function — Reads one stored alarm by registration index and copies its text.
• pdcomm_gem_equipment_alarm_state C Function — Reads the alarm counts of the Equipment alarm store.
• pdcomm_gem_equipment_binding_at C Function — Reads one binding by position.
• pdcomm_gem_equipment_binding_state C Function — Reads the counters of the binding store.
• pdcomm_gem_equipment_clear_data_variable C Function — Removes the cached value of one data variable.
• pdcomm_gem_equipment_clear_report_bindings C Function — Removes the binding store and restores legacy VID-to-status resolution.
• pdcomm_gem_equipment_command_at C Function — Reads one stored command by registration index.
• pdcomm_gem_equipment_command_parameter_at C Function — Reads one parameter definition of a stored command.
• pdcomm_gem_equipment_command_state C Function — Reads the counts of the Equipment remote command store.
• pdcomm_gem_equipment_configure_alarms C Function — Installs the alarm store of a GEM Equipment endpoint.
• pdcomm_gem_equipment_configure_commands C Function — Installs the remote command store of a GEM Equipment endpoint.
• pdcomm_gem_equipment_configure_constants C Function — Installs the equipment constant store of an Equipment.
• pdcomm_gem_equipment_configure_data_variables C Function — Installs or replaces the complete data variable store of an Equipment.
• pdcomm_gem_equipment_configure_enhanced_commands C Function — Installs the enhanced remote command store of a GEM Equipment endpoint.
• pdcomm_gem_equipment_configure_event_directory C Function — Installs or replaces the complete event directory of an Equipment.
• pdcomm_gem_equipment_configure_fixed_catalog C Function — Atomically installs a fixed report graph and its STATUS or DATA bindings.
• pdcomm_gem_equipment_configure_report_bindings C Function — Installs or replaces the explicit report binding store of an Equipment.
• pdcomm_gem_equipment_configure_reports C Function — Installs an empty report store with the given collection events on an Equipment.
• pdcomm_gem_equipment_constant_at C Function — Reads one constant definition and its ID by position.
• pdcomm_gem_equipment_constant_get C Function — Copies one field of a local constant.
• pdcomm_gem_equipment_constant_state C Function — Reads the counters of the constant store.
• pdcomm_gem_equipment_data_at C Function — Reads the definition summary of one data variable by position.
• pdcomm_gem_equipment_data_get C Function — Copies the name, units, or cached value of one data variable.
• pdcomm_gem_equipment_data_state C Function — Reads the counters of the data variable store.
• pdcomm_gem_equipment_directory_at C Function — Reads one local event directory entry by position.
• pdcomm_gem_equipment_directory_get C Function — Copies the name or the VIDs of one local event directory entry.
• pdcomm_gem_equipment_directory_state C Function — Reads the counters of the event directory.
• pdcomm_gem_equipment_enhanced_command_at C Function — Reads one stored command of an object.
• pdcomm_gem_equipment_enhanced_command_parameter_at C Function — Reads one parameter definition of a stored enhanced command.
• pdcomm_gem_equipment_enhanced_command_state C Function — Reads the counts of the Equipment enhanced command store.
• pdcomm_gem_equipment_enhanced_object_at C Function — Reads one stored object by registration index.
• pdcomm_gem_equipment_event_at C Function — Copies one collection event of the local report store by position.
• pdcomm_gem_equipment_observe_alarm C Function — Records the current set or cleared state of an alarm without sending anything.
• pdcomm_gem_equipment_operator_offline C Function — Takes the equipment to EQUIPMENT OFF-LINE (the operator's OFF-LINE switch).
• pdcomm_gem_equipment_operator_online C Function — Starts an operator-initiated ON-LINE attempt by sending S1F1.
• pdcomm_gem_equipment_publish_alarm C Function — Publishes the current state of one alarm as an S5F1 Alarm Report Send.
• pdcomm_gem_equipment_publish_event C Function — Sends an Event Report Send (S6F11, W-bit set) for an enabled event.
• pdcomm_gem_equipment_publish_event_with_data C Function — Sends an Event Report Send (S6F11, W-bit set) using sampled data variable values.
• pdcomm_gem_equipment_report_at C Function — Copies one report definition of the local report store by position.
• pdcomm_gem_equipment_report_state C Function — Reads the counters of an Equipment report store.
• pdcomm_gem_equipment_report_value C Function — Resolves the current value of one report VID from local stores only.
• pdcomm_gem_equipment_respond_command C Function — Sends the S2F42 Host Command Acknowledge for a received S2F41.
• pdcomm_gem_equipment_respond_constants C Function — Sends the S2F16 reply for a received S2F15 and applies accepted values.
• pdcomm_gem_equipment_respond_enhanced_command C Function — Sends the S2F50 Enhanced Remote Command Acknowledge for a received S2F49.
• pdcomm_gem_equipment_respond_report_query C Function — Sends the reply (S6F16, S6F20, or S6F22) to a received report query.
• pdcomm_gem_equipment_set_online_mode C Function — Sets the operator's REMOTE/LOCAL switch.
• pdcomm_gem_equipment_status_get C Function — Copies the current value of a registered status variable.
• pdcomm_gem_equipment_status_id_at C Function — Returns the ID of the status variable at a registration index.
• pdcomm_gem_equipment_status_metadata C Function — Copies the name and units of a registered status variable.
• pdcomm_gem_equipment_status_register C Function — Registers an equipment status variable (SV).
• pdcomm_gem_equipment_status_update C Function — Replaces the value of a registered status variable.
• pdcomm_gem_equipment_update_data_variable C Function — Replaces the cached value of one data variable.
• pdcomm_gem_formatted_program_capability_catalog_clear C Function — Removes the equipment's published capability catalog.
• pdcomm_gem_formatted_program_capability_catalog_replace C Function — Replaces the equipment's published capability catalog.
• pdcomm_gem_formatted_program_capability_respond C Function — Answers a received S7F21 request with S7F22 from the catalog.
• pdcomm_gem_formatted_program_capability_submit C Function — Sends an S7F21 capability request from the host.
• pdcomm_gem_formatted_program_clear_selection C Function — Clears the current selection when the token matches it.
• pdcomm_gem_formatted_program_dry_run C Function — Analyzes the selected formatted program against the capability catalog.
• pdcomm_gem_formatted_program_dry_run_destroy C Function — Releases a dry-run report.
• pdcomm_gem_formatted_program_dry_run_info C Function — Reads the summary of a dry-run report.
• pdcomm_gem_formatted_program_dry_run_issue_info C Function — Reads one issue of a dry-run report.
• pdcomm_gem_formatted_program_dry_run_model_copy C Function — Copies the analyzed program's MDLN (model name).
• pdcomm_gem_formatted_program_dry_run_program_id_copy C Function — Copies the raw bytes of the analyzed program identifier (PPID).
• pdcomm_gem_formatted_program_dry_run_program_id_get C Function — Copies the analyzed program identifier (PPID) as a SECS-II item.
• pdcomm_gem_formatted_program_dry_run_software_revision_copy C Function — Copies the analyzed program's SOFTREV (software revision).
• pdcomm_gem_formatted_program_execution_action_command_code_get C Function — Copies the command code of a Step action as a SECS-II item.
• pdcomm_gem_formatted_program_execution_action_destroy C Function — Releases an execution action handle.
• pdcomm_gem_formatted_program_execution_action_info C Function — Reads the description of an action, including its token fields.
• pdcomm_gem_formatted_program_execution_action_model_copy C Function — Copies the program MDLN (model name) of a Start action.
• pdcomm_gem_formatted_program_execution_action_parameter_get C Function — Copies one parameter of a Step action's command as a SECS-II item.
• pdcomm_gem_formatted_program_execution_action_program_id_get C Function — Copies the program identifier (PPID) of a Start action.
• pdcomm_gem_formatted_program_execution_action_software_revision_copy C Function — Copies the program SOFTREV (software revision) of a Start action.
• pdcomm_gem_formatted_program_execution_cancel C Function — Requests cancellation of the execution as a Cancel action.
• pdcomm_gem_formatted_program_execution_complete C Function — Records the application's terminal report for the execution.
• pdcomm_gem_formatted_program_execution_snapshot C Function — Captures the endpoint's current execution state as a snapshot.
• pdcomm_gem_formatted_program_execution_snapshot_application_detail_copy C Function — Copies the detail bytes of the snapshot's terminal report.
• pdcomm_gem_formatted_program_execution_snapshot_command_code_get C Function — Copies the command code of one program command as a SECS-II item.
• pdcomm_gem_formatted_program_execution_snapshot_command_info C Function — Reads the parameter count and code format of one program command.
• pdcomm_gem_formatted_program_execution_snapshot_destroy C Function — Releases an execution snapshot.
• pdcomm_gem_formatted_program_execution_snapshot_info C Function — Reads the state summary of a snapshot.
• pdcomm_gem_formatted_program_execution_snapshot_model_copy C Function — Copies the executed program's MDLN (model name).
• pdcomm_gem_formatted_program_execution_snapshot_parameter_get C Function — Copies one parameter of one program command as a SECS-II item.
• pdcomm_gem_formatted_program_execution_snapshot_program_id_get C Function — Copies the executed program's identifier (PPID) as a SECS-II item.
• pdcomm_gem_formatted_program_execution_snapshot_software_revision_copy C Function — Copies the executed program's SOFTREV (software revision).
• pdcomm_gem_formatted_program_execution_start C Function — Starts tracking an execution of the selected program and returns its Start action.
• pdcomm_gem_formatted_program_execution_step C Function — Requests the next program command as a Step action.
• pdcomm_gem_formatted_program_execution_submit_action_result C Function — Reports the application's result for the pending action.
• pdcomm_gem_formatted_program_query_remove C Function — Removes a program from the Equipment store (compatibility alias).
• pdcomm_gem_formatted_program_query_respond C Function — Sends the S7F26 reply for a received S7F25 from the program store.
• pdcomm_gem_formatted_program_query_seed C Function — Adds or replaces a program in the Equipment store (compatibility alias).
• pdcomm_gem_formatted_program_query_submit C Function — Sends an S7F25 Formatted Process Program Request to the equipment.
• pdcomm_gem_formatted_program_respond C Function — Sends the S7F28 acknowledge for a received S7F27 report.
• pdcomm_gem_formatted_program_select C Function — Selects a stored program by PPID and returns its selection token.
• pdcomm_gem_formatted_program_selection_snapshot C Function — Copies the current selection state, and the selected program if any, into a new snapshot.
• pdcomm_gem_formatted_program_selection_snapshot_command_code_get C Function — Copies the CCODE of one selected command as a new SECS-II item.
• pdcomm_gem_formatted_program_selection_snapshot_command_info C Function — Reads the parameter count and CCODE format of one selected command.
• pdcomm_gem_formatted_program_selection_snapshot_destroy C Function — Releases a selection snapshot.
• pdcomm_gem_formatted_program_selection_snapshot_id_get C Function — Copies the PPID of the selected program as a new SECS-II item.
• pdcomm_gem_formatted_program_selection_snapshot_info C Function — Reads the summary stored in a selection snapshot.
• pdcomm_gem_formatted_program_selection_snapshot_model_copy C Function — Copies the MDLN of the selected program.
• pdcomm_gem_formatted_program_selection_snapshot_parameter_get C Function — Copies one PPARM of one selected command as a new SECS-II item.
• pdcomm_gem_formatted_program_selection_snapshot_software_revision_copy C Function — Copies the SOFTREV of the selected program.
• pdcomm_gem_formatted_program_store_entry_command_code_get C Function — Copies the CCODE of one command as a new SECS-II item.
• pdcomm_gem_formatted_program_store_entry_command_info C Function — Reads the parameter count and CCODE format of one command.
• pdcomm_gem_formatted_program_store_entry_id_get C Function — Copies the PPID of one snapshot entry as a new SECS-II item.
• pdcomm_gem_formatted_program_store_entry_info C Function — Reads the summary of one program in a snapshot.
• pdcomm_gem_formatted_program_store_entry_model_copy C Function — Copies the MDLN equipment model of one snapshot entry.
• pdcomm_gem_formatted_program_store_entry_parameter_get C Function — Copies one PPARM of one command as a new SECS-II item.
• pdcomm_gem_formatted_program_store_entry_software_revision_copy C Function — Copies the SOFTREV software revision of one snapshot entry.
• pdcomm_gem_formatted_program_store_info C Function — Reads the current store totals and limits.
• pdcomm_gem_formatted_program_store_put C Function — Adds or replaces a formatted process program in the local store.
• pdcomm_gem_formatted_program_store_remove C Function — Removes a program from the local store.
• pdcomm_gem_formatted_program_store_snapshot C Function — Copies the whole store into a new owned snapshot.
• pdcomm_gem_formatted_program_store_snapshot_destroy C Function — Releases a store snapshot.
• pdcomm_gem_formatted_program_store_snapshot_info C Function — Reads the totals and limits captured in a snapshot.
• pdcomm_gem_formatted_program_submit C Function — Sends an S7F27 Process Program Verification Send to the host.
• pdcomm_gem_formatted_program_transfer_respond C Function — Sends the S7F24 acknowledge for a received S7F23 without storing the program.
• pdcomm_gem_formatted_program_transfer_respond_and_store C Function — Sends the S7F24 acknowledge for a received S7F23 and applies a store action to the program.
• pdcomm_gem_formatted_program_transfer_submit C Function — Sends an S7F23 Formatted Process Program Send to the equipment.
• pdcomm_gem_formatted_program_validate_selection_for_execution C Function — Checks that a selection token is still valid for execution and returns a snapshot of the selected program.
• pdcomm_gem_formatted_program_verification_prepare C Function — Prepares an S7F27 verification report for negotiation.
• pdcomm_gem_formatted_program_verification_request_respond C Function — Sends the S7F32 acknowledge for a received S7F31.
• pdcomm_gem_formatted_program_verification_request_submit C Function — Sends an S7F31 Verification Request Send to the equipment.
• pdcomm_gem_formatted_program_verification_respond C Function — Answers a received S7F29 inquiry with S7F30.
• pdcomm_gem_formatted_program_verification_retry_response C Function — Resends the staged S7F30 reply of a received inquiry.
• pdcomm_gem_formatted_program_verification_retry_verification C Function — Resends the S7F27 report after a grant whose automatic send failed.
• pdcomm_gem_formatted_program_verification_submit C Function — Sends the S7F29 verification inquiry for a prepared result.
• pdcomm_gem_handle_event C Function — Processes one TCP event with the GEM role and returns an owned result.
• pdcomm_gem_host_acknowledge_alarm C Function — Sends the S5F2 Alarm Report Acknowledge for a received W=1 alarm report.
• pdcomm_gem_host_acknowledge_event C Function — Sends the Event Report Acknowledge (S6F12) for a received S6F11.
• pdcomm_gem_host_change_constants C Function — Sends a New Equipment Constant Send (S2F15) from a Host.
• pdcomm_gem_host_constant_request C Function — Sends an Equipment Constant Request (S2F13) or Namelist Request (S2F29) from a Host.
• pdcomm_gem_host_define_reports C Function — Sends a Define Report request (S2F33) from a Host.
• pdcomm_gem_host_directory_request C Function — Sends a Data Variable or Collection Event Namelist Request (S1F21 or S1F23) from a Host.
• pdcomm_gem_host_enable_alarm C Function — Sends S5F3 Enable/Disable Alarm Send from a Host.
• pdcomm_gem_host_enable_events C Function — Sends an Enable/Disable Event Report request (S2F37) from a Host.
• pdcomm_gem_host_enhanced_remote_command C Function — Sends S2F49 Enhanced Remote Command (W=1) from a Host.
• pdcomm_gem_host_link_reports C Function — Sends a Link Event Report request (S2F35) from a Host.
• pdcomm_gem_host_remote_command C Function — Sends S2F41 Host Command Send (W=1) from a Host.
• pdcomm_gem_host_report_query C Function — Sends an Event Report, Individual Report, or Annotated Individual Report request from a Host.
• pdcomm_gem_host_request C Function — Sends a host request to the equipment.
• pdcomm_gem_host_request_alarm_list C Function — Sends S5F5 List Alarms Request (W=1) from a Host.
• pdcomm_gem_host_request_enabled_alarm_list C Function — Sends S5F7 List Enabled Alarm Request (W=1) from a Host.
• pdcomm_gem_program_at C Function — Copies one stored program by position.
• pdcomm_gem_program_cancel_grant C Function — Cancels a grant activated by answering an S7F1.
• pdcomm_gem_program_confirm_reply C Function — Accepts an unconfirmed installation so its reply can be sent.
• pdcomm_gem_program_delete C Function — Sends an S7F17 delete process program send (Host only).
• pdcomm_gem_program_delete_local C Function — Deletes stored programs locally.
• pdcomm_gem_program_directory C Function — Sends a header-only S7F19 current EPPD request (Host only).
• pdcomm_gem_program_get C Function — Copies the body of a stored program by PPID.
• pdcomm_gem_program_grant C Function — Sends an S7F1 process program load inquire.
• pdcomm_gem_program_put C Function — Stores a program locally.
• pdcomm_gem_program_request C Function — Sends an S7F5 process program request.
• pdcomm_gem_program_respond C Function — Answers an incoming S7F1, F3, F5, F17, or F19 request.
• pdcomm_gem_program_resync C Function — Retries the parent directory synchronization of a file store.
• pdcomm_gem_program_send C Function — Sends an S7F3 process program send.
• pdcomm_gem_program_state C Function — Reads the usage of the program store.
• pdcomm_gem_result_alarm_at C Function — Reads one alarm tuple of a validated Host alarm result and copies its text.
• pdcomm_gem_result_alarm_info C Function — Reads the summary of a validated Host alarm report or alarm list result.
• pdcomm_gem_result_body C Function — Copies the SECS-II body of the message behind a result.
• pdcomm_gem_result_command_info C Function — Reads the summary of a remote command request or reply result.
• pdcomm_gem_result_command_issue C Function — Copies one CPACK entry of a command request validation or a received reply.
• pdcomm_gem_result_command_name C Function — Copies the RCMD item of a received S2F41 request.
• pdcomm_gem_result_command_parameter C Function — Copies one CPNAME/CPVAL pair of a received S2F41 request.
• pdcomm_gem_result_constant_change C Function — Copies one ECID/ECV pair of a received S2F15 and the value at receipt.
• pdcomm_gem_result_constant_change_info C Function — Reads the receipt validation and decision state of an S2F15 or S2F16 result.
• pdcomm_gem_result_constant_metadata C Function — Copies one metadata field of one entry of an S2F30 reply.
• pdcomm_gem_result_constant_value C Function — Copies one value, and its requested ID, from an S2F14 reply.
• pdcomm_gem_result_destroy C Function — Releases a result.
• pdcomm_gem_result_directory_at C Function — Reads the ID and VID count of one entry of a validated S1F22 or S1F24 reply.
• pdcomm_gem_result_directory_get C Function — Copies one field of one entry of a validated S1F22 or S1F24 reply.
• pdcomm_gem_result_enhanced_command_acknowledgements C Function — Copies the outer acknowledgement List of an enhanced command result.
• pdcomm_gem_result_enhanced_command_info C Function — Reads the summary of an enhanced command request or reply result.
• pdcomm_gem_result_enhanced_command_name C Function — Copies the RCMD item of a received S2F49 request.
• pdcomm_gem_result_enhanced_command_object C Function — Copies the OBJSPEC item of a received S2F49 request.
• pdcomm_gem_result_enhanced_command_parameter C Function — Copies one CPNAME/CEPVAL pair of a received S2F49 request.
• pdcomm_gem_result_event_info C Function — Reads the DATAID, CEID, report count, and acknowledgement state of a received S6F11.
• pdcomm_gem_result_event_report C Function — Reads the RPTID and value count of one report in a received S6F11.
• pdcomm_gem_result_event_value C Function — Copies one value of one report in a received S6F11.
• pdcomm_gem_result_formatted_program_capability_command_code_copy C Function — Copies the CCODE (command code) of one capability command.
• pdcomm_gem_result_formatted_program_capability_command_info C Function — Reads the fixed-size fields of one capability command.
• pdcomm_gem_result_formatted_program_capability_command_name_copy C Function — Copies the CNAME (command name) of one capability command.
• pdcomm_gem_result_formatted_program_capability_dependency_at C Function — Reads one value of a command's dependency vector.
• pdcomm_gem_result_formatted_program_capability_info C Function — Reads the summary of a capability result.
• pdcomm_gem_result_formatted_program_capability_model_copy C Function — Copies the MDLN (model name) of a capability result.
• pdcomm_gem_result_formatted_program_capability_parameter_get C Function — Copies one parameter descriptor of a capability command.
• pdcomm_gem_result_formatted_program_capability_software_revision_copy C Function — Copies the SOFTREV (software revision) of a capability result.
• pdcomm_gem_result_formatted_program_id_get C Function — Copies the PPID of a verification report as a new SECS-II item.
• pdcomm_gem_result_formatted_program_info C Function — Reads the summary of a verification report result.
• pdcomm_gem_result_formatted_program_issue_at C Function — Copies one issue of a verification report.
• pdcomm_gem_result_formatted_program_query_command_code_get C Function — Copies the CCODE of one returned command as a new SECS-II item.
• pdcomm_gem_result_formatted_program_query_command_info C Function — Reads the parameter count and CCODE format of one returned command.
• pdcomm_gem_result_formatted_program_query_id_get C Function — Copies the requested PPID of a query result as a new SECS-II item.
• pdcomm_gem_result_formatted_program_query_info C Function — Reads the summary of a query result.
• pdcomm_gem_result_formatted_program_query_model_copy C Function — Copies the MDLN of the program in a query result.
• pdcomm_gem_result_formatted_program_query_parameter_get C Function — Copies one PPARM of one returned command as a new SECS-II item.
• pdcomm_gem_result_formatted_program_query_software_revision_copy C Function — Copies the SOFTREV of the program in a query result.
• pdcomm_gem_result_formatted_program_transfer_command_code_get C Function — Copies the CCODE of one received command as a new SECS-II item.
• pdcomm_gem_result_formatted_program_transfer_command_info C Function — Reads the parameter count and CCODE format of one received command.
• pdcomm_gem_result_formatted_program_transfer_id_get C Function — Copies the PPID of a received S7F23 program as a new SECS-II item.
• pdcomm_gem_result_formatted_program_transfer_info C Function — Reads the summary of a transfer result.
• pdcomm_gem_result_formatted_program_transfer_model_copy C Function — Copies the MDLN of a received S7F23 program.
• pdcomm_gem_result_formatted_program_transfer_parameter_get C Function — Copies one PPARM of one received command as a new SECS-II item.
• pdcomm_gem_result_formatted_program_transfer_software_revision_copy C Function — Copies the SOFTREV of a received S7F23 program.
• pdcomm_gem_result_formatted_program_verification_negotiation_info C Function — Reads the negotiation details of a GEM result.
• pdcomm_gem_result_formatted_program_verification_request_command_code_get C Function — Copies the CCODE of one received command as a new SECS-II item.
• pdcomm_gem_result_formatted_program_verification_request_command_info C Function — Reads the parameter count and CCODE format of one received command.
• pdcomm_gem_result_formatted_program_verification_request_id_get C Function — Copies the PPID of a received S7F31 program as a new SECS-II item.
• pdcomm_gem_result_formatted_program_verification_request_info C Function — Reads the summary of a verification request result.
• pdcomm_gem_result_formatted_program_verification_request_model_copy C Function — Copies the MDLN of a received S7F31 program.
• pdcomm_gem_result_formatted_program_verification_request_parameter_get C Function — Copies one PPARM of one received command as a new SECS-II item.
• pdcomm_gem_result_formatted_program_verification_request_software_revision_copy C Function — Copies the SOFTREV of a received S7F31 program.
• pdcomm_gem_result_info C Function — Copies the fixed fields of a result.
• pdcomm_gem_result_program_info C Function — Reads the process program details of a GEM result.
• pdcomm_gem_result_program_item C Function — Copies a PPID or PPBODY from a program result.
• pdcomm_gem_result_query_info C Function — Reads the summary of a report query request or response.
• pdcomm_gem_result_query_report C Function — Reads the RPTID and value count of one report in an S6F16 reply.
• pdcomm_gem_result_query_value C Function — Copies one value of a report query response.
• pdcomm_gem_result_spool_error_at C Function — Reads one stream error from a received S2F44 (Host).
• pdcomm_gem_result_spool_info C Function — Reads the spooling details of a GEM result.
• pdcomm_gem_result_spool_selection_at C Function — Reads one stream selection from an S2F43 request or S2F60 reply.
• pdcomm_gem_result_status_name C Function — Copies one SVID, name, and units entry from an S1F12 result.
• pdcomm_gem_result_status_value C Function — Copies one status variable value from an S1F4 result.
• pdcomm_gem_spool_capture C Function — Offers a generic primary message to the spool.
• pdcomm_gem_spool_capture_alarm C Function — Builds an S5F1 alarm report and offers it to the spool.
• pdcomm_gem_spool_capture_event C Function — Builds an S6F11 event report and offers it to the spool.
• pdcomm_gem_spool_catalog_at C Function — Reads one catalog entry by position.
• pdcomm_gem_spool_complete_delivery C Function — Completes a delivery attempt and dequeues the head on success.
• pdcomm_gem_spool_configure_local C Function — Replaces the local spool policy and stream/function selection.
• pdcomm_gem_spool_confirm_reply C Function — Accepts an unconfirmed installation so its reply can be sent.
• pdcomm_gem_spool_entry_at C Function — Reads one spooled message by queue position.
• pdcomm_gem_spool_entry_time_at C Function — Reads the capture timestamp of one spooled message.
• pdcomm_gem_spool_purge C Function — Removes every spooled message locally.
• pdcomm_gem_spool_request_configure C Function — Sends an S2F43 reset spooling streams and functions request (Host).
• pdcomm_gem_spool_request_data C Function — Sends an S6F23 request spooled data (Host).
• pdcomm_gem_spool_request_query C Function — Sends a header-only S2F59 spool configuration request (Host).
• pdcomm_gem_spool_respond C Function — Answers an incoming S2F43, S2F59, or S6F23 request (Equipment).
• pdcomm_gem_spool_resync C Function — Retries the parent directory synchronization of a file spool.
• pdcomm_gem_spool_retry_dequeue C Function — Retries a pending dequeue after an accepted delivery.
• pdcomm_gem_spool_selection_at C Function — Reads one stream selection of the current local selection.
• pdcomm_gem_spool_send_next C Function — Sends the head of the spool queue during an accepted transmission.
• pdcomm_gem_spool_state C Function — Reads the current Equipment spool state.
• pdcomm_gem_spool_stop_transmit C Function — Ends the current transmission run.
• pdcomm_gem_spool_sync C Function — Synchronizes the spool with the current communication state.
• pdcomm_gem_state C Function — Reads the current GEM state of an endpoint.
• pdcomm_secs1_create C Function — Creates a stopped SECS-I endpoint.
• pdcomm_secs1_destroy C Function — Releases an endpoint without invoking callbacks.
• pdcomm_secs1_event_body C Function — Copies the body of an inbound event.
• pdcomm_secs1_event_destroy C Function — Releases an event.
• pdcomm_secs1_event_info C Function — Describes an event.
• pdcomm_secs1_next_event C Function — Takes the oldest queued event.
• pdcomm_secs1_poll C Function — Runs line control, timers, and callback I/O for one time slice.
• pdcomm_secs1_reset C Function — Clears a terminal fault so the endpoint can transfer messages again.
• pdcomm_secs1_start C Function — Starts a created or stopped endpoint.
• pdcomm_secs1_state C Function — Reads the identity and lifecycle flags of an endpoint.
• pdcomm_secs1_stop C Function — Stops a started endpoint and discards its runtime state.
• pdcomm_secs1_submit C Function — Queues one message for transmission.
• pdcomm_secs_child C Function — Copies one child of a List into a new, independent item.
• pdcomm_secs_decode C Function — Decodes exactly one SECS-II item from encoded bytes.
• pdcomm_secs_destroy C Function — Releases an item handle.
• pdcomm_secs_encode C Function — Encodes an item as SECS-II bytes into caller storage.
• pdcomm_secs_info C Function — Reads the format, element count, and size of an item.
• pdcomm_secs_list C Function — Creates a List item from copies of existing items.
• pdcomm_secs_payload C Function — Copies the raw payload bytes of a primitive item.
• pdcomm_secs_primitive C Function — Creates a primitive item from raw payload bytes.
• pdcomm_tcp_cancel C Function — Cancels an open transaction.
• pdcomm_tcp_create C Function — Creates an HSMS endpoint.
• pdcomm_tcp_deselect C Function — Sends Deselect.req to leave the SELECTED state.
• pdcomm_tcp_destroy C Function — Releases an endpoint and its sockets.
• pdcomm_tcp_event_body C Function — Copies the message body of a received event.
• pdcomm_tcp_event_destroy C Function — Releases an event.
• pdcomm_tcp_event_info C Function — Decodes the kind, codes, header, and token of an event.
• pdcomm_tcp_is_pending C Function — Reports whether a transaction is still waiting for its response.
• pdcomm_tcp_linktest C Function — Sends Linktest.req to check that the connection is alive.
• pdcomm_tcp_local_address C Function — Copies the local socket address as text.
• pdcomm_tcp_next_event C Function — Removes the oldest event from the endpoint's event queue.
• pdcomm_tcp_poll C Function — Performs pending socket I/O and HSMS timer processing.
• pdcomm_tcp_reply C Function — Submits the reply to a received primary that has the W-bit set.
• pdcomm_tcp_request C Function — Submits a primary data message.
• pdcomm_tcp_select C Function — Sends Select.req to enter the SELECTED state.
• pdcomm_tcp_start C Function — Starts a new connection generation.
• pdcomm_tcp_state C Function — Reads the endpoint identity, generation, HSMS state, and close status.
• pdcomm_tcp_stop C Function — Stops the endpoint and starts a graceful close.
• Gem300Capability C++ Struct — One capability declaration inside a profile, used as input to Gem300CapabilityCatalog::replace().
• Gem300Capability::axis C++ Field — Capability area; each axis may appear at most once per profile.
• Gem300Capability::id C++ Field — Capability identifier: 1 or more printable ASCII bytes (0x21 to 0x7E, no spaces), unique within its profile.
• Gem300Capability::status C++ Field — Declared maturity of the capability.
• Gem300CapabilityAxis C++ Enum — GEM300 capability area that a declared capability belongs to.
• Gem300CapabilityAxis::Carrier C++ Enumerator — Carrier management (the SEMI E87 area).
• Gem300CapabilityAxis::ControlJob C++ Enumerator — Control job management (the SEMI E94 area).
• Gem300CapabilityAxis::ProcessJob C++ Enumerator — Process job management (the SEMI E40 area).
• Gem300CapabilityAxis::Substrate C++ Enumerator — Substrate tracking (the SEMI E90 area).
• Gem300CapabilityCatalog C++ Class — Bounded, revisioned catalog of GEM300 capability declarations.
• Gem300CapabilityCatalog::Gem300CapabilityCatalog C++ Constructor — Takes ownership of the native handle owned by other.
• Gem300CapabilityCatalog::Gem300CapabilityCatalog C++ Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• Gem300CapabilityCatalog::Gem300CapabilityCatalog C++ Constructor — Creates an empty catalog with the given limits.
• Gem300CapabilityCatalog::clear C++ Method — Removes all profiles.
• Gem300CapabilityCatalog::info C++ Method — Returns the current revision and totals.
• Gem300CapabilityCatalog::nativeHandle C++ Method — Returns the owned native handle for direct C API calls.
• Gem300CapabilityCatalog::nativeHandle C++ Method — Returns the owned native handle for read-only C API calls.
• Gem300CapabilityCatalog::operator= C++ Method — Releases the current handle, then takes ownership of the handle owned by other.
• Gem300CapabilityCatalog::operator= C++ Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• Gem300CapabilityCatalog::replace C++ Method — Replaces the whole catalog with profiles.
• Gem300CapabilityCatalog::snapshot C++ Method — Copies the current contents into an independent snapshot.
• Gem300CapabilityCatalog::~Gem300CapabilityCatalog C++ Method — Releases the native handle with pdcomm_gem300_capability_catalog_destroy().
• Gem300CapabilityCatalogInfo C++ Struct — Summary of a catalog or snapshot.
• Gem300CapabilityCatalogInfo::capabilityCount C++ Field — Total number of capabilities across all profiles.
• Gem300CapabilityCatalogInfo::identifierBytes C++ Field — Total bytes of all profile and capability identifiers.
• Gem300CapabilityCatalogInfo::profileCount C++ Field — Number of profiles.
• Gem300CapabilityCatalogInfo::revision C++ Field — Revision counter. It starts at 0 and increases by one on every change.
• Gem300CapabilityInfo C++ Struct — Description of one capability in a snapshot.
• Gem300CapabilityInfo::axis C++ Field — Capability area.
• Gem300CapabilityInfo::idLength C++ Field — Length of the capability identifier in bytes.
• Gem300CapabilityInfo::status C++ Field — Declared status label.
• Gem300CapabilityInfo::verification C++ Field — Verification label; Gem300VerificationStatus::Unverified, the only defined value.
• Gem300CapabilityMutation C++ Struct — Result of Gem300CapabilityCatalog::replace() or Gem300CapabilityCatalog::clear().
• Gem300CapabilityMutation::changed C++ Field — true when the contents changed and the revision increased; false when the request matched the current contents.
• Gem300CapabilityMutation::revision C++ Field — Catalog revision after the call.
• Gem300CapabilityProfile C++ Struct — Named group of capability declarations, used as input to Gem300CapabilityCatalog::replace().
• Gem300CapabilityProfile::capabilities C++ Field — Capabilities in declaration order. Must contain 1 to max_capabilities_per_profile entries (at most 4) with distinct identifiers and axes.
• Gem300CapabilityProfile::id C++ Field — Profile identifier: 1 or more printable ASCII bytes (0x21 to 0x7E), unique in the catalog.
• Gem300CapabilityProfileInfo C++ Struct — Size information for one profile in a snapshot.
• Gem300CapabilityProfileInfo::capabilityCount C++ Field — Number of capabilities in the profile.
• Gem300CapabilityProfileInfo::idLength C++ Field — Length of the profile identifier in bytes.
• Gem300CapabilitySnapshot C++ Class — Immutable copy of a Gem300CapabilityCatalog at one revision.
• Gem300CapabilitySnapshot::Gem300CapabilitySnapshot C++ Constructor — Creates an empty snapshot that owns no native handle.
• Gem300CapabilitySnapshot::Gem300CapabilitySnapshot C++ Constructor — Takes ownership of the native handle owned by other.
• Gem300CapabilitySnapshot::Gem300CapabilitySnapshot C++ Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• Gem300CapabilitySnapshot::capabilityId C++ Method — Copies the identifier of one capability.
• Gem300CapabilitySnapshot::capabilityInfo C++ Method — Describes one capability of one profile.
• Gem300CapabilitySnapshot::info C++ Method — Returns the revision and totals captured in this snapshot.
• Gem300CapabilitySnapshot::nativeHandle C++ Method — Returns the owned native handle for read-only C API calls.
• Gem300CapabilitySnapshot::operator bool C++ Method — Reports whether the wrapper owns a native snapshot.
• Gem300CapabilitySnapshot::operator= C++ Method — Releases the current handle, then takes ownership of the handle owned by other.
• Gem300CapabilitySnapshot::operator= C++ Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• Gem300CapabilitySnapshot::profileId C++ Method — Copies the identifier of one profile.
• Gem300CapabilitySnapshot::profileInfo C++ Method — Returns size information for one profile.
• Gem300CapabilitySnapshot::~Gem300CapabilitySnapshot C++ Method — Releases the native handle with pdcomm_gem300_capability_snapshot_destroy().
• Gem300CapabilityStatus C++ Enum — Status label that an application declares for one of its capabilities.
• Gem300CapabilityStatus::Experimental C++ Enumerator — Label value 3 (experimental): the application runs this capability on trial.
• Gem300CapabilityStatus::ModelOnly C++ Enumerator — Label value 2 (model only): the application has a data model of this capability.
• Gem300CapabilityStatus::Planned C++ Enumerator — Label value 1 (planned): the application plans this capability.
• Gem300VerificationStatus C++ Enum — Verification label that the catalog stores for a capability.
• Gem300VerificationStatus::Unverified C++ Enumerator — Verification label value 1, currently the only defined value.
• GemAlarmChange C++ Struct — Effect of GemEquipment::observeAlarm().
• GemAlarmChange::active C++ Field — Active state after the call.
• GemAlarmChange::changed C++ Field — true when the active state changed.
• GemAlarmChange::eventId C++ Field — CEID for the transition; publish it separately if needed.
• GemAlarmChange::eventPresent C++ Field — true when the transition has a configured CEID in #eventId.
• GemAlarmChange::id C++ Field — Alarm ID (ALID).
• GemAlarmChange::reportingEnabled C++ Field — Whether the host has enabled reporting of this alarm, at the time of the call.
• GemAlarmDefinition C++ Struct — One alarm definition for GemEquipment::configureAlarms().
• GemAlarmDefinition::category C++ Field — Alarm category, 1 to 63; sent in the low bits of ALCD.
• GemAlarmDefinition::clearEvent C++ Field — CEID returned when the alarm becomes clear; it must exist in the report catalog.
• GemAlarmDefinition::clearEventPresent C++ Field — true when #clearEvent is used.
• GemAlarmDefinition::id C++ Field — Alarm ID (ALID).
• GemAlarmDefinition::setEvent C++ Field — CEID returned when the alarm becomes set; it must exist in the report catalog.
• GemAlarmDefinition::setEventPresent C++ Field — true when #setEvent is used.
• GemAlarmDefinition::text C++ Field — Alarm text (ALTX): ASCII, at most min(max_text_bytes, 120) bytes.
• GemAlarmInfo C++ Struct — One alarm of the equipment's alarm store, returned by GemEquipment::alarmAt().
• GemAlarmInfo::active C++ Field — true while the alarm is set.
• GemAlarmInfo::category C++ Field — Alarm category, 1 to 63.
• GemAlarmInfo::clearEvent C++ Field — CEID for the clear transition.
• GemAlarmInfo::clearEventPresent C++ Field — true when #clearEvent is configured.
• GemAlarmInfo::enabled C++ Field — true when the host enabled reporting of this alarm.
• GemAlarmInfo::id C++ Field — Alarm ID (ALID).
• GemAlarmInfo::setEvent C++ Field — CEID for the set transition.
• GemAlarmInfo::setEventPresent C++ Field — true when #setEvent is configured.
• GemAlarmInfo::text C++ Field — Alarm text (ALTX).
• GemAlarmResultInfo C++ Struct — Summary of a received S5F1 report or S5F6/S5F8 list, returned by GemResult::alarmInfo().
• GemAlarmResultInfo::acknowledged C++ Field — true after GemHost::acknowledgeAlarm() sent S5F2.
• GemAlarmResultInfo::count C++ Field — Number of alarms; 1 for an S5F1 report.
• GemAlarmResultInfo::isReport C++ Field — true for an S5F1 alarm report, false for a list reply.
• GemAlarmResultInfo::replyExpected C++ Field — W-bit of an S5F1 report; false for lists.
• GemAlarmState C++ Struct — Counters of the equipment's alarm store.
• GemAlarmState::activeCount C++ Field — Alarms currently set.
• GemAlarmState::alarmCount C++ Field — Defined alarms.
• GemAlarmState::enabledCount C++ Field — Alarms whose reporting the host enabled (S5F3).
• GemAlarmState::textBytes C++ Field — Total alarm text bytes.
• GemAlarmValue C++ Struct — One alarm from an S5F1 report or S5F6/S5F8 list, returned by GemResult::alarmAt().
• GemAlarmValue::active C++ Field — true when the ALCD set bit (bit 8) is on.
• GemAlarmValue::category C++ Field — Alarm category from ALCD, without the set bit.
• GemAlarmValue::id C++ Field — Alarm ID (ALID).
• GemAlarmValue::text C++ Field — Alarm text (ALTX).
• GemBindingInfo C++ Struct — One installed binding, returned by GemEquipment::bindingAt().
• GemBindingInfo::constantId C++ Field — ECID for a Constant source; an empty item otherwise.
• GemBindingInfo::constantIdPresent C++ Field — true when #constantId holds an item.
• GemBindingInfo::source C++ Field — Source store.
• GemBindingInfo::sourceId C++ Field — SVID or DVID; 0 for a Constant source.
• GemBindingInfo::variableId C++ Field — VID.
• GemBindingState C++ Struct — Counters of the report binding store.
• GemBindingState::bindingCount C++ Field — Installed bindings.
• GemBindingState::explicitMode C++ Field — true when explicit bindings are installed (even an empty set); false means VIDs resolve to status variables with the same ID.
• GemBindingState::identifierBytes C++ Field — Bytes used by constant IDs.
• GemCommandAcknowledgement C++ Enum — Host command acknowledgement (HCACK) for S2F42 and S2F50.
• GemCommandAcknowledgement::AcceptedForLater C++ Enumerator — HCACK 4: acknowledged; the command will be performed and completion signalled by an event.
• GemCommandAcknowledgement::AlreadyInCondition C++ Enumerator — HCACK 5: rejected, already in the desired condition.
• GemCommandAcknowledgement::CannotPerform C++ Enumerator — HCACK 2: cannot perform now.
• GemCommandAcknowledgement::Completed C++ Enumerator — HCACK 0: acknowledged, command performed.
• GemCommandAcknowledgement::NoSuchObject C++ Enumerator — HCACK 6: no such object exists.
• GemCommandAcknowledgement::ParameterErrors C++ Enumerator — HCACK 3: at least one parameter is invalid; the reply lists the issues.
• GemCommandAcknowledgement::Unknown C++ Enumerator — HCACK 1: command does not exist.
• GemCommandDefinition C++ Struct — One remote command (RCMD) definition for S2F41 or for an enhanced command object.
• GemCommandDefinition::completionEvent C++ Field — CEID reported back for HCACK 0 or 4; it must exist in the report catalog.
• GemCommandDefinition::completionEventPresent C++ Field — true when #completionEvent is used.
• GemCommandDefinition::name C++ Field — Command name: non-empty ASCII, or an integer scalar from -128 to 255. Borrowed.
• GemCommandDefinition::parameters C++ Field — Accepted parameters.
• GemCommandDefinition::requireOnlineRemote C++ Field — true when the command is only valid in GemControl::OnlineRemote.
• GemCommandInfo C++ Struct — One command definition, returned by GemEquipment::commandAt() and GemEquipment::enhancedCommandAt().
• GemCommandInfo::completionEvent C++ Field — Completion CEID.
• GemCommandInfo::completionEventPresent C++ Field — true when #completionEvent is configured.
• GemCommandInfo::name C++ Field — Command name; numeric names may be normalized to I8 or U8.
• GemCommandInfo::parameterCount C++ Field — Number of parameter definitions.
• GemCommandInfo::requireOnlineRemote C++ Field — true when the command needs GemControl::OnlineRemote.
• GemCommandIssue C++ Struct — One parameter error (CPNAME, CPACK) for an HCACK 3 reply. The name is borrowed.
• GemCommandIssue::code C++ Field — CPACK: 1 (unknown name), 2 (illegal value) or 3 (illegal format).
• GemCommandIssue::name C++ Field — Name of the faulty parameter.
• GemCommandIssueValue C++ Struct — One issue of a command result, returned by GemResult::commandIssue().
• GemCommandIssueValue::code C++ Field — CPACK code.
• GemCommandIssueValue::name C++ Field — Parameter name.
• GemCommandParameter C++ Struct — One parameter (CPNAME, CPVAL) for a host command request. Both items are borrowed.
• GemCommandParameter::name C++ Field — Parameter name item.
• GemCommandParameter::value C++ Field — Parameter value item. Enhanced commands also allow lists and floats.
• GemCommandParameterDefinition C++ Struct — One parameter (CPNAME) accepted by a remote command definition.
• GemCommandParameterDefinition::format C++ Field — Required SECS-II format code (PDCOMM_SECS_*). Numeric bounds need an integer format.
• GemCommandParameterDefinition::formatPresent C++ Field — true when #format restricts the value format.
• GemCommandParameterDefinition::maxCount C++ Field — Maximum element count of the value.
• GemCommandParameterDefinition::maximum C++ Field — Highest accepted numeric value; used when #maximumPresent is true.
• GemCommandParameterDefinition::maximumPresent C++ Field — true when #maximum applies.
• GemCommandParameterDefinition::minCount C++ Field — Minimum element count of the value.
• GemCommandParameterDefinition::minimum C++ Field — Lowest accepted numeric value; used when #minimumPresent is true.
• GemCommandParameterDefinition::minimumPresent C++ Field — true when #minimum applies.
• GemCommandParameterDefinition::name C++ Field — Parameter name: an ASCII item or an integer scalar item (any I or U format).
• GemCommandParameterDefinition::required C++ Field — true when the host must send this parameter.
• GemCommandParameterInfo C++ Struct — One parameter definition, returned by GemEquipment::commandParameterAt() and GemEquipment::enhancedCommandParameterAt().
• GemCommandParameterInfo::format C++ Field — Required SECS-II format code.
• GemCommandParameterInfo::formatPresent C++ Field — true when #format applies.
• GemCommandParameterInfo::maxCount C++ Field — Maximum element count.
• GemCommandParameterInfo::maximum C++ Field — Highest accepted value; valid when #maximumPresent is true.
• GemCommandParameterInfo::maximumPresent C++ Field — true when #maximum applies.
• GemCommandParameterInfo::minCount C++ Field — Minimum element count.
• GemCommandParameterInfo::minimum C++ Field — Lowest accepted value; valid when #minimumPresent is true.
• GemCommandParameterInfo::minimumPresent C++ Field — true when #minimum applies.
• GemCommandParameterInfo::name C++ Field — Parameter name; numeric names may be normalized to I8 or U8.
• GemCommandParameterInfo::required C++ Field — true when the parameter is mandatory.
• GemCommandParameterValue C++ Struct — One parameter of a received command request, returned by GemResult::commandParameter().
• GemCommandParameterValue::name C++ Field — Parameter name in its wire format.
• GemCommandParameterValue::value C++ Field — Parameter value in its wire format.
• GemCommandReply C++ Struct — What GemEquipment::respondCommand() or GemEquipment::respondEnhancedCommand() sent.
• GemCommandReply::acknowledgement C++ Field — HCACK actually sent; validation failures override the requested decision.
• GemCommandReply::completionEvent C++ Field — Completion CEID; publish the S6F11 event separately.
• GemCommandReply::completionEventPresent C++ Field — true when the sent HCACK (0 or 4) has a completion CEID to publish.
• GemCommandResultInfo C++ Struct — Summary of a received S2F41 request or S2F42 reply, returned by GemResult::commandInfo().
• GemCommandResultInfo::completionEvent C++ Field — Completion CEID of the command.
• GemCommandResultInfo::completionEventPresent C++ Field — true when the accepted command has a completion CEID.
• GemCommandResultInfo::isRequest C++ Field — true for an S2F41 request at the equipment, false for an S2F42 reply at the host.
• GemCommandResultInfo::issueCount C++ Field — Validation issues of a request, or CPACK entries of a reply.
• GemCommandResultInfo::parameterCount C++ Field — Request parameters; 0 for a reply.
• GemCommandResultInfo::responded C++ Field — true after GemEquipment::respondCommand() sent S2F42.
• GemCommandResultInfo::validationAccepted C++ Field — true when the library's validation at receipt accepted the request.
• GemCommandResultInfo::validationAcknowledgement C++ Field — HCACK chosen by validation at receipt; it overrides the application's decision when validation failed.
• GemCommandState C++ Struct — Counters of the equipment's remote command store.
• GemCommandState::commandCount C++ Field — Defined commands.
• GemCommandState::identifierBytes C++ Field — Total bytes of command and parameter names.
• GemCommandState::totalParameters C++ Field — Parameter definitions across all commands.
• GemCommunication C++ Enum — State of the SEMI E30 communication state model.
• GemCommunication::Communicating C++ Enumerator — Communication is established; GEM messages may flow.
• GemCommunication::Disconnected C++ Enumerator — No selected HSMS session exists.
• GemCommunication::NotCommunicating C++ Enumerator — An HSMS session is selected, but S1F13/F14 Establish Communications has not succeeded.
• GemCommunication::WaitingAck C++ Enumerator — S1F13 was sent and the S1F14 acknowledgement is pending.
• GemConstantChange C++ Struct — One (ECID, ECV) pair for S2F15, sent by GemHost::changeConstants(). Both items are borrowed.
• GemConstantChange::id C++ Field — Equipment constant ID.
• GemConstantChange::value C++ Field — New value.
• GemConstantChangeInfo C++ Struct — Summary of a received S2F15 request or S2F16 reply, returned by GemResult::constantChangeInfo().
• GemConstantChangeInfo::applied C++ Field — true when an EAC 0 reply swapped in the new values.
• GemConstantChangeInfo::changeCount C++ Field — Number of (ECID, ECV) pairs in the request; 0 for a reply.
• GemConstantChangeInfo::isRequest C++ Field — true for an S2F15 request at the equipment; false for an S2F16 reply.
• GemConstantChangeInfo::responded C++ Field — true after GemEquipment::respondConstants() sent S2F16.
• GemConstantChangeInfo::validationAccepted C++ Field — true when validation at receipt accepted the request.
• GemConstantChangeInfo::validationAcknowledgement C++ Field — EAC chosen by validation at receipt.
• GemConstantChangeValue C++ Struct — One proposed change of a received S2F15, returned by GemResult::constantChange().
• GemConstantChangeValue::id C++ Field — ECID as received.
• GemConstantChangeValue::original C++ Field — Value at receipt; an empty item when #originalPresent is false.
• GemConstantChangeValue::originalPresent C++ Field — false when the ECID is unknown.
• GemConstantChangeValue::value C++ Field — Proposed value as received.
• GemConstantDecision C++ Enum — Equipment acknowledgement (EAC) chosen for a received S2F15.
• GemConstantDecision::Apply C++ Enumerator — EAC 0: accept and apply the changes to the SDK store.
• GemConstantDecision::CannotPerform C++ Enumerator — EAC 2: busy, cannot perform now.
• GemConstantDecision::OutOfRange C++ Enumerator — EAC 3: at least one value is out of range.
• GemConstantDefinition C++ Struct — One equipment constant definition for GemEquipment::configureConstants().
• GemConstantDefinition::current C++ Field — Current value (ECV); its format and count are kept as declared.
• GemConstantDefinition::defaultValue C++ Field — Default value (ECDEF), or nullptr when absent.
• GemConstantDefinition::id C++ Field — ECID: case-sensitive ASCII (empty allowed) or a scalar integer item.
• GemConstantDefinition::maxCount C++ Field — Maximum element count accepted for new values.
• GemConstantDefinition::maximum C++ Field — Maximum (ECMAX), or nullptr when absent.
• GemConstantDefinition::minCount C++ Field — Minimum element count accepted for new values.
• GemConstantDefinition::minimum C++ Field — Minimum (ECMIN), or nullptr when absent. Lists cannot have bounds.
• GemConstantDefinition::name C++ Field — ECNAME, ASCII.
• GemConstantDefinition::units C++ Field — Units, ASCII.
• GemConstantField C++ Enum — Field of an equipment constant definition or namelist row.
• GemConstantField::Current C++ Enumerator — Current value (ECV). Valid only for local equipment reads, not for S2F30 rows.
• GemConstantField::Default C++ Enumerator — Default value (ECDEF).
• GemConstantField::Id C++ Enumerator — Equipment constant ID (ECID).
• GemConstantField::Maximum C++ Enumerator — Maximum value (ECMAX).
• GemConstantField::Minimum C++ Enumerator — Minimum value (ECMIN).
• GemConstantField::Name C++ Enumerator — Name (ECNAME), an ASCII item.
• GemConstantField::Units C++ Enumerator — Units, an ASCII item.
• GemConstantInfo C++ Struct — One constant definition, returned by GemEquipment::constantAt().
• GemConstantInfo::defaultPresent C++ Field — true when a default value is defined.
• GemConstantInfo::format C++ Field — Declared SECS-II format code of the value.
• GemConstantInfo::id C++ Field — ECID item; numeric IDs may be normalized to I8 or U8.
• GemConstantInfo::maxCount C++ Field — Maximum element count.
• GemConstantInfo::maximumPresent C++ Field — true when a maximum is defined.
• GemConstantInfo::minCount C++ Field — Minimum element count.
• GemConstantInfo::minimumPresent C++ Field — true when a minimum is defined.
• GemConstantReply C++ Struct — What GemEquipment::respondConstants() sent.
• GemConstantReply::acknowledgement C++ Field — EAC actually sent; a failed validation keeps its original EAC.
• GemConstantReply::applied C++ Field — true when the SDK store now holds the new values.
• GemConstantRequest C++ Enum — Kind of equipment constant query sent by GemHost::constantRequest().
• GemConstantRequest::Metadata C++ Enumerator — S2F29 Equipment Constant Namelist Request (names, limits, defaults and units).
• GemConstantRequest::Values C++ Enumerator — S2F13 Equipment Constant Request (current values).
• GemConstantState C++ Struct — Counters of the equipment constant store.
• GemConstantState::constantCount C++ Field — Defined constants.
• GemConstantState::metadataBytes C++ Field — Bytes used by IDs, names and units.
• GemConstantState::valueBytes C++ Field — Bytes used by values and bounds.
• GemConstantValue C++ Struct — One value from an S2F14 reply, returned by GemResult::constantValue().
• GemConstantValue::id C++ Field — Requested ECID; an empty item when #idPresent is false.
• GemConstantValue::idPresent C++ Field — true for replies to an explicit ID list; a request for all values has no IDs on the wire.
• GemConstantValue::value C++ Field — Value item. An empty list alone does not prove the ECID is unknown.
• GemControl C++ Enum — State of the SEMI E30 control state model of the equipment.
• GemControl::AttemptOnline C++ Enumerator — The equipment sent S1F1 after an operator online request and waits for S1F2.
• GemControl::EquipmentOffline C++ Enumerator — Offline, chosen at the equipment.
• GemControl::HostOffline C++ Enumerator — Offline at the host's request (S1F15), or after an operator online attempt (S1F1) failed or lost its connection. Only this state accepts S1F17 Request ON-LINE.
• GemControl::OnlineLocal C++ Enumerator — Online in the local substate; the host has limited control.
• GemControl::OnlineRemote C++ Enumerator — Online in the remote substate; the host may control the equipment.
• GemControl::Unavailable C++ Enumerator — No control state exists, which is the case for the host role.
• GemDataDefinition C++ Struct — One data variable definition for GemEquipment::configureDataVariables().
• GemDataDefinition::cached C++ Field — Initial cached value, or nullptr for no cache. Borrowed during the call.
• GemDataDefinition::format C++ Field — Declared top-level SECS-II format code; every format is allowed.
• GemDataDefinition::id C++ Field — Data variable ID (DVID).
• GemDataDefinition::maxCount C++ Field — Maximum element count of values.
• GemDataDefinition::minCount C++ Field — Minimum element count of values.
• GemDataDefinition::name C++ Field — Name, ASCII.
• GemDataDefinition::units C++ Field — Units, ASCII.
• GemDataField C++ Enum — Field of a data variable read by GemEquipment::data().
• GemDataField::Cached C++ Enumerator — Cached value; an empty item when no value is cached.
• GemDataField::Name C++ Enumerator — Variable name, an ASCII item.
• GemDataField::Units C++ Enumerator — Units, an ASCII item.
• GemDataInfo C++ Struct — One data variable, returned by GemEquipment::dataAt().
• GemDataInfo::cachedPresent C++ Field — true when a cached value is available.
• GemDataInfo::format C++ Field — Declared SECS-II format code.
• GemDataInfo::id C++ Field — Data variable ID.
• GemDataInfo::maxCount C++ Field — Maximum element count.
• GemDataInfo::minCount C++ Field — Minimum element count.
• GemDataSample C++ Struct — A value sampled for one data variable, used when building a report. Borrowed.
• GemDataSample::id C++ Field — Data variable ID (DVID).
• GemDataSample::value C++ Field — Sampled value. Samples never change the cached value.
• GemDataState C++ Struct — Counters of the data variable store.
• GemDataState::metadataBytes C++ Field — Bytes used by names and units.
• GemDataState::valueBytes C++ Field — Bytes used by cached values.
• GemDataState::variableCount C++ Field — Defined data variables.
• GemDirectoryDefinition C++ Struct — One collection event of the equipment's event directory (S1F24 row).
• GemDirectoryDefinition::id C++ Field — Collection event ID (CEID); must exist in the report catalog.
• GemDirectoryDefinition::name C++ Field — Event name, ASCII; may be empty.
• GemDirectoryDefinition::variableIds C++ Field — VIDs associated with the event; each must be bound to a data variable.
• GemDirectoryEntryInfo C++ Struct — One namelist row, returned by GemResult::directoryAt() and GemEquipment::directoryAt().
• GemDirectoryEntryInfo::id C++ Field — DVID or CEID of the row.
• GemDirectoryEntryInfo::variableCount C++ Field — VIDs of an event row; 0 for data rows.
• GemDirectoryField C++ Enum — Field of a namelist row.
• GemDirectoryField::Name C++ Enumerator — Name of the variable or event, an ASCII item.
• GemDirectoryField::Units C++ Enumerator — Units of a data variable, an ASCII item. Not valid for event rows.
• GemDirectoryField::VariableIds C++ Enumerator — VIDs linked to a collection event, a U4 array item. Not valid for data rows.
• GemDirectoryKind C++ Enum — Kind of namelist requested by GemHost::directoryRequest().
• GemDirectoryKind::Data C++ Enumerator — S1F21 Data Variable Namelist Request.
• GemDirectoryKind::Event C++ Enumerator — S1F23 Collection Event Namelist Request.
• GemDirectoryState C++ Struct — State of the event directory, returned by GemEquipment::directoryState().
• GemDirectoryState::configured C++ Field — true once a directory was configured; an empty configured directory differs from none.
• GemDirectoryState::eventCount C++ Field — Directory rows.
• GemDirectoryState::metadataBytes C++ Field — Bytes used by names.
• GemDirectoryState::totalVariables C++ Field — VIDs across all rows.
• GemEndpoint C++ Class — Common base of GemHost and GemEquipment: one HSMS endpoint with a GEM role.
• GemEndpoint::GemEndpoint C++ Constructor — Moves the endpoint; the source no longer owns a native endpoint.
• GemEndpoint::GemEndpoint C++ Constructor — Copying is disabled; the endpoint exclusively owns its native handle.
• GemEndpoint::cancelProgramGrant C++ Method — Cancels the S7F1 grant activated by result.
• GemEndpoint::completeSpoolDelivery C++ Method — Finishes a spooled delivery attempt and, on success, removes the head entry.
• GemEndpoint::configurePrograms C++ Method — Attaches the process program store and enables stream 7 program transfers.
• GemEndpoint::confirmProgramReply C++ Method — Accepts an unconfirmed installation so that its retained reply can be sent.
• GemEndpoint::confirmSpoolReply C++ Method — Accepts an unconfirmed spool installation so that its retained reply can be sent.
• GemEndpoint::handle C++ Method — Alias of handleEvent().
• GemEndpoint::handleEvent C++ Method — Processes one TCP event with the GEM layer.
• GemEndpoint::nextEvent C++ Method — Takes the next queued TCP event; forwards to TcpEndpoint::nextEvent().
• GemEndpoint::operator= C++ Method — Destroys the current native endpoint, then takes over the one owned by the source.
• GemEndpoint::operator= C++ Method — Copy assignment is disabled; the endpoint exclusively owns its native handle.
• GemEndpoint::poll C++ Method — Drives the HSMS endpoint; forwards to TcpEndpoint::poll().
• GemEndpoint::program C++ Method — Returns a copy of the body stored under id.
• GemEndpoint::programAt C++ Method — Returns a copy of one stored program in store order.
• GemEndpoint::programDeleteLocal C++ Method — Deletes programs from the local store.
• GemEndpoint::programGrant C++ Method — Sends S7F1 Process Program Load Inquire.
• GemEndpoint::programPut C++ Method — Writes one program to the local store.
• GemEndpoint::programRequest C++ Method — Sends S7F5 Process Program Request.
• GemEndpoint::programSend C++ Method — Sends S7F3 Process Program Send.
• GemEndpoint::programState C++ Method — Returns counters of the process program store.
• GemEndpoint::respondProgram C++ Method — Replies to a received process program request and returns the native status.
• GemEndpoint::respondSpool C++ Method — Replies to a received spool request and returns the native status.
• GemEndpoint::resyncPrograms C++ Method — Retries synchronization of the program file's parent directory.
• GemEndpoint::resyncSpool C++ Method — Retries synchronization of the spool file's parent directory.
• GemEndpoint::retrySpoolDequeue C++ Method — Retries removing an entry whose delivery was accepted but whose dequeue failed.
• GemEndpoint::sendNextSpool C++ Method — Sends the message at the head of the spool during an accepted transmit run.
• GemEndpoint::spoolCatalogAt C++ Method — Returns one registered spoolable stream and function pair.
• GemEndpoint::spoolEntryAt C++ Method — Returns a copy of one stored spool entry in queue order, including its capture time.
• GemEndpoint::spoolSelectionAt C++ Method — Returns one selected stream of the current spooling selection.
• GemEndpoint::spoolState C++ Method — Returns the state of the equipment spool.
• GemEndpoint::start C++ Method — Starts the HSMS endpoint; forwards to TcpEndpoint::start().
• GemEndpoint::state C++ Method — Returns the current GEM state.
• GemEndpoint::stop C++ Method — Stops the HSMS endpoint; forwards to TcpEndpoint::stop().
• GemEndpoint::stopSpoolTransmit C++ Method — Ends the current transmit run.
• GemEndpoint::tcp C++ Method — Returns the underlying HSMS endpoint.
• GemEndpoint::tcp C++ Method — Returns the underlying HSMS endpoint for read-only calls.
• GemEnhancedCommandResultInfo C++ Struct — Summary of a received S2F49 request or S2F50 reply, returned by GemResult::enhancedCommandInfo().
• GemEnhancedCommandResultInfo::completionEvent C++ Field — Completion CEID of the command.
• GemEnhancedCommandResultInfo::completionEventPresent C++ Field — true when the accepted command has a completion CEID.
• GemEnhancedCommandResultInfo::dataId C++ Field — DATAID of the request; 0 for a reply.
• GemEnhancedCommandResultInfo::isRequest C++ Field — true for an S2F49 request at the equipment, false for an S2F50 reply.
• GemEnhancedCommandResultInfo::issueCount C++ Field — Validation issues of a request, or outer acknowledgement entries of a reply.
• GemEnhancedCommandResultInfo::parameterCount C++ Field — Request parameters; 0 for a reply.
• GemEnhancedCommandResultInfo::responded C++ Field — true after GemEquipment::respondEnhancedCommand() sent S2F50.
• GemEnhancedCommandResultInfo::validationAccepted C++ Field — true when admission and validation at receipt accepted the request.
• GemEnhancedCommandResultInfo::validationAcknowledgement C++ Field — HCACK chosen at receipt; it overrides the application's decision when validation failed.
• GemEnhancedCommandState C++ Struct — Counters of the equipment's enhanced remote command store.
• GemEnhancedCommandState::commandCount C++ Field — Commands across all objects.
• GemEnhancedCommandState::identifierBytes C++ Field — Total bytes of command and parameter names.
• GemEnhancedCommandState::objectCount C++ Field — Defined objects.
• GemEnhancedCommandState::totalObjectBytes C++ Field — Total bytes of object specifiers.
• GemEnhancedCommandState::totalParameters C++ Field — Parameter definitions across all commands.
• GemEnhancedObjectDefinition C++ Struct — One object (OBJSPEC) with its enhanced remote commands, for GemEquipment::configureEnhancedCommands().
• GemEnhancedObjectDefinition::commands C++ Field — Commands accepted for this object.
• GemEnhancedObjectDefinition::name C++ Field — Object specifier: an exact, case-sensitive ASCII item (may be empty). Borrowed.
• GemEnhancedObjectInfo C++ Struct — One object, returned by GemEquipment::enhancedObjectAt().
• GemEnhancedObjectInfo::commandCount C++ Field — Commands defined for the object.
• GemEnhancedObjectInfo::name C++ Field — Object specifier item.
• GemEquipment C++ Class — GEM equipment role (SEMI E30) on one HSMS endpoint (SEMI E37).
• GemEquipment::GemEquipment C++ Constructor — Takes ownership of endpoint and configures it as GEM equipment from an options struct.
• GemEquipment::GemEquipment C++ Constructor — Takes ownership of endpoint and configures it as GEM equipment.
• GemEquipment::alarmAt C++ Method — Returns one alarm in registration order.
• GemEquipment::alarmState C++ Method — Returns counters of the alarm store.
• GemEquipment::bindingAt C++ Method — Returns one binding in stored order.
• GemEquipment::bindingState C++ Method — Returns the state of the binding store.
• GemEquipment::captureSpool C++ Method — Offers a generic primary message to the spool.
• GemEquipment::captureSpoolAlarm C++ Method — Builds the S5F1 report for an alarm's current state and offers it to the spool.
• GemEquipment::captureSpoolEvent C++ Method — Builds the S6F11 report for a collection event and offers it to the spool.
• GemEquipment::clearDataVariable C++ Method — Removes the cached value of a data variable.
• GemEquipment::clearReportBindings C++ Method — Removes all bindings and restores the default VID-equals-SVID resolution.
• GemEquipment::commandAt C++ Method — Returns one command definition in stored order.
• GemEquipment::commandParameterAt C++ Method — Returns one parameter definition of one command.
• GemEquipment::commandState C++ Method — Returns counters of the remote command store.
• GemEquipment::configureAlarms C++ Method — Creates the alarm store.
• GemEquipment::configureCommands C++ Method — Creates the remote command (S2F41) store.
• GemEquipment::configureConstants C++ Method — Creates the equipment constant (ECID) store.
• GemEquipment::configureDataVariables C++ Method — Installs or replaces the complete data variable (DVID) store.
• GemEquipment::configureEnhancedCommands C++ Method — Creates the enhanced remote command (S2F49) store.
• GemEquipment::configureEventDirectory C++ Method — Installs or replaces the collection event namelist answered for S1F23.
• GemEquipment::configureFixedCatalog C++ Method — Atomically installs a fixed report graph and its STATUS or DATA bindings.
• GemEquipment::configureLocalSpooling C++ Method — Sets the local spooling policy and stream selection.
• GemEquipment::configureReportBindings C++ Method — Installs or replaces the VID-to-source bindings used to build reports.
• GemEquipment::configureReports C++ Method — Creates the report store and declares the collection events (CEIDs).
• GemEquipment::configureSpooling C++ Method — Attaches the equipment spool.
• GemEquipment::constant C++ Method — Returns one field of a local constant definition.
• GemEquipment::constantAt C++ Method — Returns one constant definition in stored order.
• GemEquipment::constantState C++ Method — Returns counters of the constant store.
• GemEquipment::data C++ Method — Returns the name, units or cached value of a data variable.
• GemEquipment::dataAt C++ Method — Returns one data variable definition in stored order.
• GemEquipment::dataState C++ Method — Returns counters of the data variable store.
• GemEquipment::directory C++ Method — Alias of directoryGet().
• GemEquipment::directoryAt C++ Method — Returns one event directory row in stored order.
• GemEquipment::directoryGet C++ Method — Returns the name or VID list of one event directory row.
• GemEquipment::directoryState C++ Method — Returns the state of the event directory.
• GemEquipment::enhancedCommandAt C++ Method — Returns one command of one enhanced object.
• GemEquipment::enhancedCommandParameterAt C++ Method — Returns one parameter definition of one enhanced command.
• GemEquipment::enhancedCommandState C++ Method — Returns counters of the enhanced remote command store.
• GemEquipment::enhancedObjectAt C++ Method — Returns one object of the enhanced command store.
• GemEquipment::eventAt C++ Method — Returns one collection event in stored order.
• GemEquipment::observeAlarm C++ Method — Records the current set or clear state of an alarm without sending anything.
• GemEquipment::operatorOffline C++ Method — Moves the equipment offline at the operator's request (the OFF-LINE switch).
• GemEquipment::operatorOnline C++ Method — Starts an operator-initiated transition to online by sending S1F1.
• GemEquipment::publishAlarm C++ Method — Sends S5F1 Alarm Report Send with the alarm's current state.
• GemEquipment::publishEvent C++ Method — Sends S6F11 Event Report Send for an enabled collection event.
• GemEquipment::publishEventWithData C++ Method — Sends S6F11 using supplied samples first, then caches, for an enabled event.
• GemEquipment::purgeSpool C++ Method — Deletes all stored spool entries locally.
• GemEquipment::registerStatus C++ Method — Registers a status variable (SVID) with its name, units and initial value.
• GemEquipment::reportAt C++ Method — Returns one defined report in stored order.
• GemEquipment::reportState C++ Method — Returns counters of the report store.
• GemEquipment::reportValue C++ Method — Resolves the current report value of a VID from its source.
• GemEquipment::respondCommand C++ Method — Sends S2F42 for a received S2F41.
• GemEquipment::respondConstants C++ Method — Sends S2F16 for a received S2F15 using a named decision.
• GemEquipment::respondConstants C++ Method — Sends S2F16 for a received S2F15.
• GemEquipment::respondEnhancedCommand C++ Method — Sends S2F50 for a received S2F49.
• GemEquipment::respondReportQuery C++ Method — Answers a received S6F15, S6F19 or S6F21 with S6F16, S6F20 or S6F22.
• GemEquipment::setOnlineMode C++ Method — Sets the operator's REMOTE/LOCAL switch.
• GemEquipment::status C++ Method — Returns a copy of the current value of a status variable.
• GemEquipment::statusIdAt C++ Method — Returns the SVID at a position in registration order.
• GemEquipment::statusMetadata C++ Method — Returns the registered name and units of a status variable.
• GemEquipment::syncSpool C++ Method — Synchronizes the spool with the current communication state.
• GemEquipment::updateDataVariable C++ Method — Replaces the cached value of a data variable.
• GemEquipment::updateStatus C++ Method — Replaces the current value of a registered status variable.
• GemEventDefinition C++ Struct — One collection event, returned by GemEquipment::eventAt().
• GemEventDefinition::enabled C++ Field — true when the host enabled the event report (S2F37).
• GemEventDefinition::id C++ Field — Collection event ID (CEID).
• GemEventDefinition::reportIds C++ Field — Linked report IDs in link order.
• GemEventDirectoryDefinition C++ Typedef — Alias of GemDirectoryDefinition.
• GemEventInfo C++ Struct — Header of a received S6F11 event report, returned by GemResult::eventInfo().
• GemEventInfo::acknowledged C++ Field — true after GemHost::acknowledgeEvent() sent S6F12.
• GemEventInfo::dataId C++ Field — Data ID (DATAID).
• GemEventInfo::eventId C++ Field — Collection event ID (CEID).
• GemEventInfo::reportCount C++ Field — Number of reports in the message.
• GemEventReport C++ Struct — One report inside a received S6F11, returned by GemResult::eventReport().
• GemEventReport::id C++ Field — Report ID (RPTID).
• GemEventReport::valueCount C++ Field — Number of values. Values carry no VIDs; map positions using the report definition.
• GemFixedEventSpec C++ Struct — One collection event of a fixed report catalog, for GemEquipment::configureFixedCatalog().
• GemFixedEventSpec::enabled C++ Field — Initial enabled state of the event report.
• GemFixedEventSpec::id C++ Field — Collection event ID (CEID).
• GemFixedEventSpec::reportIds C++ Field — Linked report IDs, in order.
• GemFormattedProgramCapabilityCommand C++ Struct — One command description of the equipment's S7F22 Process Capability Data.
• GemFormattedProgramCapabilityCommand::after C++ Field — ACDS: the command this command must come after.
• GemFormattedProgramCapabilityCommand::before C++ Field — BCDS: commands this command must come before.
• GemFormattedProgramCapabilityCommand::blockDefinition C++ Field — BLKDEF: -1 (ends a block), 0 (not a block) or 1 (starts a block).
• GemFormattedProgramCapabilityCommand::code C++ Field — Command code (CCODE), ASCII, at most maxCommandCodeBytes bytes.
• GemFormattedProgramCapabilityCommand::immediateAfter C++ Field — IACDS: commands this command must come immediately after.
• GemFormattedProgramCapabilityCommand::immediateBefore C++ Field — IBCDS: commands this command must come immediately before.
• GemFormattedProgramCapabilityCommand::name C++ Field — Command name (CNAME), ASCII, at most 16 bytes.
• GemFormattedProgramCapabilityCommand::nonAfter C++ Field — NACDS: commands this command must not come after.
• GemFormattedProgramCapabilityCommand::nonBefore C++ Field — NBCDS: commands this command must not come before.
• GemFormattedProgramCapabilityCommand::parameters C++ Field — Parameter descriptions; each is a list item with 4, 5 or 9 elements. Borrowed during the replace call.
• GemFormattedProgramCapabilityCommand::required C++ Field — RQCMD: true when every process program must contain this command.
• GemFormattedProgramCapabilityCommandInfo C++ Struct — Shape of one command description of an S7F22 reply, returned by formattedProgramCapabilityCommandInfo().
• GemFormattedProgramCapabilityCommandInfo::after C++ Field — ACDS value.
• GemFormattedProgramCapabilityCommandInfo::beforeCount C++ Field — Entries in BCDS.
• GemFormattedProgramCapabilityCommandInfo::blockDefinition C++ Field — BLKDEF of the command (-1, 0 or 1).
• GemFormattedProgramCapabilityCommandInfo::immediateAfterCount C++ Field — Entries in IACDS.
• GemFormattedProgramCapabilityCommandInfo::immediateBeforeCount C++ Field — Entries in IBCDS.
• GemFormattedProgramCapabilityCommandInfo::nonAfterCount C++ Field — Entries in NACDS.
• GemFormattedProgramCapabilityCommandInfo::nonBeforeCount C++ Field — Entries in NBCDS.
• GemFormattedProgramCapabilityCommandInfo::parameterCount C++ Field — Parameter descriptions of the command.
• GemFormattedProgramCapabilityCommandInfo::required C++ Field — RQCMD of the command.
• GemFormattedProgramCapabilityInfo C++ Struct — Summary of an S7F21 request or S7F22 reply, returned by formattedProgramCapabilityInfo().
• GemFormattedProgramCapabilityInfo::byteMaximum C++ Field — BYTMAX of an S7F22 reply: maximum bytes of one process program.
• GemFormattedProgramCapabilityInfo::commandCount C++ Field — Command descriptions in an S7F22 reply; 0 for a request.
• GemFormattedProgramCapabilityInfo::commandMaximum C++ Field — CMDMAX of an S7F22 reply: maximum commands in one process program.
• GemFormattedProgramCapabilityInfo::isRequest C++ Field — true for an S7F21 received by the equipment.
• GemFormattedProgramCapabilityInfo::replyReady C++ Field — true while a received S7F21 still waits for a response.
• GemFormattedProgramCapabilityInfo::request C++ Field — Always GemRequest::FormattedProgramCapabilitySend.
• GemFormattedProgramCapabilityInfo::responded C++ Field — true after respondFormattedProgramCapability() sent S7F22.
• GemFormattedProgramDryRunInfo C++ Struct — Summary of a dry-run report, returned by GemFormattedProgramDryRunReport::info().
• GemFormattedProgramDryRunInfo::capabilityPresent C++ Field — true when an S7F22 capability catalog was available for the comparison.
• GemFormattedProgramDryRunInfo::capabilityRevision C++ Field — Revision of the capability catalog used for the comparison.
• GemFormattedProgramDryRunInfo::commandCount C++ Field — Commands of the analysed program.
• GemFormattedProgramDryRunInfo::encodedBytes C++ Field — Encoded size of the analysed program.
• GemFormattedProgramDryRunInfo::endpointId C++ Field — Endpoint that produced the report.
• GemFormattedProgramDryRunInfo::entryGeneration C++ Field — Entry generation of that selection.
• GemFormattedProgramDryRunInfo::idFormat C++ Field — SECS-II format code of the PPID.
• GemFormattedProgramDryRunInfo::issueCount C++ Field — Issues in the report.
• GemFormattedProgramDryRunInfo::outcome C++ Field — Overall result, the most severe issue outcome: PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_PASS, ..._INDETERMINATE or ..._REJECT.
• GemFormattedProgramDryRunInfo::policyVersion C++ Field — Policy used, for example PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_POLICY_V1.
• GemFormattedProgramDryRunInfo::selectionGeneration C++ Field — Selection revision of that selection.
• GemFormattedProgramDryRunInfo::sessionGeneration C++ Field — Connection generation of the selection that was analysed.
• GemFormattedProgramDryRunInfo::storeRevision C++ Field — Store revision of that selection.
• GemFormattedProgramDryRunIssueInfo C++ Struct — One finding of a dry-run report, returned by GemFormattedProgramDryRunReport::issue().
• GemFormattedProgramDryRunIssueInfo::code C++ Field — Finding code, for example PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_CAPABILITY_MISSING, ..._MODEL_MISMATCH, ..._COMMAND_COUNT_EXCEEDED, ..._UNKNOWN_ASCII_COMMAND or ..._DEPENDENCY_UNVERIFIED.
• GemFormattedProgramDryRunIssueInfo::commandIndex C++ Field — Program command the finding refers to; valid when its presence bit is set.
• GemFormattedProgramDryRunIssueInfo::expected C++ Field — Expected limit or value; valid when its presence bit is set.
• GemFormattedProgramDryRunIssueInfo::fieldIndex C++ Field — Field or parameter position the finding refers to; valid when its presence bit is set.
• GemFormattedProgramDryRunIssueInfo::observed C++ Field — Observed value, such as a command count or byte count; valid when its presence bit is set.
• GemFormattedProgramDryRunIssueInfo::outcome C++ Field — Severity of this finding: ..._PASS, ..._INDETERMINATE or ..._REJECT.
• GemFormattedProgramDryRunIssueInfo::presenceMask C++ Field — Which optional fields are set: PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_ISSUE_COMMAND_INDEX_PRESENT, ..._FIELD_INDEX_PRESENT, ..._OBSERVED_PRESENT and ..._EXPECTED_PRESENT bits.
• GemFormattedProgramDryRunReport C++ Class — Read-only structural analysis of the selected formatted program.
• GemFormattedProgramDryRunReport::GemFormattedProgramDryRunReport C++ Constructor — Creates an empty report that owns no native handle.
• GemFormattedProgramDryRunReport::GemFormattedProgramDryRunReport C++ Constructor — Takes ownership of the native handle owned by other.
• GemFormattedProgramDryRunReport::GemFormattedProgramDryRunReport C++ Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramDryRunReport::info C++ Method — Returns the summary of the report.
• GemFormattedProgramDryRunReport::issue C++ Method — Returns one finding of the report.
• GemFormattedProgramDryRunReport::model C++ Method — Copies the MDLN of the analysed program.
• GemFormattedProgramDryRunReport::nativeHandle C++ Method — Returns the owned native handle for read-only C API calls.
• GemFormattedProgramDryRunReport::operator bool C++ Method — Reports whether the wrapper owns a native report.
• GemFormattedProgramDryRunReport::operator= C++ Method — Releases the current handle, then takes ownership of the handle owned by other.
• GemFormattedProgramDryRunReport::operator= C++ Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramDryRunReport::programId C++ Method — Returns the PPID of the analysed program as an item.
• GemFormattedProgramDryRunReport::programIdBytes C++ Method — Copies the raw PPID bytes of the analysed program.
• GemFormattedProgramDryRunReport::softwareRevision C++ Method — Copies the SOFTREV of the analysed program.
• GemFormattedProgramDryRunReport::~GemFormattedProgramDryRunReport C++ Method — Releases the native handle with pdcomm_gem_formatted_program_dry_run_destroy().
• GemFormattedProgramExecutionAction C++ Class — One action that the library asks the application to perform for an execution.
• GemFormattedProgramExecutionAction::GemFormattedProgramExecutionAction C++ Constructor — Creates an empty action that owns no native handle.
• GemFormattedProgramExecutionAction::GemFormattedProgramExecutionAction C++ Constructor — Takes ownership of the native handle owned by other.
• GemFormattedProgramExecutionAction::GemFormattedProgramExecutionAction C++ Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramExecutionAction::commandCode C++ Method — Returns the CCODE of the command a step action asks to apply.
• GemFormattedProgramExecutionAction::info C++ Method — Describes the action.
• GemFormattedProgramExecutionAction::model C++ Method — Copies the MDLN carried by a start action.
• GemFormattedProgramExecutionAction::operator bool C++ Method — Reports whether the wrapper owns a native action.
• GemFormattedProgramExecutionAction::operator= C++ Method — Releases the current handle, then takes ownership of the handle owned by other.
• GemFormattedProgramExecutionAction::operator= C++ Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramExecutionAction::parameter C++ Method — Returns one PPARM of the command a step action asks to apply.
• GemFormattedProgramExecutionAction::programId C++ Method — Returns the PPID carried by a start action.
• GemFormattedProgramExecutionAction::softwareRevision C++ Method — Copies the SOFTREV carried by a start action.
• GemFormattedProgramExecutionAction::token C++ Method — Returns the token to report this action's result with.
• GemFormattedProgramExecutionAction::~GemFormattedProgramExecutionAction C++ Method — Releases the native handle with pdcomm_gem_formatted_program_execution_action_destroy().
• GemFormattedProgramExecutionActionInfo C++ Struct — Description of one requested action, returned by GemFormattedProgramExecutionAction::info().
• GemFormattedProgramExecutionActionInfo::actionSequence C++ Field — Sequence number of this action.
• GemFormattedProgramExecutionActionInfo::cancelNextCommandIndex C++ Field — For a cancel action, the index of the first command that was not applied.
• GemFormattedProgramExecutionActionInfo::capabilityRevision C++ Field — Capability catalog revision of the dry run.
• GemFormattedProgramExecutionActionInfo::codeFormat C++ Field — SECS-II format code of the CCODE, for a step action.
• GemFormattedProgramExecutionActionInfo::commandCount C++ Field — Commands of the executed program.
• GemFormattedProgramExecutionActionInfo::commandIndex C++ Field — Program command a step action asks to apply.
• GemFormattedProgramExecutionActionInfo::dryRunOutcome C++ Field — Dry-run outcome of the execution.
• GemFormattedProgramExecutionActionInfo::endpointId C++ Field — Endpoint that runs the execution.
• GemFormattedProgramExecutionActionInfo::executionGeneration C++ Field — Execution number.
• GemFormattedProgramExecutionActionInfo::idFormat C++ Field — SECS-II format code of the PPID, for a start action.
• GemFormattedProgramExecutionActionInfo::kind C++ Field — Action kind (PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_START, ..._STEP or ..._CANCEL).
• GemFormattedProgramExecutionActionInfo::parameterCount C++ Field — PPARM items of the command of a step action.
• GemFormattedProgramExecutionActionInfo::policyVersion C++ Field — Dry-run policy version of the execution.
• GemFormattedProgramExecutionActionInfo::presenceMask C++ Field — Which data the action carries: PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_PROGRAM_ID_PRESENT, ..._MODEL_PRESENT, ..._SOFTWARE_REVISION_PRESENT, ..._COMMAND_PRESENT and ..._CANCEL_NEXT_COMMAND_INDEX_PRESENT bits.
• GemFormattedProgramExecutionActionInfo::sessionGeneration C++ Field — Connection generation of the execution.
• GemFormattedProgramExecutionActionToken C++ Struct — Identifies one action that the library asks the application to perform.
• GemFormattedProgramExecutionActionToken::actionSequence C++ Field — Sequence number of the action within the execution; the start action is 1.
• GemFormattedProgramExecutionActionToken::endpointId C++ Field — Identity of the endpoint that runs the execution.
• GemFormattedProgramExecutionActionToken::executionGeneration C++ Field — Execution number the action belongs to.
• GemFormattedProgramExecutionActionToken::kind C++ Field — Action kind: PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_START, ..._ACTION_STEP or ..._ACTION_CANCEL.
• GemFormattedProgramExecutionActionToken::sessionGeneration C++ Field — HSMS connection generation of the execution.
• GemFormattedProgramExecutionCommandInfo C++ Struct — Shape of one command of the executed program, returned by GemFormattedProgramExecutionSnapshot::commandInfo().
• GemFormattedProgramExecutionCommandInfo::codeFormat C++ Field — SECS-II format code of the CCODE item.
• GemFormattedProgramExecutionCommandInfo::parameterCount C++ Field — Number of PPARM items of the command.
• GemFormattedProgramExecutionInfo C++ Struct — State of the equipment's formatted program execution, returned by GemFormattedProgramExecutionSnapshot::info().
• GemFormattedProgramExecutionInfo::applicationDetailLength C++ Field — Length of the application detail bytes.
• GemFormattedProgramExecutionInfo::applicationReportId C++ Field — Report ID passed to completeFormattedProgramExecution(); valid when its presence bit is set.
• GemFormattedProgramExecutionInfo::applicationReportKind C++ Field — Final report submitted by the application: 0 (none), PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_TERMINAL_COMPLETE, ..._TERMINAL_FAIL or ..._TERMINAL_OUTCOME_UNKNOWN.
• GemFormattedProgramExecutionInfo::capabilityPresent C++ Field — true when the dry run used a capability catalog.
• GemFormattedProgramExecutionInfo::capabilityRevision C++ Field — Capability catalog revision of the dry run.
• GemFormattedProgramExecutionInfo::commandCount C++ Field — Commands of the executed program.
• GemFormattedProgramExecutionInfo::dryRunOutcome C++ Field — Outcome of the dry run the execution was started with (PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_*).
• GemFormattedProgramExecutionInfo::endpointId C++ Field — Endpoint that runs the execution.
• GemFormattedProgramExecutionInfo::entryGeneration C++ Field — Entry generation of the selection that was executed.
• GemFormattedProgramExecutionInfo::executionGeneration C++ Field — Execution number.
• GemFormattedProgramExecutionInfo::idFormat C++ Field — SECS-II format code of the executed PPID.
• GemFormattedProgramExecutionInfo::nextCommandIndex C++ Field — Index of the next command a step would request; equals #commandCount when all commands were applied.
• GemFormattedProgramExecutionInfo::pendingActionSequence C++ Field — Sequence number of the pending action; valid when its presence bit is set.
• GemFormattedProgramExecutionInfo::pendingKind C++ Field — Kind of the action waiting for a result (..._ACTION_*), or ..._ACTION_NONE.
• GemFormattedProgramExecutionInfo::policyVersion C++ Field — Dry-run policy version of that report.
• GemFormattedProgramExecutionInfo::presenceMask C++ Field — Which optional data is present: PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_PENDING_ACTION_PRESENT, ..._APPLICATION_REPORT_PRESENT and ..._APPLICATION_DETAIL_PRESENT bits.
• GemFormattedProgramExecutionInfo::selectionGeneration C++ Field — Selection revision that was executed.
• GemFormattedProgramExecutionInfo::sessionGeneration C++ Field — Connection generation of the execution.
• GemFormattedProgramExecutionInfo::state C++ Field — Execution state: PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_EMPTY, ..._START_PENDING, ..._RUNNING, ..._STEP_PENDING, ..._CANCEL_PENDING, ..._APPLICATION_REJECTED, ..._COMPLETED, ..._FAILED, ..._CANCELLED or ..._OUTCOME_UNKNOWN.
• GemFormattedProgramExecutionInfo::storeRevision C++ Field — Store revision of the selection that was executed.
• GemFormattedProgramExecutionSnapshot C++ Class — Immutable copy of the equipment's formatted program execution state.
• GemFormattedProgramExecutionSnapshot::GemFormattedProgramExecutionSnapshot C++ Constructor — Creates an empty snapshot that owns no native handle.
• GemFormattedProgramExecutionSnapshot::GemFormattedProgramExecutionSnapshot C++ Constructor — Takes ownership of the native handle owned by other.
• GemFormattedProgramExecutionSnapshot::GemFormattedProgramExecutionSnapshot C++ Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramExecutionSnapshot::applicationDetail C++ Method — Copies the detail bytes passed to completeFormattedProgramExecution().
• GemFormattedProgramExecutionSnapshot::commandCode C++ Method — Returns the CCODE of one command of the executed program.
• GemFormattedProgramExecutionSnapshot::commandInfo C++ Method — Describes one command of the executed program.
• GemFormattedProgramExecutionSnapshot::info C++ Method — Returns the execution state captured in the snapshot.
• GemFormattedProgramExecutionSnapshot::model C++ Method — Copies the MDLN of the executed program.
• GemFormattedProgramExecutionSnapshot::nativeHandle C++ Method — Returns the owned native handle for read-only C API calls.
• GemFormattedProgramExecutionSnapshot::operator bool C++ Method — Reports whether the wrapper owns a native snapshot.
• GemFormattedProgramExecutionSnapshot::operator= C++ Method — Releases the current handle, then takes ownership of the handle owned by other.
• GemFormattedProgramExecutionSnapshot::operator= C++ Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramExecutionSnapshot::parameter C++ Method — Returns one PPARM of one command of the executed program.
• GemFormattedProgramExecutionSnapshot::programId C++ Method — Returns the PPID of the executed program.
• GemFormattedProgramExecutionSnapshot::softwareRevision C++ Method — Copies the SOFTREV of the executed program.
• GemFormattedProgramExecutionSnapshot::~GemFormattedProgramExecutionSnapshot C++ Method — Releases the native handle with pdcomm_gem_formatted_program_execution_snapshot_destroy().
• GemFormattedProgramExecutionStart C++ Struct — Result of startFormattedProgramExecution(): the execution token and its start action.
• GemFormattedProgramExecutionStart::action C++ Field — Start action to perform and resolve.
• GemFormattedProgramExecutionStart::token C++ Field — Token of the new execution.
• GemFormattedProgramExecutionToken C++ Struct — Identifies one execution of a selected formatted program.
• GemFormattedProgramExecutionToken::endpointId C++ Field — Identity of the endpoint that runs the execution.
• GemFormattedProgramExecutionToken::executionGeneration C++ Field — Execution number; it increases with every new execution.
• GemFormattedProgramExecutionToken::sessionGeneration C++ Field — HSMS connection generation when the execution started.
• GemFormattedProgramInfo C++ Struct — Summary of an S7F27 request or S7F28 reply, returned by formattedProgramInfo().
• GemFormattedProgramInfo::idFormat C++ Field — SECS-II format code of the PPID (PDCOMM_SECS_ASCII or PDCOMM_SECS_BINARY); 0 when the result has no report.
• GemFormattedProgramInfo::isRequest C++ Field — true for an S7F27 received by a host.
• GemFormattedProgramInfo::issueCount C++ Field — Number of verification entries in the report; 0 for a reply.
• GemFormattedProgramInfo::replyReady C++ Field — true while a received S7F27 still waits for respondFormattedProgram().
• GemFormattedProgramInfo::request C++ Field — Always GemRequest::FormattedProgramSend.
• GemFormattedProgramInfo::responded C++ Field — true after respondFormattedProgram() sent S7F28.
• GemFormattedProgramIssue C++ Struct — One verification result entry of S7F27 Process Program Verification Send.
• GemFormattedProgramIssue::code C++ Field — ACKC7A result code, 0 to 5 (0 means the command is accepted).
• GemFormattedProgramIssue::sequence C++ Field — SEQNUM: number of the process program command the entry refers to.
• GemFormattedProgramIssue::text C++ Field — ERRW7 error text, ASCII; may be empty.
• GemFormattedProgramQueryCommand C++ Struct — One process program command (CCODE with its PPARM list) of a program that the equipment can return in S7F26.
• GemFormattedProgramQueryCommand::code C++ Field — Command code (CCODE): an ASCII item or an unsigned integer scalar (U1, U2, U4 or U8).
• GemFormattedProgramQueryCommand::parameters C++ Field — Command parameters (PPARM) in order; any item format.
• GemFormattedProgramQueryCommandInfo C++ Struct — Shape of one command of a returned program, returned by formattedProgramQueryCommandInfo().
• GemFormattedProgramQueryCommandInfo::codeFormat C++ Field — SECS-II format code of the CCODE item.
• GemFormattedProgramQueryCommandInfo::parameterCount C++ Field — Number of PPARM items of the command.
• GemFormattedProgramQueryInfo C++ Struct — Summary of an S7F25 request or S7F26 reply, returned by formattedProgramQueryInfo().
• GemFormattedProgramQueryInfo::commandCount C++ Field — Commands of the returned program; 0 when no program is known or present.
• GemFormattedProgramQueryInfo::idFormat C++ Field — SECS-II format code of the requested PPID.
• GemFormattedProgramQueryInfo::isRequest C++ Field — true for an S7F25 received by the equipment.
• GemFormattedProgramQueryInfo::present C++ Field — true when the answer contains the program; false for an empty S7F26 (program absent). Meaningful only when #presentKnown is true.
• GemFormattedProgramQueryInfo::presentKnown C++ Field — true once the answer is known: for a received S7F26, or for a request after its response was prepared.
• GemFormattedProgramQueryInfo::replyReady C++ Field — true while a received S7F25 still waits for a response.
• GemFormattedProgramQueryInfo::request C++ Field — Always GemRequest::FormattedProgramQuerySend.
• GemFormattedProgramQueryInfo::responded C++ Field — true after respondFormattedProgramQuery() sent S7F26.
• GemFormattedProgramSelectionCommandInfo C++ Struct — Shape of one command of the selected program, returned by GemFormattedProgramSelectionSnapshot::commandInfo().
• GemFormattedProgramSelectionCommandInfo::codeFormat C++ Field — SECS-II format code of the CCODE item.
• GemFormattedProgramSelectionCommandInfo::parameterCount C++ Field — Number of PPARM items of the command.
• GemFormattedProgramSelectionInfo C++ Struct — State of the equipment's formatted program selection, returned by GemFormattedProgramSelectionSnapshot::info().
• GemFormattedProgramSelectionInfo::commandCount C++ Field — Commands of the selected program.
• GemFormattedProgramSelectionInfo::entryGeneration C++ Field — Entry generation captured by the selection.
• GemFormattedProgramSelectionInfo::idFormat C++ Field — SECS-II format code of the selected PPID; 0 when empty.
• GemFormattedProgramSelectionInfo::selectionGeneration C++ Field — Selection revision; for an empty selection the current revision.
• GemFormattedProgramSelectionInfo::sessionGeneration C++ Field — Connection generation captured by the selection.
• GemFormattedProgramSelectionInfo::staleReason C++ Field — Why a selection is stale: PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE_NONE, ..._STALE_ENTRY_DELETED, ..._STALE_ENTRY_CHANGED, ..._STALE_SESSION_CHANGED, ..._STALE_DISCONNECTED, ..._STALE_CLEARED or ..._STALE_TOKEN_MISMATCH.
• GemFormattedProgramSelectionInfo::state C++ Field — PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_EMPTY, ..._READY or ..._STALE.
• GemFormattedProgramSelectionInfo::storeRevision C++ Field — Store revision captured by the selection.
• GemFormattedProgramSelectionInfo::validForExecution C++ Field — true only in the ready state.
• GemFormattedProgramSelectionSnapshot C++ Class — Immutable copy of the equipment's formatted program selection.
• GemFormattedProgramSelectionSnapshot::GemFormattedProgramSelectionSnapshot C++ Constructor — Creates an empty snapshot that owns no native handle.
• GemFormattedProgramSelectionSnapshot::GemFormattedProgramSelectionSnapshot C++ Constructor — Takes ownership of the native handle owned by other.
• GemFormattedProgramSelectionSnapshot::GemFormattedProgramSelectionSnapshot C++ Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramSelectionSnapshot::commandCode C++ Method — Returns the CCODE of one command of the selected program.
• GemFormattedProgramSelectionSnapshot::commandInfo C++ Method — Describes one command of the selected program.
• GemFormattedProgramSelectionSnapshot::id C++ Method — Returns the PPID of the selected program.
• GemFormattedProgramSelectionSnapshot::info C++ Method — Returns the selection state captured in the snapshot.
• GemFormattedProgramSelectionSnapshot::model C++ Method — Copies the MDLN of the selected program.
• GemFormattedProgramSelectionSnapshot::operator bool C++ Method — Reports whether the wrapper owns a native snapshot.
• GemFormattedProgramSelectionSnapshot::operator= C++ Method — Releases the current handle, then takes ownership of the handle owned by other.
• GemFormattedProgramSelectionSnapshot::operator= C++ Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramSelectionSnapshot::parameter C++ Method — Returns one PPARM of one command of the selected program.
• GemFormattedProgramSelectionSnapshot::softwareRevision C++ Method — Copies the SOFTREV of the selected program.
• GemFormattedProgramSelectionSnapshot::~GemFormattedProgramSelectionSnapshot C++ Method — Releases the native handle with pdcomm_gem_formatted_program_selection_snapshot_destroy().
• GemFormattedProgramSelectionToken C++ Struct — Identifies one selection of a formatted program on one equipment endpoint.
• GemFormattedProgramSelectionToken::endpointId C++ Field — Identity of the endpoint that made the selection.
• GemFormattedProgramSelectionToken::entryGeneration C++ Field — Generation of the selected store entry when it was selected.
• GemFormattedProgramSelectionToken::selectionGeneration C++ Field — Selection revision; it increases whenever a different selection is made or cleared.
• GemFormattedProgramSelectionToken::sessionGeneration C++ Field — HSMS connection generation when the program was selected.
• GemFormattedProgramSelectionToken::storeRevision C++ Field — Formatted program store revision when the program was selected.
• GemFormattedProgramStoreAction C++ Enum — How a write treats an existing program in the equipment's formatted program store.
• GemFormattedProgramStoreAction::CreateOnly C++ Enumerator — Store only when the PPID is not stored yet.
• GemFormattedProgramStoreAction::ReplaceOnly C++ Enumerator — Store only when the PPID is already stored.
• GemFormattedProgramStoreAction::RespondOnly C++ Enumerator — Store nothing; only acknowledge. Valid only for respondFormattedProgramTransferAndStore().
• GemFormattedProgramStoreAction::Upsert C++ Enumerator — Create or replace.
• GemFormattedProgramStoreCommand C++ Struct — One process program command (CCODE with its PPARM list) for putFormattedProgramStore().
• GemFormattedProgramStoreCommand::code C++ Field — Command code (CCODE): an ASCII item or an unsigned integer scalar (U1, U2, U4 or U8).
• GemFormattedProgramStoreCommand::parameters C++ Field — Command parameters (PPARM) in order; any item format.
• GemFormattedProgramStoreCommandInfo C++ Struct — Shape of one command of a stored program, returned by GemFormattedProgramStoreSnapshot::commandInfo().
• GemFormattedProgramStoreCommandInfo::codeFormat C++ Field — SECS-II format code of the CCODE item.
• GemFormattedProgramStoreCommandInfo::parameterCount C++ Field — Number of PPARM items of the command.
• GemFormattedProgramStoreEntryInfo C++ Struct — Shape of one stored program, returned by GemFormattedProgramStoreSnapshot::entryInfo().
• GemFormattedProgramStoreEntryInfo::commandCount C++ Field — Commands of the program.
• GemFormattedProgramStoreEntryInfo::idFormat C++ Field — SECS-II format code of the PPID (PDCOMM_SECS_ASCII or PDCOMM_SECS_BINARY).
• GemFormattedProgramStoreInfo C++ Struct — Counters and limits of the equipment's formatted program store.
• GemFormattedProgramStoreInfo::encodedBytes C++ Field — Total encoded bytes of the stored programs.
• GemFormattedProgramStoreInfo::entryCount C++ Field — Stored programs.
• GemFormattedProgramStoreInfo::identifierBytes C++ Field — Total PPID bytes of the stored programs.
• GemFormattedProgramStoreInfo::maxEncodedBytes C++ Field — Configured maximum total encoded bytes.
• GemFormattedProgramStoreInfo::maxEntries C++ Field — Configured maximum number of programs.
• GemFormattedProgramStoreInfo::maxIdentifierBytes C++ Field — Configured maximum total PPID bytes.
• GemFormattedProgramStoreInfo::revision C++ Field — Store revision; it increases on every change.
• GemFormattedProgramStoreSnapshot C++ Class — Immutable copy of the equipment's formatted program store.
• GemFormattedProgramStoreSnapshot::GemFormattedProgramStoreSnapshot C++ Constructor — Creates an empty snapshot that owns no native handle.
• GemFormattedProgramStoreSnapshot::GemFormattedProgramStoreSnapshot C++ Constructor — Takes ownership of the native handle owned by other.
• GemFormattedProgramStoreSnapshot::GemFormattedProgramStoreSnapshot C++ Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramStoreSnapshot::commandCode C++ Method — Returns the CCODE of one command of one stored program.
• GemFormattedProgramStoreSnapshot::commandInfo C++ Method — Describes one command of one stored program.
• GemFormattedProgramStoreSnapshot::entryInfo C++ Method — Describes one stored program.
• GemFormattedProgramStoreSnapshot::id C++ Method — Returns the PPID of one stored program.
• GemFormattedProgramStoreSnapshot::info C++ Method — Returns the counters and limits captured in the snapshot.
• GemFormattedProgramStoreSnapshot::model C++ Method — Copies the MDLN of one stored program.
• GemFormattedProgramStoreSnapshot::operator bool C++ Method — Reports whether the wrapper owns a native snapshot.
• GemFormattedProgramStoreSnapshot::operator= C++ Method — Releases the current handle, then takes ownership of the handle owned by other.
• GemFormattedProgramStoreSnapshot::operator= C++ Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramStoreSnapshot::parameter C++ Method — Returns one PPARM of one command of one stored program.
• GemFormattedProgramStoreSnapshot::softwareRevision C++ Method — Copies the SOFTREV of one stored program.
• GemFormattedProgramStoreSnapshot::~GemFormattedProgramStoreSnapshot C++ Method — Releases the native handle with pdcomm_gem_formatted_program_store_snapshot_destroy().
• GemFormattedProgramTransferCommand C++ Struct — One process program command (CCODE with its PPARM list) for S7F23.
• GemFormattedProgramTransferCommand::code C++ Field — Command code (CCODE): an ASCII item or an unsigned integer scalar (U1, U2, U4 or U8).
• GemFormattedProgramTransferCommand::parameters C++ Field — Command parameters (PPARM) in order; any item format.
• GemFormattedProgramTransferCommandInfo C++ Struct — Shape of one command of a received S7F23, returned by formattedProgramTransferCommandInfo().
• GemFormattedProgramTransferCommandInfo::codeFormat C++ Field — SECS-II format code of the CCODE item.
• GemFormattedProgramTransferCommandInfo::parameterCount C++ Field — Number of PPARM items of the command.
• GemFormattedProgramTransferInfo C++ Struct — Summary of an S7F23 request or S7F24 reply, returned by formattedProgramTransferInfo().
• GemFormattedProgramTransferInfo::acknowledgement C++ Field — ACKC7 of the S7F24 reply, 0 to 7 (0 means accepted).
• GemFormattedProgramTransferInfo::acknowledgementPresent C++ Field — true when #acknowledgement holds the sent or received ACKC7.
• GemFormattedProgramTransferInfo::commandCount C++ Field — Number of commands in the received program; 0 for a reply.
• GemFormattedProgramTransferInfo::idFormat C++ Field — SECS-II format code of the PPID (PDCOMM_SECS_ASCII or PDCOMM_SECS_BINARY).
• GemFormattedProgramTransferInfo::isRequest C++ Field — true for an S7F23 received by the equipment.
• GemFormattedProgramTransferInfo::replyReady C++ Field — true while a received S7F23 still waits for a response.
• GemFormattedProgramTransferInfo::request C++ Field — Always GemRequest::FormattedProgramTransferSend.
• GemFormattedProgramTransferInfo::responded C++ Field — true after the equipment sent S7F24.
• GemFormattedProgramVerificationNegotiationInfo C++ Struct — State of one verification negotiation, returned by formattedProgramVerificationNegotiationInfo().
• GemFormattedProgramVerificationNegotiationInfo::correlation C++ Field — Sequence number that identifies the negotiation; the prepared result and all later results of the same negotiation share it.
• GemFormattedProgramVerificationNegotiationInfo::length C++ Field — LENGTH sent in S7F29: the byte length of the prepared S7F27 body.
• GemFormattedProgramVerificationNegotiationInfo::negotiationTerminal C++ Field — Outcome of the S7F29/F30 stage: PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_TERMINAL_NONE, ..._GRANTED, ..._DENIED, ..._TIMED_OUT or ..._DISCONNECTED.
• GemFormattedProgramVerificationNegotiationInfo::ppGnt C++ Field — PPGNT from S7F30; valid when #ppGntPresent is true (0 means granted).
• GemFormattedProgramVerificationNegotiationInfo::ppGntPresent C++ Field — true once a grant or denial was received or sent.
• GemFormattedProgramVerificationNegotiationInfo::prepared C++ Field — true for equipment-side results of a prepared negotiation.
• GemFormattedProgramVerificationNegotiationInfo::replyReady C++ Field — true while a received S7F29 still waits for a response.
• GemFormattedProgramVerificationNegotiationInfo::request C++ Field — Always GemRequest::FormattedProgramVerificationNegotiationSend.
• GemFormattedProgramVerificationNegotiationInfo::responded C++ Field — true after the host sent S7F30.
• GemFormattedProgramVerificationNegotiationInfo::state C++ Field — Negotiation state: PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_STATE_PREPARED, ..._STATE_RECEIVED or ..._STATE_RESPONDED.
• GemFormattedProgramVerificationNegotiationInfo::submitted C++ Field — true after S7F29 was sent.
• GemFormattedProgramVerificationNegotiationInfo::verificationTerminal C++ Field — Outcome of the S7F27/F28 stage after a grant, with the same constants; ..._GRANTED (1) means the S7F28 acknowledgement arrived. ..._NONE before that stage.
• GemFormattedProgramVerificationNegotiationIssue C++ Struct — One verification result entry (ACKC7A, SEQNUM, ERRW7) of the S7F27 report that a negotiation sends after the host's grant.
• GemFormattedProgramVerificationNegotiationIssue::code C++ Field — ACKC7A result code, 0 to 5 (0 means the command is accepted).
• GemFormattedProgramVerificationNegotiationIssue::sequence C++ Field — SEQNUM: number of the process program command the entry refers to.
• GemFormattedProgramVerificationNegotiationIssue::text C++ Field — ERRW7 error text, ASCII; may be empty.
• GemFormattedProgramVerificationRequestCommand C++ Struct — One process program command (CCODE with its PPARM list) for S7F31.
• GemFormattedProgramVerificationRequestCommand::code C++ Field — Command code (CCODE): an ASCII item or an unsigned integer scalar (U1, U2, U4 or U8).
• GemFormattedProgramVerificationRequestCommand::parameters C++ Field — Command parameters (PPARM) in order; any item format.
• GemFormattedProgramVerificationRequestCommandInfo C++ Struct — Shape of one command of a received S7F31, returned by formattedProgramVerificationRequestCommandInfo().
• GemFormattedProgramVerificationRequestCommandInfo::codeFormat C++ Field — SECS-II format code of the CCODE item.
• GemFormattedProgramVerificationRequestCommandInfo::parameterCount C++ Field — Number of PPARM items of the command.
• GemFormattedProgramVerificationRequestInfo C++ Struct — Summary of an S7F31 request or S7F32 reply, returned by formattedProgramVerificationRequestInfo().
• GemFormattedProgramVerificationRequestInfo::acknowledgement C++ Field — ACKC7 of the S7F32 reply, 0 to 7 (0 means accepted).
• GemFormattedProgramVerificationRequestInfo::acknowledgementPresent C++ Field — true when #acknowledgement holds the sent or received ACKC7.
• GemFormattedProgramVerificationRequestInfo::commandCount C++ Field — Number of commands in the received request; 0 for a reply.
• GemFormattedProgramVerificationRequestInfo::idFormat C++ Field — SECS-II format code of the PPID (PDCOMM_SECS_ASCII or PDCOMM_SECS_BINARY).
• GemFormattedProgramVerificationRequestInfo::isRequest C++ Field — true for an S7F31 received by the equipment.
• GemFormattedProgramVerificationRequestInfo::replyReady C++ Field — true while a received S7F31 still waits for a response.
• GemFormattedProgramVerificationRequestInfo::request C++ Field — Always GemRequest::FormattedProgramVerificationRequestSend.
• GemFormattedProgramVerificationRequestInfo::responded C++ Field — true after the equipment sent S7F32.
• GemHost C++ Class — GEM host role (SEMI E30) on one HSMS endpoint (SEMI E37).
• GemHost::GemHost C++ Constructor — Takes ownership of endpoint and configures it as a GEM host.
• GemHost::acknowledgeAlarm C++ Method — Sends S5F2 for a received S5F1 alarm report that expects a reply.
• GemHost::acknowledgeEvent C++ Method — Sends S6F12 for a received S6F11 event report.
• GemHost::annotatedQuery C++ Method — Sends S6F21 Annotated Individual Report Request.
• GemHost::beginCommunication C++ Method — Sends S1F13 Establish Communications Request.
• GemHost::changeConstants C++ Method — Sends S2F15 New Equipment Constant Send.
• GemHost::configureRemoteSpooling C++ Method — Sends S2F43 Reset Spooling Streams and Functions.
• GemHost::configureSpoolHost C++ Method — Enables the host spool requests (S2F43, S2F59, S6F23) with the given limits.
• GemHost::constantMetadata C++ Method — Sends S2F29 Equipment Constant Namelist Request.
• GemHost::constantRequest C++ Method — Sends S2F13 (values) or S2F29 (namelist) for equipment constants.
• GemHost::constantValues C++ Method — Sends S2F13 Equipment Constant Request.
• GemHost::dataDirectory C++ Method — Sends S1F21 Data Variable Namelist Request.
• GemHost::defineReports C++ Method — Sends S2F33 Define Report.
• GemHost::directoryRequest C++ Method — Sends S1F21 (data variables) or S1F23 (collection events) namelist request.
• GemHost::enableAlarm C++ Method — Sends S5F3 Enable/Disable Alarm Send.
• GemHost::enableEvents C++ Method — Sends S2F37 Enable/Disable Event Report.
• GemHost::enhancedRemoteCommand C++ Method — Sends S2F49 Enhanced Remote Command.
• GemHost::eventDirectory C++ Method — Sends S1F23 Collection Event Namelist Request.
• GemHost::eventQuery C++ Method — Sends S6F15 Event Report Request.
• GemHost::individualQuery C++ Method — Sends S6F19 Individual Report Request.
• GemHost::linkReports C++ Method — Sends S2F35 Link Event Report.
• GemHost::programDelete C++ Method — Sends S7F17 Delete Process Program Send.
• GemHost::programDirectory C++ Method — Sends S7F19 Current Process Program Directory Request (header only).
• GemHost::queryRemoteSpooling C++ Method — Sends S2F59 to query the equipment's current spooling selection.
• GemHost::remoteCommand C++ Method — Sends S2F41 Host Command Send.
• GemHost::reportQuery C++ Method — Sends one report query: S6F15, S6F19 or S6F21.
• GemHost::request C++ Method — Sends a basic stream 1 request.
• GemHost::requestAlarmList C++ Method — Sends S5F5 List Alarms Request.
• GemHost::requestEnabledAlarmList C++ Method — Sends S5F7 List Enabled Alarm Request.
• GemHost::requestSpooledData C++ Method — Sends S6F23 Request Spooled Data.
• GemInt128 C++ Struct — Signed 128-bit integer stored as two's complement: high * 2^64 + low.
• GemInt128::fromSigned C++ Method — Converts a signed 64-bit value with sign extension.
• GemInt128::fromUnsigned C++ Method — Converts an unsigned 64-bit value.
• GemInt128::high C++ Field — High 64 bits, including the sign.
• GemInt128::low C++ Field — Low 64 bits.
• GemInt128::native C++ Method — Converts to the C representation.
• GemLinkSpec C++ Struct — One event-to-report link for S2F35.
• GemLinkSpec::eventId C++ Field — Collection event ID (CEID).
• GemLinkSpec::reportIds C++ Field — Report IDs to link, in order. An empty list unlinks the event.
• GemOnlineMode C++ Enum — Online substate the equipment enters when it goes online.
• GemOnlineMode::Local C++ Enumerator — Enter GemControl::OnlineLocal.
• GemOnlineMode::Remote C++ Enumerator — Enter GemControl::OnlineRemote.
• GemOnlineMode::Unavailable C++ Enumerator — No online mode exists, which is the case for the host role.
• GemOutcome C++ Enum — What a GemResult means, beyond its GemResultKind.
• GemOutcome::AlarmAck C++ Enumerator — Equipment received S5F2; ACKC5 is in GemResultInfo::acknowledgement.
• GemOutcome::AlarmEnableAck C++ Enumerator — S5F4 ACKC5 was received (host) or sent (equipment).
• GemOutcome::AlarmListReceived C++ Enumerator — Host received S5F6; read alarms with GemResult::alarmAt().
• GemOutcome::AlarmListReplied C++ Enumerator — Equipment answered S5F5 with S5F6.
• GemOutcome::AlarmReceived C++ Enumerator — Host received S5F1. A W-bit report needs GemHost::acknowledgeAlarm().
• GemOutcome::AlreadyOnline C++ Enumerator — Equipment replied S1F18 with ONLACK 2 because it is already online.
• GemOutcome::AnnotatedQueryReceived C++ Enumerator — Host received S6F22.
• GemOutcome::CommandAck C++ Enumerator — Host received S2F42; HCACK is in GemResultInfo::acknowledgement.
• GemOutcome::CommandReceived C++ Enumerator — Equipment received S2F41. Nothing was executed or acknowledged; call GemEquipment::respondCommand().
• GemOutcome::CommunicationEstablished C++ Enumerator — S1F13/F14 succeeded with COMMACK 0; the communication state is Communicating.
• GemOutcome::CommunicationRejected C++ Enumerator — S1F14 carried a nonzero COMMACK, available in GemResultInfo::acknowledgement.
• GemOutcome::ConstantChangeAck C++ Enumerator — Host received S2F16; EAC is in GemResultInfo::acknowledgement.
• GemOutcome::ConstantChangesReceived C++ Enumerator — Equipment received S2F15; nothing is applied until GemEquipment::respondConstants().
• GemOutcome::ConstantMetadataReceived C++ Enumerator — Host received S2F30; read rows with GemResult::constantMetadata().
• GemOutcome::ConstantMetadataReplied C++ Enumerator — Equipment answered S2F29 with S2F30.
• GemOutcome::ConstantValuesReceived C++ Enumerator — Host received S2F14; read values with GemResult::constantValue().
• GemOutcome::ConstantValuesReplied C++ Enumerator — Equipment answered S2F13 with S2F14.
• GemOutcome::DataDirectoryReceived C++ Enumerator — Host received S1F22; read rows with GemResult::directoryAt() and GemResult::directoryGet().
• GemOutcome::DataDirectoryReplied C++ Enumerator — Equipment answered S1F21 with S1F22.
• GemOutcome::DefineReportsAck C++ Enumerator — S2F34 DRACK was received (host) or sent (equipment); the code is in GemResultInfo::acknowledgement.
• GemOutcome::EnableEventsAck C++ Enumerator — S2F38 ERACK was received (host) or sent (equipment).
• GemOutcome::EnabledAlarmListReceived C++ Enumerator — Host received S5F8; read alarms with GemResult::alarmAt().
• GemOutcome::EnabledAlarmListReplied C++ Enumerator — Equipment answered S5F7 with S5F8.
• GemOutcome::EnhancedCommandAck C++ Enumerator — Host received S2F50; HCACK is in GemResultInfo::acknowledgement.
• GemOutcome::EnhancedCommandReceived C++ Enumerator — Equipment received S2F49; call GemEquipment::respondEnhancedCommand().
• GemOutcome::EquipmentIdentity C++ Enumerator — Host received S1F2 with the equipment model (MDLN) and software revision (SOFTREV).
• GemOutcome::EventAck C++ Enumerator — Equipment received S6F12; ACKC6 is in GemResultInfo::acknowledgement.
• GemOutcome::EventDirectoryReceived C++ Enumerator — Host received S1F24; read rows with GemResult::directoryAt() and GemResult::directoryGet().
• GemOutcome::EventDirectoryReplied C++ Enumerator — Equipment answered S1F23 with S1F24.
• GemOutcome::EventQueryReceived C++ Enumerator — Host received S6F16.
• GemOutcome::EventReceived C++ Enumerator — Host received S6F11. No acknowledgement was sent; call GemHost::acknowledgeEvent().
• GemOutcome::FormattedProgramAcknowledgement C++ Enumerator — Equipment received S7F28.
• GemOutcome::FormattedProgramCapabilityReceived C++ Enumerator — Equipment received S7F21 Process Capability Request.
• GemOutcome::FormattedProgramCapabilityResult C++ Enumerator — Host received S7F22.
• GemOutcome::FormattedProgramQueryReceived C++ Enumerator — Equipment received S7F25 Formatted Process Program Request.
• GemOutcome::FormattedProgramQueryResult C++ Enumerator — Host received S7F26.
• GemOutcome::FormattedProgramReceived C++ Enumerator — Host received S7F27 Process Program Verification Send.
• GemOutcome::FormattedProgramTransferAcknowledgement C++ Enumerator — Host received S7F24; ACKC7 is in GemResultInfo::acknowledgement.
• GemOutcome::FormattedProgramTransferReceived C++ Enumerator — Equipment received S7F23 Formatted Process Program Send.
• GemOutcome::FormattedProgramVerificationNegotiationAcknowledgement C++ Enumerator — Equipment received S7F28 for the S7F27 sent after a grant.
• GemOutcome::FormattedProgramVerificationNegotiationGrant C++ Enumerator — Equipment received S7F30 with the host's PPGNT.
• GemOutcome::FormattedProgramVerificationNegotiationReceived C++ Enumerator — Host received S7F29 Process Program Verification Inquire.
• GemOutcome::FormattedProgramVerificationRequestAcknowledgement C++ Enumerator — Host received S7F32.
• GemOutcome::FormattedProgramVerificationRequestReceived C++ Enumerator — Equipment received S7F31 Verification Request Send.
• GemOutcome::IndividualQueryReceived C++ Enumerator — Host received S6F20.
• GemOutcome::LinkReportsAck C++ Enumerator — S2F36 LRACK was received (host) or sent (equipment).
• GemOutcome::NamesReceived C++ Enumerator — Host received S1F12 status names; read them with GemResult::statusName().
• GemOutcome::None C++ Enumerator — No specific outcome, for example on Ignored, Failed or Unhandled results.
• GemOutcome::OfflineAccepted C++ Enumerator — Equipment accepted S1F15 and replied S1F16 with OFLACK 0.
• GemOutcome::OfflineAck C++ Enumerator — Host received S1F16; OFLACK is in GemResultInfo::acknowledgement.
• GemOutcome::OnlineAccepted C++ Enumerator — Equipment went online: it accepted S1F17 (ONLACK 0), or the host answered the operator-initiated S1F1.
• GemOutcome::OnlineAck C++ Enumerator — Host received S1F18; ONLACK is in GemResultInfo::acknowledgement.
• GemOutcome::OnlineRejected C++ Enumerator — Equipment refused to go online; the ONLACK is in GemResultInfo::acknowledgement.
• GemOutcome::ProgramAckReceived C++ Enumerator — S7F4 or S7F18 arrived; ACKC7 is in GemResultInfo::acknowledgement.
• GemOutcome::ProgramDataReceived C++ Enumerator — S7F6 arrived; read it with GemResult::programItem().
• GemOutcome::ProgramDirectoryReceived C++ Enumerator — S7F20 arrived; read IDs with GemResult::programItem().
• GemOutcome::ProgramGrantReceived C++ Enumerator — S7F2 arrived; PPGNT is in GemResultInfo::acknowledgement.
• GemOutcome::ProgramReceived C++ Enumerator — A process program request (S7F1, S7F3 or S7F5, or S7F17/S7F19 at the equipment) arrived; call GemEndpoint::respondProgram().
• GemOutcome::Replied C++ Enumerator — The library replied to an incoming primary. Results whose reply the application sent with a respond call also report this outcome afterwards.
• GemOutcome::ReportQueryReceived C++ Enumerator — Equipment received S6F15, S6F19 or S6F21; call GemEquipment::respondReportQuery().
• GemOutcome::SpoolConfigurationAck C++ Enumerator — Host received S2F44; read rejected streams with GemResult::spoolError().
• GemOutcome::SpoolConfigurationData C++ Enumerator — Host received S2F60; read selections with GemResult::spoolSelection().
• GemOutcome::SpoolControlAck C++ Enumerator — Host received S6F24; RSDA is in GemResultInfo::acknowledgement.
• GemOutcome::SpoolDeliveryFailed C++ Enumerator — A spooled delivery attempt failed; the entry stays at the head of the spool.
• GemOutcome::SpoolDeliveryResponse C++ Enumerator — Equipment received the reply to a spooled W-bit message. Inspect the body, then call GemEndpoint::completeSpoolDelivery().
• GemOutcome::SpoolDeliveryWritten C++ Enumerator — A spooled message without W-bit was fully written to the socket.
• GemOutcome::SpoolReceived C++ Enumerator — Equipment received S2F43, S2F59 or S6F23; call GemEndpoint::respondSpool().
• GemOutcome::StatusReplied C++ Enumerator — Equipment answered a status request (S1F3 or S1F11) from its registered status variables.
• GemOutcome::ValuesReceived C++ Enumerator — Host received S1F4 status values; read them with GemResult::statusValue().
• GemProgramDurability C++ Enum — Durability reached by a process program store mutation.
• GemProgramDurability::Confirmed C++ Enumerator — The application accepted an unconfirmed installation with GemEndpoint::confirmProgramReply(). This is not a synchronization.
• GemProgramDurability::None C++ Enumerator — Nothing was installed.
• GemProgramDurability::Synced C++ Enumerator — Written to the file and the parent directory was synchronized.
• GemProgramDurability::Unconfirmed C++ Enumerator — Installed, but synchronizing the parent directory failed; the call reported PDCOMM_PROGRAM_UNCONFIRMED.
• GemProgramDurability::Volatile C++ Enumerator — Installed in memory only (no file was configured).
• GemProgramEntry C++ Struct — One stored process program, returned by GemEndpoint::programAt().
• GemProgramEntry::body C++ Field — Program body (PPBODY).
• GemProgramEntry::id C++ Field — Program ID (PPID): non-empty ASCII or Binary.
• GemProgramField C++ Enum — Field selector for GemResult::programItem().
• GemProgramField::Body C++ Enumerator — Process program body (PPBODY).
• GemProgramField::Id C++ Enumerator — Process program ID (PPID).
• GemProgramGrantPolicy C++ Enum — Whether an incoming S7F3 needs a preceding S7F1/F2 grant.
• GemProgramGrantPolicy::Optional C++ Enumerator — S7F3 is accepted with or without a grant.
• GemProgramGrantPolicy::Required C++ Enumerator — S7F3 must follow a granted S7F1 for the same ID and length.
• GemProgramInfo C++ Struct — Summary of a process program request or reply, returned by GemResult::programInfo().
• GemProgramInfo::acknowledgement C++ Field — Reply code (PPGNT or ACKC7); valid when #acknowledgementPresent is true.
• GemProgramInfo::acknowledgementPresent C++ Field — true when #acknowledgement is set.
• GemProgramInfo::applied C++ Field — true when processing the request changed the local store.
• GemProgramInfo::confirmationRequired C++ Field — true when the reply waits for GemEndpoint::confirmProgramReply() after an unconfirmed installation.
• GemProgramInfo::declaredLength C++ Field — LENGTH from an S7F1 request; 0 for other messages.
• GemProgramInfo::durability C++ Field — Durability reached while processing a request.
• GemProgramInfo::grantActivated C++ Field — true when an S7F2 grant was activated for this request; not a liveness indicator.
• GemProgramInfo::idCount C++ Field — Program IDs carried: 1 for S7F1/F3/F5 requests, the list size for S7F17, 0 for S7F19; for replies, 1 (known) or 0 (unknown) for S7F6 and the directory size for S7F20.
• GemProgramInfo::isRequest C++ Field — true for an incoming request.
• GemProgramInfo::persistenceStatus C++ Field — Status of the persistence step while processing a request.
• GemProgramInfo::replyReady C++ Field — true when a prepared reply is retained for retry.
• GemProgramInfo::request C++ Field — Program transaction kind.
• GemProgramInfo::responded C++ Field — true after GemEndpoint::respondProgram() sent the reply.
• GemProgramMode C++ Enum — How a process program write treats an existing program with the same ID.
• GemProgramMode::Create C++ Enumerator — Write only when the ID does not exist yet.
• GemProgramMode::Replace C++ Enumerator — Write only when the ID already exists.
• GemProgramMode::Upsert C++ Enumerator — Create or replace.
• GemProgramOptions C++ Typedef — Process program store limits; build them with gemProgramOptions().
• GemProgramState C++ Struct — State of the process program store, returned by GemEndpoint::programState().
• GemProgramState::bodyBytes C++ Field — Total bytes of stored program bodies.
• GemProgramState::grantCount C++ Field — Active S7F1/F2 grants.
• GemProgramState::identifierBytes C++ Field — Total bytes of stored program IDs.
• GemProgramState::persistent C++ Field — true when the store is backed by a file.
• GemProgramState::programCount C++ Field — Stored programs.
• GemProgramState::reservedBodyBytes C++ Field — Body bytes reserved by active grants.
• GemProgramWriteInfo C++ Struct — Outcome of a local process program store mutation.
• GemProgramWriteInfo::applied C++ Field — true when the change was installed.
• GemProgramWriteInfo::durability C++ Field — Durability reached.
• GemProgramWriteInfo::persistenceStatus C++ Field — Status of the persistence step, for example PDCOMM_IO_ERROR when synchronization failed.
• GemProgramWriteResult C++ Struct — Status and details of GemEndpoint::programPut() or GemEndpoint::programDeleteLocal().
• GemProgramWriteResult::info C++ Field — Details of the mutation.
• GemProgramWriteResult::status C++ Field — PDCOMM_OK, or PDCOMM_PROGRAM_UNCONFIRMED when the change was installed but its durability is unconfirmed. Do not repeat an unconfirmed mutation.
• GemQueryInfo C++ Struct — Summary of a report query request or reply, returned by GemResult::queryInfo().
• GemQueryInfo::dataId C++ Field — DATAID of an S6F16 reply; valid when #dataIdPresent is true.
• GemQueryInfo::dataIdPresent C++ Field — true for S6F16 replies.
• GemQueryInfo::id C++ Field — Requested CEID (event query) or RPTID (individual and annotated queries).
• GemQueryInfo::isRequest C++ Field — true for a request received by the equipment.
• GemQueryInfo::kind C++ Field — GemRequest::EventQuery, GemRequest::IndividualQuery or GemRequest::AnnotatedQuery.
• GemQueryInfo::reportCount C++ Field — Reports in an S6F16 reply; 0 otherwise.
• GemQueryInfo::responded C++ Field — true after GemEquipment::respondReportQuery() sent the reply.
• GemQueryInfo::valueCount C++ Field — Values in the reply; for S6F16 the total across reports.
• GemQueryReportInfo C++ Struct — One report of an S6F16 reply, returned by GemResult::queryReport().
• GemQueryReportInfo::id C++ Field — Report ID (RPTID).
• GemQueryReportInfo::valueCount C++ Field — Values in the report.
• GemQueryValue C++ Struct — One value of a report query reply, returned by GemResult::queryValue().
• GemQueryValue::value C++ Field — Value item.
• GemQueryValue::variableId C++ Field — VID; valid only when #variableIdPresent is true.
• GemQueryValue::variableIdPresent C++ Field — true only for S6F22 annotated replies.
• GemReportBinding C++ Struct — Maps a report variable ID (VID) to the store that supplies its value.
• GemReportBinding::constantId C++ Field — ECID item (scalar ASCII or integer) for a Constant source; nullptr otherwise. Borrowed.
• GemReportBinding::source C++ Field — Store that supplies the value.
• GemReportBinding::sourceId C++ Field — SVID or DVID for Status and Data sources; must be 0 for Constant.
• GemReportBinding::variableId C++ Field — VID used in report definitions; must be unique among bindings.
• GemReportDefinition C++ Struct — One defined report, returned by GemEquipment::reportAt().
• GemReportDefinition::id C++ Field — Report ID (RPTID).
• GemReportDefinition::variableIds C++ Field — Variable IDs in report order.
• GemReportSource C++ Enum — Store that supplies the value of a report variable.
• GemReportSource::Constant C++ Enumerator — An equipment constant (ECID).
• GemReportSource::Data C++ Enumerator — A data variable (DVID) from the data variable store.
• GemReportSource::Status C++ Enumerator — A registered status variable (SVID).
• GemReportSpec C++ Struct — One report definition for S2F33 or for a fixed report catalog.
• GemReportSpec::id C++ Field — Report ID (RPTID).
• GemReportSpec::variableIds C++ Field — Variable IDs (VIDs) in report order. In S2F33, an empty list deletes the report.
• GemReportState C++ Struct — Counters of the equipment's report and event store.
• GemReportState::eventCount C++ Field — Configured collection events.
• GemReportState::reportCount C++ Field — Defined reports.
• GemReportState::totalLinks C++ Field — Event-to-report links across all events.
• GemReportState::totalVariables C++ Field — Variable references across all reports.
• GemRequest C++ Enum — Kind of GEM transaction that a request, token or result belongs to.
• GemRequest::AlarmList C++ Enumerator — S5F5/F6 List Alarms Request and Data.
• GemRequest::AlarmReport C++ Enumerator — S5F1/F2 Alarm Report Send and Acknowledge.
• GemRequest::AnnotatedQuery C++ Enumerator — S6F21/F22 Annotated Individual Report Request and Data.
• GemRequest::AreYouOnline C++ Enumerator — S1F1/F2 Are You There, sent by a host. The equipment's operator-initiated S1F1 from GemEquipment::operatorOnline() is reported as OperatorOnline instead.
• GemRequest::ChangeConstants C++ Enumerator — S2F15/F16 New Equipment Constant Send and Acknowledge.
• GemRequest::ConstantMetadata C++ Enumerator — S2F29/F30 Equipment Constant Namelist Request and Reply.
• GemRequest::ConstantValues C++ Enumerator — S2F13/F14 Equipment Constant Request and Data.
• GemRequest::DataDirectory C++ Enumerator — S1F21/F22 Data Variable Namelist Request and Data.
• GemRequest::DefineReports C++ Enumerator — S2F33/F34 Define Report.
• GemRequest::EnableAlarm C++ Enumerator — S5F3/F4 Enable/Disable Alarm Send.
• GemRequest::EnableEvents C++ Enumerator — S2F37/F38 Enable/Disable Event Report.
• GemRequest::EnabledAlarmList C++ Enumerator — S5F7/F8 List Enabled Alarm Request and Data.
• GemRequest::EnhancedRemoteCommand C++ Enumerator — S2F49/F50 Enhanced Remote Command and Acknowledge.
• GemRequest::Establish C++ Enumerator — S1F13/F14 Establish Communications Request.
• GemRequest::EventDirectory C++ Enumerator — S1F23/F24 Collection Event Namelist Request and Data.
• GemRequest::EventQuery C++ Enumerator — S6F15/F16 Event Report Request and Data.
• GemRequest::EventReport C++ Enumerator — S6F11/F12 Event Report Send and Acknowledge.
• GemRequest::FormattedProgramCapabilitySend C++ Enumerator — S7F21/F22 Process Capability Request and Data.
• GemRequest::FormattedProgramQuerySend C++ Enumerator — S7F25/F26 Formatted Process Program Request and Data.
• GemRequest::FormattedProgramSend C++ Enumerator — S7F27/F28 Process Program Verification Send.
• GemRequest::FormattedProgramTransferSend C++ Enumerator — S7F23/F24 Formatted Process Program Send.
• GemRequest::FormattedProgramVerificationNegotiationSend C++ Enumerator — S7F29/F30 Process Program Verification Inquire and Grant, followed by S7F27/F28.
• GemRequest::FormattedProgramVerificationRequestSend C++ Enumerator — S7F31/F32 Verification Request Send.
• GemRequest::IndividualQuery C++ Enumerator — S6F19/F20 Individual Report Request and Data.
• GemRequest::LinkReports C++ Enumerator — S2F35/F36 Link Event Report.
• GemRequest::Offline C++ Enumerator — S1F15/F16 Request OFF-LINE.
• GemRequest::Online C++ Enumerator — S1F17/F18 Request ON-LINE.
• GemRequest::OperatorOnline C++ Enumerator — The equipment's operator-initiated S1F1/F2 ON-LINE attempt from GemEquipment::operatorOnline(). GemHost::request() rejects it.
• GemRequest::ProgramDelete C++ Enumerator — S7F17/F18 Delete Process Program Send and Acknowledge.
• GemRequest::ProgramDirectory C++ Enumerator — S7F19/F20 Current Process Program Directory Request and Data.
• GemRequest::ProgramGrant C++ Enumerator — S7F1/F2 Process Program Load Inquire and Grant.
• GemRequest::ProgramRequest C++ Enumerator — S7F5/F6 Process Program Request and Data.
• GemRequest::ProgramSend C++ Enumerator — S7F3/F4 Process Program Send and Acknowledge.
• GemRequest::RemoteCommand C++ Enumerator — S2F41/F42 Host Command Send and Acknowledge.
• GemRequest::SpoolConfigure C++ Enumerator — S2F43/F44 Reset Spooling Streams and Functions.
• GemRequest::SpoolControl C++ Enumerator — S6F23/F24 Request Spooled Data (transmit or purge).
• GemRequest::SpoolDelivery C++ Enumerator — Delivery of one spooled message, started by GemEndpoint::sendNextSpool().
• GemRequest::SpoolQuery C++ Enumerator — S2F59/F60 query of the current spooling selection.
• GemRequest::StatusNames C++ Enumerator — S1F11/F12 Status Variable Namelist Request and Reply.
• GemRequest::StatusValues C++ Enumerator — S1F3/F4 Selected Equipment Status Request and Data.
• GemResult C++ Class — Owned snapshot of one TCP event after GEM processing.
• GemResult::GemResult C++ Constructor — Creates an empty result that owns no native handle.
• GemResult::GemResult C++ Constructor — Takes ownership of the native handle owned by other.
• GemResult::GemResult C++ Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• GemResult::adopt C++ Method — Wraps a native result handle and takes ownership of it.
• GemResult::alarmAt C++ Method — Returns one alarm of a received S5F1 report or S5F6/S5F8 list.
• GemResult::alarmInfo C++ Method — Summarizes a received S5F1 alarm report or S5F6/S5F8 alarm list.
• GemResult::body C++ Method — Returns a copy of the message body.
• GemResult::commandInfo C++ Method — Summarizes a received S2F41 request (equipment) or S2F42 reply (host).
• GemResult::commandIssue C++ Method — Returns one parameter issue: a validation issue of a request, or a CPACK entry of a reply.
• GemResult::commandName C++ Method — Returns the RCMD of a received S2F41 request in its wire format.
• GemResult::commandParameter C++ Method — Returns one (CPNAME, CPVAL) pair of a received S2F41 request.
• GemResult::constantChange C++ Method — Returns one proposed change of a received S2F15 request.
• GemResult::constantChangeInfo C++ Method — Summarizes a received S2F15 request (equipment) or S2F16 reply (host).
• GemResult::constantMetadata C++ Method — Returns one field of one row of an S2F30 namelist reply received by a host.
• GemResult::constantValue C++ Method — Returns one value of an S2F14 equipment constant reply received by a host.
• GemResult::definition C++ Method — Alias of statusName().
• GemResult::directory C++ Method — Alias of directoryGet().
• GemResult::directoryAt C++ Method — Returns one row of an S1F22 or S1F24 namelist reply received by a host.
• GemResult::directoryGet C++ Method — Returns one field of one row of an S1F22 or S1F24 namelist reply.
• GemResult::enhancedCommandAcknowledgements C++ Method — Returns the outer acknowledgement list of an enhanced command result.
• GemResult::enhancedCommandInfo C++ Method — Summarizes a received S2F49 request (equipment) or S2F50 reply (host).
• GemResult::enhancedCommandName C++ Method — Returns the RCMD of a received S2F49 request.
• GemResult::enhancedCommandObject C++ Method — Returns the OBJSPEC of a received S2F49 request.
• GemResult::enhancedCommandParameter C++ Method — Returns one (CPNAME, CEPVAL) pair of a received S2F49 request.
• GemResult::eventInfo C++ Method — Returns the header of an S6F11 event report received by a host.
• GemResult::eventReport C++ Method — Returns one report of a received S6F11.
• GemResult::eventValue C++ Method — Returns one value of one report of a received S6F11.
• GemResult::info C++ Method — Returns the kind, outcome, request kind, codes, token and state of this result.
• GemResult::nativeHandle C++ Method — Returns the owned native handle for direct C API calls.
• GemResult::nativeHandle C++ Method — Returns the owned native handle for read-only C API calls.
• GemResult::operator bool C++ Method — Reports whether the wrapper owns a native result.
• GemResult::operator= C++ Method — Releases the current handle, then takes ownership of the handle owned by other.
• GemResult::operator= C++ Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• GemResult::programInfo C++ Method — Summarizes a process program request or reply (stream 7, functions 1 to 6, 17 to 20).
• GemResult::programItem C++ Method — Returns a program ID or body carried by a program result.
• GemResult::queryInfo C++ Method — Summarizes a report query request (equipment) or its S6F16/S6F20/S6F22 reply (host).
• GemResult::queryReport C++ Method — Returns one report of an S6F16 reply.
• GemResult::queryValue C++ Method — Returns one value of a report query reply.
• GemResult::spoolError C++ Method — Returns one rejected stream of an S2F44 reply received by a host.
• GemResult::spoolInfo C++ Method — Summarizes a spool request, reply or delivery result.
• GemResult::spoolSelection C++ Method — Returns one stream selection of a received S2F43 request or an S2F60 reply.
• GemResult::statusName C++ Method — Returns one row of an S1F12 status variable namelist reply.
• GemResult::statusValue C++ Method — Returns one status value of an S1F4 reply.
• GemResult::value C++ Method — Alias of statusValue().
• GemResult::value C++ Method — Alias of eventValue().
• GemResult::~GemResult C++ Method — Releases the native handle with pdcomm_gem_result_destroy().
• GemResultInfo C++ Struct — Common information about a GemResult, returned by GemResult::info().
• GemResultInfo::acknowledgement C++ Field — Acknowledgement code from the reply (for example COMMACK, ONLACK, DRACK or HCACK); valid only when #acknowledgementPresent is true.
• GemResultInfo::acknowledgementPresent C++ Field — true when #acknowledgement holds a received or sent acknowledgement code.
• GemResultInfo::code C++ Field — Failure detail: a PDCOMM_TCP_* failure reason for Failed results, or a PDCOMM_GEM_ERROR_* value for InvalidResponse and Unhandled results; otherwise 0.
• GemResultInfo::entryCount C++ Field — Number of entries that the typed getters can read (values, names, alarms, reports, rows or IDs, depending on the outcome).
• GemResultInfo::kind C++ Field — Result classification.
• GemResultInfo::outcome C++ Field — Meaning of the result.
• GemResultInfo::replySent C++ Field — true when a reply to an incoming primary was sent, by the library or by a respond call.
• GemResultInfo::request C++ Field — Transaction kind the result belongs to.
• GemResultInfo::state C++ Field — Endpoint state captured when the result was produced.
• GemResultInfo::token C++ Field — Transaction token: the submitted request's token for replies and failures, or the incoming message's identity for primaries.
• GemResultKind C++ Enum — Classification of a GemResult returned by GemEndpoint::handleEvent().
• GemResultKind::Failed C++ Enumerator — A pending request ended without a reply. GemResultInfo::code holds a TCP failure reason such as PDCOMM_TCP_T3_TIMEOUT, PDCOMM_TCP_CANCELLED or PDCOMM_TCP_DISCONNECTED.
• GemResultKind::Ignored C++ Enumerator — The TCP event is not a GEM message (for example an HSMS state change). Nothing to do.
• GemResultKind::InvalidResponse C++ Enumerator — A reply arrived but failed validation, or was an abort (function 0). The matching pending request is cleared and GemResultInfo::code holds a PDCOMM_GEM_ERROR_* value.
• GemResultKind::Primary C++ Enumerator — An incoming primary message was validated. Check GemResultInfo::replySent: the library already replied to many requests, while others wait for an explicit respond call.
• GemResultKind::Response C++ Enumerator — A valid reply to one of this endpoint's requests arrived; GemResultInfo::token matches the token returned when the request was submitted.
• GemResultKind::Unhandled C++ Enumerator — The library did not handle an incoming primary and sent no reply. GemResultInfo::code holds a PDCOMM_GEM_ERROR_* value. Reply explicitly with TcpEndpoint::reply() on the original event (for example an F0 abort), or close the endpoint.
• GemRole C++ Enum — GEM role configured on an endpoint (SEMI E30).
• GemRole::Equipment C++ Enumerator — Equipment role: the tool that answers host requests and reports events and alarms.
• GemRole::Host C++ Enumerator — Host role: the factory system that sends requests to equipment.
• GemSpoolCommand C++ Enum — RSDC value of S6F23 Request Spooled Data.
• GemSpoolCommand::Purge C++ Enumerator — Delete the spooled messages.
• GemSpoolCommand::Transmit C++ Enumerator — Transmit the spooled messages.
• GemSpoolDeliveryProof C++ Enum — Evidence carried by a spool delivery result.
• GemSpoolDeliveryProof::None C++ Enumerator — No usable delivery proof.
• GemSpoolDeliveryProof::Response C++ Enumerator — The matching reply to a W-bit message arrived.
• GemSpoolDeliveryProof::Written C++ Enumerator — A message without W-bit was fully written locally; this is not peer receipt.
• GemSpoolDurability C++ Enum — Durability reached by a spool mutation.
• GemSpoolDurability::Confirmed C++ Enumerator — The application accepted an unconfirmed reply with GemEndpoint::confirmSpoolReply(). This is not a synchronization.
• GemSpoolDurability::None C++ Enumerator — Nothing was installed.
• GemSpoolDurability::Synced C++ Enumerator — Written to the file and the parent directory was synchronized.
• GemSpoolDurability::Unconfirmed C++ Enumerator — Installed, but synchronizing the parent directory failed; the call reported PDCOMM_SPOOL_UNCONFIRMED.
• GemSpoolDurability::Volatile C++ Enumerator — Installed in memory only (no file was configured).
• GemSpoolEntry C++ Struct — One stored message, returned by GemEndpoint::spoolEntryAt().
• GemSpoolEntry::body C++ Field — Message body; an empty item when #bodyPresent is false.
• GemSpoolEntry::bodyPresent C++ Field — false for a header-only message; differs from an empty body.
• GemSpoolEntry::captureTimePresent C++ Field — false for entries from older snapshots without a capture time.
• GemSpoolEntry::capturedAt C++ Field — Application timestamp passed when the message was captured.
• GemSpoolEntry::entryId C++ Field — Entry ID.
• GemSpoolEntry::function C++ Field — Function number.
• GemSpoolEntry::replyExpected C++ Field — W-bit of the stored message.
• GemSpoolEntry::stream C++ Field — Stream number.
• GemSpoolError C++ Struct — One rejected stream of an S2F44 reply, returned by GemResult::spoolError().
• GemSpoolError::acknowledgement C++ Field — STRACK for the stream.
• GemSpoolError::functions C++ Field — Rejected functions as a U1 array item.
• GemSpoolError::stream C++ Field — Stream number.
• GemSpoolHostOptions C++ Typedef — Host spool request limits; build them with gemSpoolHostOptions().
• GemSpoolInfo C++ Struct — Summary of a spool request, reply or delivery result, returned by GemResult::spoolInfo().
• GemSpoolInfo::acknowledgement C++ Field — RSPACK or RSDA; valid when #acknowledgementPresent is true.
• GemSpoolInfo::acknowledgementPresent C++ Field — true when #acknowledgement is set.
• GemSpoolInfo::applied C++ Field — true when processing changed the spool.
• GemSpoolInfo::command C++ Field — RSDC of an S6F23 request.
• GemSpoolInfo::confirmationRequired C++ Field — true when the reply waits for GemEndpoint::confirmSpoolReply().
• GemSpoolInfo::deliveryAttempt C++ Field — Delivery attempt number.
• GemSpoolInfo::deliveryCompleted C++ Field — true after GemEndpoint::completeSpoolDelivery() accepted this delivery result.
• GemSpoolInfo::deliveryProof C++ Field — Proof type carried by a delivery result.
• GemSpoolInfo::dequeuePending C++ Field — true when removing the delivered entry failed and needs GemEndpoint::retrySpoolDequeue().
• GemSpoolInfo::durability C++ Field — Durability reached while processing a request.
• GemSpoolInfo::entryId C++ Field — Spool entry delivered by a delivery result.
• GemSpoolInfo::errorCount C++ Field — Rejected streams in an S2F44 reply.
• GemSpoolInfo::isRequest C++ Field — true for a request received by the equipment.
• GemSpoolInfo::persistenceStatus C++ Field — Status of the persistence step.
• GemSpoolInfo::replyReady C++ Field — true when a prepared reply is retained for retry.
• GemSpoolInfo::request C++ Field — Spool transaction kind.
• GemSpoolInfo::responded C++ Field — true after GemEndpoint::respondSpool() sent the reply.
• GemSpoolInfo::selectionCount C++ Field — Selections in an S2F43 request or S2F60 reply.
• GemSpoolInfo::successAccepted C++ Field — true when a successful completion was accepted for this delivery.
• GemSpoolMessageKey C++ Struct — Stream and function of a primary message that may be spooled.
• GemSpoolMessageKey::function C++ Field — Function number of a primary message (odd). The stream must be 2 to 127.
• GemSpoolMessageKey::stream C++ Field — Stream number.
• GemSpoolMutation C++ Enum — Kind of change a spool call made.
• GemSpoolMutation::Activated C++ Enumerator — Spooling became active because communication was lost.
• GemSpoolMutation::Captured C++ Enumerator — A message was stored.
• GemSpoolMutation::Configured C++ Enumerator — Spooling configuration or selection changed.
• GemSpoolMutation::Discarded C++ Enumerator — A message was discarded because the spool was full (statistics changed).
• GemSpoolMutation::None C++ Enumerator — No change.
• GemSpoolMutation::Purged C++ Enumerator — All stored messages were deleted.
• GemSpoolMutation::Removed C++ Enumerator — A delivered message was removed from the head of the spool.
• GemSpoolOptions C++ Typedef — Equipment spool limits; build them with gemSpoolOptions().
• GemSpoolOverflow C++ Enum — What the equipment spool does when it is full.
• GemSpoolOverflow::DiscardNew C++ Enumerator — Discard the new message and keep the stored ones.
• GemSpoolOverflow::OverwriteOldest C++ Enumerator — Remove the oldest stored message to make room.
• GemSpoolPolicy C++ Struct — Local spooling policy for GemEquipment::configureLocalSpooling().
• GemSpoolPolicy::enabled C++ Field — Global spooling switch, separate from the stream selection.
• GemSpoolPolicy::maxTransmit C++ Field — Maximum messages sent per transmit run; 0 means unbounded.
• GemSpoolPolicy::overflow C++ Field — Behaviour when the spool is full.
• GemSpoolSelection C++ Struct — Stream and functions selected for spooling (S2F43 entry or local selection).
• GemSpoolSelection::functions C++ Field — Selected functions; an empty list selects every registered primary of the stream.
• GemSpoolSelection::stream C++ Field — Stream number.
• GemSpoolState C++ Struct — State of the spool, returned by GemEndpoint::spoolState().
• GemSpoolState::active C++ Field — true while spooling is active (communication lost).
• GemSpoolState::bodyBytes C++ Field — Total bytes of stored message bodies.
• GemSpoolState::catalogCount C++ Field — Registered spoolable stream and function pairs.
• GemSpoolState::connected C++ Field — Connection state observed at the last synchronization.
• GemSpoolState::deliveryPending C++ Field — true while a delivery attempt is in flight.
• GemSpoolState::dequeuePending C++ Field — true when a delivered entry still waits for GemEndpoint::retrySpoolDequeue().
• GemSpoolState::discarded C++ Field — Messages discarded or overwritten because the spool was full.
• GemSpoolState::enabled C++ Field — Global spooling switch.
• GemSpoolState::fullTime C++ Field — Application timestamp when the spool became full; valid when #fullTimePresent is true.
• GemSpoolState::fullTimePresent C++ Field — true when #fullTime is set.
• GemSpoolState::maxTransmit C++ Field — Configured messages per transmit run; 0 means unbounded.
• GemSpoolState::messageCount C++ Field — Stored messages.
• GemSpoolState::nextId C++ Field — ID the next stored entry will get.
• GemSpoolState::overflow C++ Field — Configured overflow behaviour.
• GemSpoolState::persistent C++ Field — true when the spool is backed by a file.
• GemSpoolState::received C++ Field — Selected messages offered for capture.
• GemSpoolState::selectionCount C++ Field — Selected streams.
• GemSpoolState::startTime C++ Field — Application timestamp when spooling started; valid when #startTimePresent is true.
• GemSpoolState::startTimePresent C++ Field — true when #startTime is set.
• GemSpoolState::stored C++ Field — Messages stored.
• GemSpoolState::synchronized C++ Field — true when GemEquipment::syncSpool() observed the current connection state.
• GemSpoolState::transmitted C++ Field — Messages delivered and removed from the spool.
• GemSpoolState::transmittedInRun C++ Field — Messages sent in the current transmit run.
• GemSpoolState::transmitting C++ Field — true during a transmit run accepted by S6F23.
• GemSpoolWriteInfo C++ Struct — Outcome of a spool mutation.
• GemSpoolWriteInfo::affectedCount C++ Field — Entries overwritten on capture, removed on purge, or 1 on dequeue.
• GemSpoolWriteInfo::applied C++ Field — true when the change was installed.
• GemSpoolWriteInfo::durability C++ Field — Durability reached.
• GemSpoolWriteInfo::entryId C++ Field — ID of the captured or removed entry.
• GemSpoolWriteInfo::mutation C++ Field — Kind of change made.
• GemSpoolWriteInfo::persistenceStatus C++ Field — Status of the persistence step, for example PDCOMM_IO_ERROR.
• GemSpoolWriteInfo::selected C++ Field — true when a captured message was within the selection.
• GemSpoolWriteResult C++ Struct — Status and details of a spool mutation.
• GemSpoolWriteResult::info C++ Field — Details of the mutation.
• GemSpoolWriteResult::status C++ Field — PDCOMM_OK, or PDCOMM_SPOOL_UNCONFIRMED when the change was installed but its durability is unconfirmed. Do not repeat an unconfirmed mutation.
• GemState C++ Struct — Snapshot of an endpoint's GEM state, returned by GemEndpoint::state().
• GemState::communication C++ Field — Communication state (SEMI E30).
• GemState::control C++ Field — Control state; GemControl::Unavailable for a host.
• GemState::endpointId C++ Field — Process-unique identity of the endpoint, also carried in every token.
• GemState::generation C++ Field — HSMS connection generation; it changes on every new connection.
• GemState::onlineMode C++ Field — Online substate used when going online; GemOnlineMode::Unavailable for a host.
• GemState::pendingCount C++ Field — Native requests waiting for a reply (at most 32).
• GemState::pendingIds C++ Field — Identifiers held by pending requests, counted against the configured max_pending_ids.
• GemState::role C++ Field — Configured role.
• GemState::variableCount C++ Field — Registered status variables at the equipment; 0 for a host.
• GemStatusName C++ Struct — Status variable name and units, from S1F12 or from local equipment metadata.
• GemStatusName::id C++ Field — Status variable ID (SVID).
• GemStatusName::name C++ Field — Name (SVNAME), length-delimited ASCII; embedded NUL bytes are kept.
• GemStatusName::units C++ Field — Units, length-delimited ASCII; may be empty.
• GemStatusValue C++ Struct — One status value from an S1F4 reply, returned by GemResult::statusValue().
• GemStatusValue::id C++ Field — Requested status variable ID (SVID); valid only when #idPresent is true.
• GemStatusValue::idPresent C++ Field — true for replies to an explicit ID list. A request for all values has no IDs on the wire.
• GemStatusValue::value C++ Field — Independently owned value item. An empty list alone does not prove that the SVID is unknown.
• Secs1BorrowedIo C++ Class — A non-owning I/O binding built from raw C callbacks.
• Secs1BorrowedIo::Secs1BorrowedIo C++ Constructor — Moving is disabled; endpoints refer to this binding by address.
• Secs1BorrowedIo::Secs1BorrowedIo C++ Constructor — Copying is disabled; endpoints refer to this binding by address.
• Secs1BorrowedIo::Secs1BorrowedIo C++ Constructor — Fills the callback table.
• Secs1BorrowedIo::native C++ Method — Returns the callback table that Secs1Endpoint passes to pdcomm_secs1_create().
• Secs1BorrowedIo::operator= C++ Method — Move assignment is disabled; endpoints refer to this binding by address.
• Secs1BorrowedIo::operator= C++ Method — Copy assignment is disabled; endpoints refer to this binding by address.
• Secs1Endpoint C++ Class — Move-only owner of one SECS-I (SEMI E4) endpoint over caller-provided serial I/O.
• Secs1Endpoint::Secs1Endpoint C++ Constructor — Creates a stopped SECS-I endpoint with pdcomm_secs1_create().
• Secs1Endpoint::Secs1Endpoint C++ Constructor — Takes ownership of the native handle owned by other.
• Secs1Endpoint::Secs1Endpoint C++ Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• Secs1Endpoint::nativeHandle C++ Method — Returns the owned native handle for direct C API calls.
• Secs1Endpoint::nativeHandle C++ Method — Returns the owned native handle for read-only C API calls.
• Secs1Endpoint::nextEvent C++ Method — Takes the oldest queued event, with pdcomm_secs1_next_event().
• Secs1Endpoint::operator= C++ Method — Releases the current handle, then takes ownership of the handle owned by other.
• Secs1Endpoint::operator= C++ Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• Secs1Endpoint::poll C++ Method — Runs line control, timers and callback I/O for one time slice, with pdcomm_secs1_poll().
• Secs1Endpoint::reset C++ Method — Clears a terminal fault so the endpoint can transfer messages again, with pdcomm_secs1_reset().
• Secs1Endpoint::start C++ Method — Starts a created or stopped endpoint with pdcomm_secs1_start().
• Secs1Endpoint::state C++ Method — Reads the identity and lifecycle flags of the endpoint, with pdcomm_secs1_state().
• Secs1Endpoint::stop C++ Method — Stops a started endpoint and discards its runtime state, with pdcomm_secs1_stop().
• Secs1Endpoint::submit C++ Method — Queues one message for transmission, with pdcomm_secs1_submit().
• Secs1Endpoint::~Secs1Endpoint C++ Method — Releases the endpoint with pdcomm_secs1_destroy(), without invoking callbacks.
• Secs1Event C++ Class — Owned, immutable snapshot of one SECS-I endpoint event.
• Secs1Event::Secs1Event C++ Constructor — Creates an empty event that owns no native handle.
• Secs1Event::Secs1Event C++ Constructor — Takes ownership of the native handle owned by other.
• Secs1Event::Secs1Event C++ Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• Secs1Event::body C++ Method — Copies the body of a received message.
• Secs1Event::info C++ Method — Describes the event with pdcomm_secs1_event_info().
• Secs1Event::operator bool C++ Method — Reports whether the wrapper owns a native event.
• Secs1Event::operator= C++ Method — Releases the current handle, then takes ownership of the handle owned by other.
• Secs1Event::operator= C++ Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• Secs1Event::~Secs1Event C++ Method — Releases the native event with pdcomm_secs1_event_destroy().
• Secs1IoAdapter C++ Class — Owns a typed serial port and exposes it to a Secs1Endpoint through exception-safe callbacks.
• Secs1IoAdapter::Secs1IoAdapter C++ Constructor — Constructs the port in place and fills the callback table.
• Secs1IoAdapter::Secs1IoAdapter C++ Constructor — Moving is disabled; the callback context is this adapter's address.
• Secs1IoAdapter::Secs1IoAdapter C++ Constructor — Copying is disabled; the callback context is this adapter's address.
• Secs1IoAdapter::native C++ Method — Returns the callback table that Secs1Endpoint passes to pdcomm_secs1_create().
• Secs1IoAdapter::operator= C++ Method — Move assignment is disabled; the callback context is this adapter's address.
• Secs1IoAdapter::operator= C++ Method — Copy assignment is disabled; the callback context is this adapter's address.
• Secs1IoAdapter::port C++ Method — Returns the owned port.
• Secs1IoAdapter::port C++ Method — Returns the owned port for read-only access.
• SecsItem C++ Class — Owned, immutable SECS-II data item (SEMI E5 section 9).
• SecsItem::SecsItem C++ Constructor — Creates an empty item that owns no native handle.
• SecsItem::SecsItem C++ Constructor — Takes ownership of the native handle owned by other.
• SecsItem::SecsItem C++ Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• SecsItem::adopt C++ Method — Wraps a native item handle and takes ownership of it.
• SecsItem::bytes C++ Method — Encodes the item into SECS-II wire format.
• SecsItem::child C++ Method — Returns a copy of one child of a list item.
• SecsItem::decode C++ Method — Decodes exactly one encoded SECS-II item from a vector.
• SecsItem::decode C++ Method — Decodes exactly one encoded SECS-II item.
• SecsItem::info C++ Method — Describes the item's format and size.
• SecsItem::list C++ Method — Creates a list item that contains copies of children.
• SecsItem::list C++ Method — Creates a list item that contains copies of children.
• SecsItem::nativeHandle C++ Method — Returns the owned native handle for direct C API calls.
• SecsItem::nativeHandle C++ Method — Returns the owned native handle for read-only C API calls.
• SecsItem::operator bool C++ Method — Reports whether the wrapper owns a native item.
• SecsItem::operator= C++ Method — Releases the current handle, then takes ownership of the handle owned by other.
• SecsItem::operator= C++ Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• SecsItem::payload C++ Method — Copies the raw payload bytes of a primitive item.
• SecsItem::primitive C++ Method — Creates a primitive item from a payload vector.
• SecsItem::primitive C++ Method — Creates a primitive item from raw payload bytes.
• SecsItem::~SecsItem C++ Method — Releases the native handle with pdcomm_secs_destroy().
• TcpEndpoint C++ Class — Move-only owner of one HSMS (SEMI E37) endpoint over TCP/IP.
• TcpEndpoint::TcpEndpoint C++ Constructor — Creates an empty endpoint that owns no native handle.
• TcpEndpoint::TcpEndpoint C++ Constructor — Takes ownership of the native handle owned by other.
• TcpEndpoint::TcpEndpoint C++ Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• TcpEndpoint::TcpEndpoint C++ Constructor — Creates an HSMS endpoint with pdcomm_tcp_create().
• TcpEndpoint::TcpEndpoint C++ Constructor — Creates an HSMS endpoint from an address string.
• TcpEndpoint::cancel C++ Method — Cancels an open transaction with pdcomm_tcp_cancel().
• TcpEndpoint::deselect C++ Method — Sends Deselect.req to leave the SELECTED state, with pdcomm_tcp_deselect().
• TcpEndpoint::isPending C++ Method — Reports whether a transaction still waits for its response, with pdcomm_tcp_is_pending().
• TcpEndpoint::linktest C++ Method — Sends Linktest.req to check that the connection is alive, with pdcomm_tcp_linktest().
• TcpEndpoint::localAddress C++ Method — Returns the local socket address as text.
• TcpEndpoint::nativeHandle C++ Method — Returns the owned native handle for direct C API calls.
• TcpEndpoint::nativeHandle C++ Method — Returns the owned native handle for read-only C API calls.
• TcpEndpoint::nextEvent C++ Method — Removes the oldest event from the endpoint's event queue, with pdcomm_tcp_next_event().
• TcpEndpoint::operator bool C++ Method — Reports whether the wrapper owns a native endpoint.
• TcpEndpoint::operator= C++ Method — Releases the current handle, then takes ownership of the handle owned by other.
• TcpEndpoint::operator= C++ Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• TcpEndpoint::poll C++ Method — Performs pending socket I/O and HSMS timer processing with pdcomm_tcp_poll().
• TcpEndpoint::reply C++ Method — Submits the reply to a received W-bit primary, with a body held in a vector.
• TcpEndpoint::reply C++ Method — Submits the reply to a received primary that has the W-bit set, with pdcomm_tcp_reply().
• TcpEndpoint::request C++ Method — Submits a primary data message whose body is held in a vector.
• TcpEndpoint::request C++ Method — Submits a primary data message with pdcomm_tcp_request().
• TcpEndpoint::select C++ Method — Sends Select.req to enter the SELECTED state, with pdcomm_tcp_select().
• TcpEndpoint::start C++ Method — Starts a new connection generation with pdcomm_tcp_start().
• TcpEndpoint::state C++ Method — Reads the endpoint identity, generation, HSMS state and close status.
• TcpEndpoint::stop C++ Method — Stops the endpoint and starts a graceful close with pdcomm_tcp_stop().
• TcpEndpoint::~TcpEndpoint C++ Method — Releases the endpoint and its sockets with pdcomm_tcp_destroy().
• TcpEvent C++ Class — Owned, immutable snapshot of one HSMS endpoint event.
• TcpEvent::TcpEvent C++ Constructor — Creates an empty event that owns no native handle.
• TcpEvent::TcpEvent C++ Constructor — Takes ownership of the native handle owned by other.
• TcpEvent::TcpEvent C++ Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• TcpEvent::body C++ Method — Copies the message body of a received data message.
• TcpEvent::info C++ Method — Decodes the kind, codes, message header and token of the event.
• TcpEvent::nativeHandle C++ Method — Returns the owned native handle for direct C API calls.
• TcpEvent::nativeHandle C++ Method — Returns the owned native handle for read-only C API calls.
• TcpEvent::operator bool C++ Method — Reports whether the wrapper owns a native event.
• TcpEvent::operator= C++ Method — Releases the current handle, then takes ownership of the handle owned by other.
• TcpEvent::operator= C++ Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• TcpEvent::~TcpEvent C++ Method — Releases the native event with pdcomm_tcp_event_destroy().
• cancelFormattedProgramExecution C++ Function — Requests cancellation of a running execution as a cancel action.
• checkFormattedProgramDryRunStatus C++ Function — Throws pdcomm::Error when status is not PDCOMM_OK.
• checkFormattedProgramExecutionStatus C++ Function — Throws pdcomm::Error when status is not PDCOMM_OK.
• clearFormattedProgramCapabilityCatalog C++ Function — Removes the equipment's capability catalog.
• clearFormattedProgramSelection C++ Function — Clears the current selection when token matches it.
• completeFormattedProgramExecution C++ Function — Submits the application's final report with detail bytes from a vector.
• completeFormattedProgramExecution C++ Function — Submits the application's final report for a running execution.
• configureFormattedProgramCapabilities C++ Function — Enables S7F21/F22 process capability exchange on an endpoint.
• configureFormattedProgramQueries C++ Function — Enables S7F25/F26 formatted process program requests on an endpoint.
• configureFormattedProgramTransfers C++ Function — Enables S7F23/F24 formatted process program transfer on an endpoint.
• configureFormattedProgramVerificationNegotiation C++ Function — Enables S7F29/F30 verification negotiation on an endpoint.
• configureFormattedProgramVerificationRequests C++ Function — Enables S7F31/F32 verification requests on an endpoint.
• configureFormattedPrograms C++ Function — Enables S7F27/F28 process program verification on an endpoint.
• dryRunFormattedProgram C++ Function — Analyses the selected formatted program against the equipment's capability catalog.
• formattedProgramCapabilityCommandInfo C++ Function — Describes one command of a received S7F22.
• formattedProgramCapabilityCommandText C++ Function — Copies the CCODE or CNAME of one command of a received S7F22.
• formattedProgramCapabilityDependency C++ Function — Returns one entry of a dependency list of one command of a received S7F22.
• formattedProgramCapabilityInfo C++ Function — Summarizes an S7F21 request or S7F22 reply carried by result.
• formattedProgramCapabilityModel C++ Function — Copies the MDLN of a received S7F22.
• formattedProgramCapabilityParameter C++ Function — Returns one parameter description of one command of a received S7F22.
• formattedProgramCapabilitySoftwareRevision C++ Function — Copies the SOFTREV of a received S7F22.
• formattedProgramCapabilityText C++ Function — Copies the MDLN or SOFTREV of a received S7F22.
• formattedProgramDryRunReportHandle C++ Function — Returns the native handle of report.
• formattedProgramExecutionActionTokenOutput C++ Function — Converts a wrapper action token into the versioned C action token structure.
• formattedProgramExecutionSnapshot C++ Function — Copies the current execution state into a snapshot.
• formattedProgramExecutionToken C++ Function — Converts a C execution token into the wrapper token.
• formattedProgramExecutionTokenOutput C++ Function — Converts a wrapper execution token into the versioned C token structure.
• formattedProgramId C++ Function — Returns the PPID of an S7F27 report.
• formattedProgramInfo C++ Function — Summarizes an S7F27 request or S7F28 reply carried by result.
• formattedProgramIssue C++ Function — Copies one verification entry of an S7F27 report.
• formattedProgramQueryCommandCode C++ Function — Returns the CCODE of one command of a returned program.
• formattedProgramQueryCommandInfo C++ Function — Describes one command of a returned program.
• formattedProgramQueryId C++ Function — Returns the requested PPID of an S7F25 request or S7F26 reply.
• formattedProgramQueryInfo C++ Function — Summarizes an S7F25 request or S7F26 reply carried by result.
• formattedProgramQueryModel C++ Function — Copies the MDLN of a returned program.
• formattedProgramQueryParameter C++ Function — Returns one PPARM of one command of a returned program.
• formattedProgramQuerySoftwareRevision C++ Function — Copies the SOFTREV of a returned program.
• formattedProgramQueryText C++ Function — Copies the MDLN or SOFTREV of a returned program.
• formattedProgramSelectionSnapshot C++ Function — Copies the current selection state, empty, ready or stale, into a snapshot.
• formattedProgramSelectionToken C++ Function — Converts a C selection token into the wrapper token.
• formattedProgramStoreCommands C++ Function — Converts wrapper commands into the C command structures of the store API.
• formattedProgramStoreInfo C++ Function — Returns the current counters and limits of the formatted program store.
• formattedProgramStoreInfoOutput C++ Function — Returns a C store-info structure prepared as an output buffer.
• formattedProgramStoreSnapshot C++ Function — Copies the equipment's formatted program store into an independent snapshot.
• formattedProgramTransferCommandCode C++ Function — Returns the CCODE of one command of a received S7F23.
• formattedProgramTransferCommandInfo C++ Function — Describes one command of a received S7F23.
• formattedProgramTransferId C++ Function — Returns the PPID of a received S7F23.
• formattedProgramTransferInfo C++ Function — Summarizes an S7F23 request or S7F24 reply carried by result.
• formattedProgramTransferModel C++ Function — Copies the MDLN of a received S7F23.
• formattedProgramTransferParameter C++ Function — Returns one PPARM of one command of a received S7F23.
• formattedProgramTransferSoftwareRevision C++ Function — Copies the SOFTREV of a received S7F23.
• formattedProgramTransferText C++ Function — Copies the MDLN or SOFTREV of a received S7F23.
• formattedProgramVerificationNegotiationInfo C++ Function — Describes the negotiation carried by result.
• formattedProgramVerificationRequestCommandCode C++ Function — Returns the CCODE of one command of a received S7F31.
• formattedProgramVerificationRequestCommandInfo C++ Function — Describes one command of a received S7F31.
• formattedProgramVerificationRequestId C++ Function — Returns the PPID of a received S7F31.
• formattedProgramVerificationRequestInfo C++ Function — Summarizes an S7F31 request or S7F32 reply carried by result.
• formattedProgramVerificationRequestModel C++ Function — Copies the MDLN of a received S7F31.
• formattedProgramVerificationRequestParameter C++ Function — Returns one PPARM of one command of a received S7F31.
• formattedProgramVerificationRequestSoftwareRevision C++ Function — Copies the SOFTREV of a received S7F31.
• formattedProgramVerificationRequestText C++ Function — Copies the MDLN or SOFTREV of a received S7F31.
• gem300CapabilityOptions C++ Function — Builds versioned limits for a Gem300CapabilityCatalog.
• gemAlarmOptions C++ Function — Builds versioned limits for the equipment alarm store (GemEquipment::configureAlarms()).
• gemBindingOptions C++ Function — Builds versioned limits for report bindings (GemEquipment::configureReportBindings()).
• gemCommandOptions C++ Function — Builds versioned limits for the remote command store (GemEquipment::configureCommands()).
• gemConstantOptions C++ Function — Builds versioned limits for the equipment constant store (GemEquipment::configureConstants()).
• gemDataOptions C++ Function — Builds versioned limits for the data variable store (GemEquipment::configureDataVariables()).
• gemDirectoryOptions C++ Function — Builds versioned limits for the event directory (GemEquipment::configureEventDirectory()).
• gemEnhancedCommandOptions C++ Function — Builds versioned limits for the enhanced remote command store (GemEquipment::configureEnhancedCommands()).
• gemFormattedProgramCapabilityOptions C++ Function — Builds versioned limits for S7F21/F22 process capability exchange.
• gemFormattedProgramDryRunOptions C++ Function — Builds versioned options for dryRunFormattedProgram().
• gemFormattedProgramOptions C++ Function — Builds versioned limits for S7F27/F28 process program verification.
• gemFormattedProgramQueryOptions C++ Function — Builds versioned limits for S7F25/F26 formatted process program requests.
• gemFormattedProgramTransferOptions C++ Function — Builds versioned limits for S7F23/F24 formatted process program transfer.
• gemFormattedProgramVerificationNegotiationOptions C++ Function — Builds versioned limits for S7F29/F30 verification negotiation.
• gemFormattedProgramVerificationRequestOptions C++ Function — Builds versioned limits for S7F31/F32 verification requests.
• gemHostOptions C++ Function — Builds versioned options for GemHost.
• gemProgramOptions C++ Function — Builds versioned limits for the process program store (GemEndpoint::configurePrograms()).
• gemReportOptions C++ Function — Builds versioned limits for the equipment report store (GemEquipment::configureReports(), GemEquipment::configureFixedCatalog()).
• gemSpoolHostOptions C++ Function — Builds versioned limits for host spool requests (GemHost::configureSpoolHost()).
• gemSpoolOptions C++ Function — Builds versioned limits for the equipment spool (GemEquipment::configureSpooling()).
• prepareFormattedProgramVerificationNegotiation C++ Function — Prepares an S7F27 report for negotiation on the equipment, without sending anything.
• putFormattedProgramStore C++ Function — Writes a program to the equipment's formatted program store.
• removeFormattedProgramQuery C++ Function — Removes a program from the equipment's formatted program store.
• removeFormattedProgramStore C++ Function — Removes a program from the equipment's formatted program store.
• replaceFormattedProgramCapabilityCatalog C++ Function — Replaces the equipment's capability catalog that answers S7F21.
• respondFormattedProgram C++ Function — Sends S7F28 Process Program Verification Acknowledge for a received S7F27.
• respondFormattedProgramCapability C++ Function — Answers a received S7F21 with S7F22 built from the current catalog.
• respondFormattedProgramQuery C++ Function — Answers a received S7F25 with S7F26 from the formatted program store.
• respondFormattedProgramTransfer C++ Function — Sends S7F24 Formatted Process Program Acknowledge without storing the program.
• respondFormattedProgramTransferAndStore C++ Function — Sends S7F24 for a received S7F23 and applies a store action to the received program.
• respondFormattedProgramVerificationNegotiation C++ Function — Sends S7F30 Process Program Verification Grant for a received S7F29.
• respondFormattedProgramVerificationRequest C++ Function — Sends S7F32 Verification Request Acknowledge for a received S7F31.
• retryFormattedProgramVerificationNegotiation C++ Function — Resends the S7F27 report of a granted negotiation whose automatic send failed.
• retryFormattedProgramVerificationNegotiationResponse C++ Function — Resends the S7F30 reply prepared by respondFormattedProgramVerificationNegotiation().
• secsLimits C++ Function — Builds a PdcommSecsLimits structure with struct_size already set.
• seedFormattedProgramQuery C++ Function — Adds or replaces a program in the equipment's formatted program store.
• selectFormattedProgram C++ Function — Selects a program from the equipment's formatted program store.
• selectionTokenOutput C++ Function — Converts a wrapper token into the versioned C token structure.
• startFormattedProgramExecution C++ Function — Starts an execution of the selected program and returns its start action.
• stepFormattedProgramExecution C++ Function — Requests the next command of a running execution as a step action.
• submitFormattedProgram C++ Function — Sends S7F27 Process Program Verification Send from the equipment.
• submitFormattedProgramCapability C++ Function — Sends S7F21 Process Capability Request (header only) from the host.
• submitFormattedProgramExecutionActionResult C++ Function — Reports what the application did with a requested action.
• submitFormattedProgramQuery C++ Function — Sends S7F25 Formatted Process Program Request from the host.
• submitFormattedProgramTransfer C++ Function — Sends S7F23 Formatted Process Program Send from the host.
• submitFormattedProgramVerificationNegotiation C++ Function — Sends S7F29 Process Program Verification Inquire for a prepared report.
• submitFormattedProgramVerificationRequest C++ Function — Sends S7F31 Verification Request Send from the host.
• validateFormattedProgramSelection C++ Function — Confirms that token still names a ready selection and returns its program.
• Gem300Axis.Carrier .NET Enumerator — Carriers (SEMI E87).
• Gem300Axis.ControlJob .NET Enumerator — Control jobs (SEMI E94).
• Gem300Axis.ProcessJob .NET Enumerator — Process jobs (SEMI E40).
• Gem300Axis.Substrate .NET Enumerator — Substrates (SEMI E90).
• Gem300Status.Experimental .NET Enumerator — Label value 3 (experimental): the application runs the capability on trial.
• Gem300Status.ModelOnly .NET Enumerator — Label value 2 (model only): the application has a data model of the capability.
• Gem300Status.Planned .NET Enumerator — Label value 1 (planned): the application plans the capability.
• Gem300Verification.Unverified .NET Enumerator — Verification label value 1, currently the only defined value.
• GemCommandDecision.AcceptedForLater .NET Enumerator — HCACK 4: the command is accepted and will be performed, with completion signaled later by an event.
• GemCommandDecision.AlreadyInCondition .NET Enumerator — HCACK 5: the command is rejected because the equipment is already in the requested condition.
• GemCommandDecision.CannotPerformNow .NET Enumerator — HCACK 2: the command cannot be performed now.
• GemCommandDecision.Completed .NET Enumerator — HCACK 0: the command has been performed.
• GemCommandDecision.NoSuchObject .NET Enumerator — HCACK 6: the addressed object does not exist.
• GemCommandDecision.ParameterErrors .NET Enumerator — HCACK 3: at least one parameter is invalid. This is the only decision that can carry parameter acknowledgements.
• GemCommandDecision.UnknownCommand .NET Enumerator — HCACK 1: the command does not exist.
• GemCommunicationState.Communicating .NET Enumerator — Communication is established, so other GEM transactions are allowed.
• GemCommunicationState.Disconnected .NET Enumerator — The HSMS session is not selected, so no GEM communication is possible.
• GemCommunicationState.NotCommunicating .NET Enumerator — The HSMS session is selected, but communication has not been established with S1F13/S1F14.
• GemCommunicationState.WaitingAck .NET Enumerator — This endpoint sent S1F13 and is waiting for the S1F14 acknowledgement (COMMACK).
• GemConstantDecision.Apply .NET Enumerator — Accept and apply the new values (EAC 0).
• GemConstantDecision.CannotPerform .NET Enumerator — Deny because the equipment cannot perform the change now (EAC 2).
• GemConstantDecision.OutOfRange .NET Enumerator — Deny because at least one value is out of range (EAC 3).
• GemConstantField.Current .NET Enumerator — The current value (ECV). Valid only for GemEquipment.GetConstant.
• GemConstantField.Default .NET Enumerator — The default value (ECDEF).
• GemConstantField.Id .NET Enumerator — The equipment constant ID (ECID).
• GemConstantField.Maximum .NET Enumerator — The upper bound (ECMAX).
• GemConstantField.Minimum .NET Enumerator — The lower bound (ECMIN).
• GemConstantField.Name .NET Enumerator — The constant name (ECNAME), as an ASCII item.
• GemConstantField.Units .NET Enumerator — The units (UNITS), as an ASCII item.
• GemControlState.AttemptOnline .NET Enumerator — The equipment sent S1F1 after GemEquipment.OperatorOnline and waits for the host reply. This state is not allowed as GemEquipmentOptions.InitialControl.
• GemControlState.EquipmentOffline .NET Enumerator — The equipment is off-line by operator choice and does not accept S1F17 (Request On-line).
• GemControlState.HostOffline .NET Enumerator — The equipment is off-line because the host requested it (S1F15) or the attempt to go on-line ended.
• GemControlState.OnlineLocal .NET Enumerator — The equipment is on-line in local mode.
• GemControlState.OnlineRemote .NET Enumerator — The equipment is on-line in remote mode.
• GemDataField.Cached .NET Enumerator — A copy of the cached value, or no item when no value is cached.
• GemDataField.Name .NET Enumerator — The name, as an ASCII item.
• GemDataField.Units .NET Enumerator — The units, as an ASCII item.
• GemDataSourceKind.Constant .NET Enumerator — The current value of an equipment constant; the constant ID (ECID) is given as an item and the source ID is 0.
• GemDataSourceKind.Data .NET Enumerator — A data variable; the source ID is the data variable ID. The value comes from an event sample, else from the cached value.
• GemDataSourceKind.Status .NET Enumerator — A status variable registered with GemEquipment.RegisterStatus; the source ID is the SVID.
• GemDirectoryField.Name .NET Enumerator — The name as an ASCII item: DVVALNAME of a data variable entry or CENAME of an event entry.
• GemDirectoryField.Units .NET Enumerator — The units (UNITS) of a data variable entry as an ASCII item. Not valid for event entries.
• GemDirectoryField.VariableIds .NET Enumerator — The variable IDs (VIDs) of an event entry as a U4 array item. Not valid for data variable entries.
• GemDirectoryKind.Data .NET Enumerator — The data variable namelist, requested with S1F21 and answered with S1F22. The value matches GemRequestKind.DataDirectory.
• GemDirectoryKind.Event .NET Enumerator — The collection event namelist, requested with S1F23 and answered with S1F24. The value matches GemRequestKind.EventDirectory.
• GemError.Aborted .NET Enumerator — The peer answered the request with an abort (function 0) reply.
• GemError.Ack .NET Enumerator — The acknowledgement code in the reply is outside the range allowed for the transaction.
• GemError.Body .NET Enumerator — The message body does not have the structure required by the transaction.
• GemError.Codec .NET Enumerator — The SECS-II body cannot be decoded or exceeds the configured item limits.
• GemError.Correlation .NET Enumerator — The reply does not correlate with the request, for example a different number of entries than IDs.
• GemError.Disconnected .NET Enumerator — The endpoint has no selected HSMS session.
• GemError.MissingBody .NET Enumerator — The message has no body although the transaction requires one.
• GemError.Response .NET Enumerator — The message is not a valid answer for the pending request, or GEM rejected it for another protocol reason.
• GemError.State .NET Enumerator — The message is not allowed in the current GEM communication or control state.
• GemError.UnexpectedBody .NET Enumerator — The message has a body although the transaction requires a header-only message.
• GemError.Unsupported .NET Enumerator — The stream and function are not supported by this endpoint role or configuration, or a reply has a different stream or function than the request expects.
• GemError.Wait .NET Enumerator — The reply-expected (W) bit of the message does not match the transaction.
• GemFormattedProgramActionResult.Accepted .NET Enumerator — The start was accepted and the execution is running. Valid only for a start action.
• GemFormattedProgramActionResult.Applied .NET Enumerator — The step's command was applied and the next command becomes current. Valid only for a step action.
• GemFormattedProgramActionResult.Cancelled .NET Enumerator — The cancel took effect and the execution ends. Valid only for a cancel action.
• GemFormattedProgramActionResult.Failed .NET Enumerator — The action failed and the execution ends.
• GemFormattedProgramActionResult.OutcomeUnknown .NET Enumerator — The application does not know whether the action took effect; the execution ends.
• GemFormattedProgramActionResult.Rejected .NET Enumerator — The action was rejected. A rejected start or step ends the execution; a rejected cancel returns it to GemFormattedProgramExecutionState.Running.
• GemFormattedProgramDependency.Before .NET Enumerator — The before-dependency list (BCDS).
• GemFormattedProgramDependency.ImmediateAfter .NET Enumerator — The immediately-after dependency list (IACDS).
• GemFormattedProgramDependency.ImmediateBefore .NET Enumerator — The immediately-before dependency list (IBCDS).
• GemFormattedProgramDependency.NonAfter .NET Enumerator — The not-after dependency list (NACDS).
• GemFormattedProgramDependency.NonBefore .NET Enumerator — The not-before dependency list (NBCDS).
• GemFormattedProgramDryRunOutcome.Indeterminate .NET Enumerator — The analysis could not confirm every aspect, for example because no capability catalog is installed, but no issue rejects the program.
• GemFormattedProgramDryRunOutcome.Pass .NET Enumerator — The analysis found no issue.
• GemFormattedProgramDryRunOutcome.Reject .NET Enumerator — At least one issue rejects the program; GemFormattedPrograms.StartExecution refuses such a report.
• GemFormattedProgramExecutionState.ApplicationRejected .NET Enumerator — The application rejected the start or a step.
• GemFormattedProgramExecutionState.CancelPending .NET Enumerator — A cancel action waits for the application's result.
• GemFormattedProgramExecutionState.Cancelled .NET Enumerator — The application confirmed a cancel action.
• GemFormattedProgramExecutionState.Completed .NET Enumerator — The application reported that the program completed.
• GemFormattedProgramExecutionState.Empty .NET Enumerator — No execution has been started.
• GemFormattedProgramExecutionState.Failed .NET Enumerator — The application reported a failed action or a failed program.
• GemFormattedProgramExecutionState.OutcomeUnknown .NET Enumerator — The application reported that it does not know the outcome of an action or of the program.
• GemFormattedProgramExecutionState.Running .NET Enumerator — The application accepted the start; steps and a cancel can be requested.
• GemFormattedProgramExecutionState.StartPending .NET Enumerator — A start action waits for the application's result.
• GemFormattedProgramExecutionState.StepPending .NET Enumerator — A step action waits for the application's result.
• GemFormattedProgramStoreAction.CreateOnly .NET Enumerator — Adds the program; fails with PdcommStatus.InvalidState when a program with the same PPID exists.
• GemFormattedProgramStoreAction.ReplaceOnly .NET Enumerator — Replaces the stored program with the same PPID; fails with PdcommStatus.InvalidState when there is none.
• GemFormattedProgramStoreAction.RespondOnly .NET Enumerator — Replies without changing the store. Only GemFormattedPrograms.RespondTransferAndStore accepts it.
• GemFormattedProgramStoreAction.Upsert .NET Enumerator — Adds the program, or replaces the stored program with the same PPID.
• GemFormattedProgramTerminalOutcome.Complete .NET Enumerator — The program completed; accepted only after every command was applied.
• GemFormattedProgramTerminalOutcome.Fail .NET Enumerator — The program failed.
• GemFormattedProgramTerminalOutcome.OutcomeUnknown .NET Enumerator — The application does not know the outcome of the program.
• GemOnlineMode.Local .NET Enumerator — Going on-line enters GemControlState.OnlineLocal.
• GemOnlineMode.Remote .NET Enumerator — Going on-line enters GemControlState.OnlineRemote.
• GemOutcome.AlarmAck .NET Enumerator — The equipment received S5F2 for its alarm report; the acknowledgement holds ACKC5.
• GemOutcome.AlarmEnableAck .NET Enumerator — An S5F3/S5F4 Enable/Disable Alarm transaction completed; the acknowledgement holds ACKC5.
• GemOutcome.AlarmListReceived .NET Enumerator — The host received the S5F6 alarm list.
• GemOutcome.AlarmListReplied .NET Enumerator — The equipment answered S5F5 with S5F6 automatically.
• GemOutcome.AlarmReceived .NET Enumerator — The host received an S5F1 alarm report; acknowledge it explicitly when a reply is expected.
• GemOutcome.AlreadyOnline .NET Enumerator — The equipment answered S1F17 with ONLACK 2 because it is already on-line.
• GemOutcome.AnnotatedQueryReceived .NET Enumerator — The host received the S6F22 annotated individual report data.
• GemOutcome.CommandAck .NET Enumerator — The host received S2F42; the acknowledgement holds HCACK.
• GemOutcome.CommandReceived .NET Enumerator — The equipment received an S2F41 host command that waits for an explicit response.
• GemOutcome.CommunicationEstablished .NET Enumerator — Communication is established: an S1F14 with COMMACK 0 was received, or a received S1F13 was accepted.
• GemOutcome.CommunicationRejected .NET Enumerator — The peer rejected S1F13; GemResultInfo.Acknowledgement holds the nonzero COMMACK.
• GemOutcome.ConstantChangeAck .NET Enumerator — The host received S2F16; the acknowledgement holds EAC.
• GemOutcome.ConstantChangesReceived .NET Enumerator — The equipment received S2F15 constant changes that wait for an explicit decision.
• GemOutcome.ConstantMetadataReceived .NET Enumerator — The host received the S2F30 equipment constant name list.
• GemOutcome.ConstantMetadataReplied .NET Enumerator — The equipment answered S2F29 with S2F30 automatically.
• GemOutcome.ConstantValuesReceived .NET Enumerator — The host received the S2F14 equipment constant values.
• GemOutcome.ConstantValuesReplied .NET Enumerator — The equipment answered S2F13 with S2F14 automatically.
• GemOutcome.DataDirectoryReceived .NET Enumerator — The host received the S1F22 data variable name list.
• GemOutcome.DataDirectoryReplied .NET Enumerator — The equipment answered S1F21 with S1F22 automatically.
• GemOutcome.DefineReportsAck .NET Enumerator — An S2F33/S2F34 Define Report transaction completed; the acknowledgement holds DRACK.
• GemOutcome.EnableEventsAck .NET Enumerator — An S2F37/S2F38 Enable/Disable Event Report transaction completed; the acknowledgement holds ERACK.
• GemOutcome.EnabledAlarmListReceived .NET Enumerator — The host received the S5F8 enabled alarm list.
• GemOutcome.EnabledAlarmListReplied .NET Enumerator — The equipment answered S5F7 with S5F8 automatically.
• GemOutcome.EnhancedCommandAck .NET Enumerator — The host received S2F50; the acknowledgement holds HCACK.
• GemOutcome.EnhancedCommandReceived .NET Enumerator — The equipment received an S2F49 enhanced remote command that waits for an explicit response.
• GemOutcome.EquipmentIdentity .NET Enumerator — The host received the S1F2 reply with the equipment model (MDLN) and software revision (SOFTREV).
• GemOutcome.EventAck .NET Enumerator — The equipment received S6F12 for its event report; the acknowledgement holds ACKC6.
• GemOutcome.EventDirectoryReceived .NET Enumerator — The host received the S1F24 collection event name list.
• GemOutcome.EventDirectoryReplied .NET Enumerator — The equipment answered S1F23 with S1F24 automatically.
• GemOutcome.EventQueryReceived .NET Enumerator — The host received the S6F16 event report data.
• GemOutcome.EventReceived .NET Enumerator — The host received an S6F11 event report; acknowledge it explicitly.
• GemOutcome.FormattedCapabilityReceived .NET Enumerator — The equipment received an S7F21 process capabilities request.
• GemOutcome.FormattedCapabilityResult .NET Enumerator — The host received the S7F22 process capabilities data.
• GemOutcome.FormattedQueryReceived .NET Enumerator — The equipment received an S7F25 formatted process program request.
• GemOutcome.FormattedQueryResult .NET Enumerator — The host received the S7F26 formatted process program data.
• GemOutcome.FormattedTransferAck .NET Enumerator — The host received the S7F24 formatted process program acknowledgement.
• GemOutcome.FormattedTransferReceived .NET Enumerator — The equipment received an S7F23 formatted process program.
• GemOutcome.FormattedVerificationGrantReceived .NET Enumerator — The equipment received the S7F30 verification grant (PPGNT).
• GemOutcome.FormattedVerificationInquireReceived .NET Enumerator — The host received an S7F29 process program verification inquire.
• GemOutcome.FormattedVerificationNegotiationAck .NET Enumerator — The equipment received the S7F28 acknowledgement that completes a verification negotiation.
• GemOutcome.FormattedVerificationReportAck .NET Enumerator — The equipment received the S7F28 verification acknowledgement.
• GemOutcome.FormattedVerificationReportReceived .NET Enumerator — The host received an S7F27 process program verification send.
• GemOutcome.FormattedVerificationRequestAck .NET Enumerator — The host received the S7F32 verification request acknowledgement.
• GemOutcome.FormattedVerificationRequestReceived .NET Enumerator — The equipment received an S7F31 verification request.
• GemOutcome.IndividualQueryReceived .NET Enumerator — The host received the S6F20 individual report data.
• GemOutcome.LinkReportsAck .NET Enumerator — An S2F35/S2F36 Link Event Report transaction completed; the acknowledgement holds LRACK.
• GemOutcome.NamesReceived .NET Enumerator — The host received a validated S1F12 status name list; read it with GemResult.GetStatusName.
• GemOutcome.None .NET Enumerator — No outcome; the result is ignored, failed, invalid or unhandled.
• GemOutcome.OfflineAccepted .NET Enumerator — The equipment accepted S1F15 and replied with OFLACK 0.
• GemOutcome.OfflineAck .NET Enumerator — The host received S1F16; GemResultInfo.Acknowledgement holds OFLACK.
• GemOutcome.OnlineAccepted .NET Enumerator — The equipment went on-line: it accepted S1F17 (ONLACK 0) or received the S1F2 reply to its operator on-line request.
• GemOutcome.OnlineAck .NET Enumerator — The host received S1F18; GemResultInfo.Acknowledgement holds ONLACK.
• GemOutcome.OnlineRejected .NET Enumerator — The equipment answered S1F17 with ONLACK 1 because it does not allow going on-line.
• GemOutcome.ProgramAckReceived .NET Enumerator — The S7F4 or S7F18 process program acknowledgement was received; the acknowledgement holds ACKC7.
• GemOutcome.ProgramDataReceived .NET Enumerator — The S7F6 process program data was received.
• GemOutcome.ProgramDirectoryReceived .NET Enumerator — The S7F20 process program directory was received.
• GemOutcome.ProgramGrantReceived .NET Enumerator — The S7F2 process program grant was received; the acknowledgement holds PPGNT.
• GemOutcome.ProgramReceived .NET Enumerator — A stream 7 process program primary was received; GemResultInfo.RequestKind names the transaction.
• GemOutcome.Replied .NET Enumerator — GEM answered a received primary automatically with a reply that has no more specific outcome.
• GemOutcome.ReportQueryReceived .NET Enumerator — The equipment received an S6F15, S6F19 or S6F21 report query that waits for GemEquipment.RespondReportQuery.
• GemOutcome.SpoolConfigurationAck .NET Enumerator — The host received the S2F44 spooling configuration acknowledgement.
• GemOutcome.SpoolConfigurationData .NET Enumerator — The host received the S2F60 spooling configuration data.
• GemOutcome.SpoolControlAck .NET Enumerator — The host received the S6F24 spooled data request acknowledgement.
• GemOutcome.SpoolDeliveryFailed .NET Enumerator — The delivery of a spooled message failed.
• GemOutcome.SpoolDeliveryResponse .NET Enumerator — The equipment received the reply to a delivered spooled message.
• GemOutcome.SpoolDeliveryWritten .NET Enumerator — A delivered spooled message that expects no reply was written to the transport.
• GemOutcome.SpoolReceived .NET Enumerator — The equipment received an S2F43, S2F59 or S6F23 spooling primary.
• GemOutcome.StatusReplied .NET Enumerator — The equipment answered S1F3 or S1F11 automatically from its status variable registry.
• GemOutcome.ValuesReceived .NET Enumerator — The host received validated S1F4 status values; read them with GemResult.GetStatusValue.
• GemProgramDurability.Confirmed .NET Enumerator — The application accepted an unconfirmed installation with GemEquipment.ConfirmProgramReply. This does not mean that the change was synchronized, and is distinct from GemProgramDurability.Synced.
• GemProgramDurability.None .NET Enumerator — No local change is associated, for example for a rejected request, a request that does not write, or a reply received from the peer.
• GemProgramDurability.Synced .NET Enumerator — The change was written to the storage file and the file's parent directory was synchronized.
• GemProgramDurability.Unconfirmed .NET Enumerator — The change was installed, but its persistence could not be confirmed; the persistence status holds the failure. Do not repeat the change as if it had been rolled back.
• GemProgramDurability.Volatile .NET Enumerator — The change was installed in memory only, because the store has no storage file.
• GemProgramField.Body .NET Enumerator — The process program body (PPBODY).
• GemProgramField.Id .NET Enumerator — A process program ID (PPID).
• GemProgramGrantPolicy.Optional .NET Enumerator — Accept S7F3 without a grant while no other grant is outstanding; with an outstanding grant for another PPID the reply is ACKC7 5.
• GemProgramGrantPolicy.Required .NET Enumerator — Accept S7F3 only for a PPID granted by an accepted S7F1 on the same connection; otherwise the reply is ACKC7 1 (permission not granted).
• GemProgramPutMode.Create .NET Enumerator — Store only a new PPID; an existing PPID is rejected.
• GemProgramPutMode.Replace .NET Enumerator — Replace only an existing PPID; an unknown PPID is rejected.
• GemProgramPutMode.Upsert .NET Enumerator — Create the PPID or replace it when it exists.
• GemReportQueryKind.Annotated .NET Enumerator — Annotated individual report request by report ID (RPTID), S6F21/S6F22.
• GemReportQueryKind.Event .NET Enumerator — Event report request by collection event ID (CEID), S6F15/S6F16.
• GemReportQueryKind.Individual .NET Enumerator — Individual report request by report ID (RPTID), S6F19/S6F20.
• GemRequestKind.AlarmList .NET Enumerator — List alarms request, S5F5/S5F6.
• GemRequestKind.AlarmReport .NET Enumerator — Alarm Report Send, S5F1/S5F2.
• GemRequestKind.AnnotatedQuery .NET Enumerator — Annotated individual report request by RPTID, S6F21/S6F22.
• GemRequestKind.AreYouOnline .NET Enumerator — Are You There, S1F1/S1F2, sent by the host with GemHost.AreYouOnline. The equipment's operator-initiated S1F1 is reported as GemRequestKind.OperatorOnline.
• GemRequestKind.ChangeConstants .NET Enumerator — New equipment constant send, S2F15/S2F16.
• GemRequestKind.ConstantMetadata .NET Enumerator — Equipment constant name list request, S2F29/S2F30.
• GemRequestKind.ConstantValues .NET Enumerator — Equipment constant values request, S2F13/S2F14.
• GemRequestKind.DataDirectory .NET Enumerator — Data variable name list request, S1F21/S1F22.
• GemRequestKind.DefineReports .NET Enumerator — Define Report, S2F33/S2F34.
• GemRequestKind.EnableAlarm .NET Enumerator — Enable/Disable Alarm Send, S5F3/S5F4.
• GemRequestKind.EnableEvents .NET Enumerator — Enable/Disable Event Report, S2F37/S2F38.
• GemRequestKind.EnabledAlarmList .NET Enumerator — List enabled alarms request, S5F7/S5F8.
• GemRequestKind.EnhancedRemoteCommand .NET Enumerator — Enhanced remote command, S2F49/S2F50.
• GemRequestKind.Establish .NET Enumerator — Establish Communications, S1F13/S1F14.
• GemRequestKind.EventDirectory .NET Enumerator — Collection event name list request, S1F23/S1F24.
• GemRequestKind.EventQuery .NET Enumerator — Event report request by CEID, S6F15/S6F16.
• GemRequestKind.EventReport .NET Enumerator — Event Report Send, S6F11/S6F12.
• GemRequestKind.FormattedCapability .NET Enumerator — Equipment process capabilities request, S7F21/S7F22.
• GemRequestKind.FormattedQuery .NET Enumerator — Formatted process program request, S7F25/S7F26.
• GemRequestKind.FormattedTransfer .NET Enumerator — Formatted process program send, S7F23/S7F24.
• GemRequestKind.FormattedVerificationNegotiation .NET Enumerator — Process program verification inquire and grant, S7F29/S7F30, followed by the S7F27/S7F28 verification send.
• GemRequestKind.FormattedVerificationReport .NET Enumerator — Process program verification send, S7F27/S7F28.
• GemRequestKind.FormattedVerificationRequest .NET Enumerator — Verification request send, S7F31/S7F32.
• GemRequestKind.IndividualQuery .NET Enumerator — Individual report request by RPTID, S6F19/S6F20.
• GemRequestKind.LinkReports .NET Enumerator — Link Event Report, S2F35/S2F36.
• GemRequestKind.Offline .NET Enumerator — Request Off-line, S1F15/S1F16.
• GemRequestKind.Online .NET Enumerator — Request On-line, S1F17/S1F18.
• GemRequestKind.OperatorOnline .NET Enumerator — The equipment's operator-initiated ON-LINE attempt, S1F1/S1F2, sent with GemEquipment.OperatorOnline. Results of that transaction report this kind.
• GemRequestKind.ProgramDelete .NET Enumerator — Delete process program send, S7F17/S7F18.
• GemRequestKind.ProgramDirectory .NET Enumerator — Current process program directory request, S7F19/S7F20.
• GemRequestKind.ProgramGrant .NET Enumerator — Process program load inquire and grant, S7F1/S7F2.
• GemRequestKind.ProgramRequest .NET Enumerator — Process program request, S7F5/S7F6.
• GemRequestKind.ProgramSend .NET Enumerator — Process program send, S7F3/S7F4.
• GemRequestKind.RemoteCommand .NET Enumerator — Host command (RCMD) send, S2F41/S2F42.
• GemRequestKind.SpoolConfigure .NET Enumerator — Reset spooled streams and functions, S2F43/S2F44.
• GemRequestKind.SpoolControl .NET Enumerator — Request spooled data (transmit or purge), S6F23/S6F24.
• GemRequestKind.SpoolDelivery .NET Enumerator — Delivery of one spooled primary message by the equipment. The message keeps the stream and function it was spooled with.
• GemRequestKind.SpoolQuery .NET Enumerator — Spooling configuration query, S2F59/S2F60.
• GemRequestKind.StatusNames .NET Enumerator — Status variable name list request, S1F11/S1F12.
• GemRequestKind.StatusValues .NET Enumerator — Selected status variable values request, S1F3/S1F4.
• GemResultKind.Failed .NET Enumerator — A GEM request ended without a usable reply. GemResultInfo.Code holds an HsmsFailureReason value, or GemError.Aborted when the peer answered with an abort (function 0) reply.
• GemResultKind.Ignored .NET Enumerator — The event is not GEM traffic for this endpoint, for example a state change or a reply to a raw request.
• GemResultKind.InvalidResponse .NET Enumerator — A reply arrived for a GEM request but failed validation. GemResultInfo.Code holds a GemError value; only the matched pending request is cleared.
• GemResultKind.Primary .NET Enumerator — A received primary message was accepted by GEM. Some primaries are answered automatically (GemResultInfo.ReplySent); others wait for an explicit response from the application.
• GemResultKind.Response .NET Enumerator — A validated reply to a GEM request this endpoint sent.
• GemResultKind.Unhandled .NET Enumerator — A received primary message was not handled and no reply was sent. GemResultInfo.Code holds a GemError value. When the primary expects a reply, answer it with GemEndpoint.ReplyRaw (for example an F0 abort) or close the endpoint; no automatic S9 or F0 reply is sent.
• GemRole.Equipment .NET Enumerator — The endpoint is GEM equipment (GemEquipment).
• GemRole.Host .NET Enumerator — The endpoint is a GEM host (GemHost).
• GemSpoolCommand.Purge .NET Enumerator — RSDC 1: purge the spooled messages.
• GemSpoolCommand.Transmit .NET Enumerator — RSDC 0: transmit the spooled messages to the host.
• GemSpoolDeliveryProof.None .NET Enumerator — The result carries no delivery evidence.
• GemSpoolDeliveryProof.Response .NET Enumerator — The host's reply to an entry sent with the W-bit was received.
• GemSpoolDeliveryProof.Written .NET Enumerator — The whole frame of an entry sent without the W-bit was written to the transport; this proves local write completion only, not receipt by the host.
• GemSpoolDurability.Confirmed .NET Enumerator — The application accepted an unconfirmed change with GemEquipment.ConfirmSpoolReply; reported only by GemSpoolInfo.Durability.
• GemSpoolDurability.None .NET Enumerator — No change was installed.
• GemSpoolDurability.Synced .NET Enumerator — The change was written to the snapshot file, renamed into place and the parent directory was synchronized.
• GemSpoolDurability.Unconfirmed .NET Enumerator — The change was installed and its snapshot file renamed into place, but synchronizing the parent directory failed, so the change may not survive a power loss.
• GemSpoolDurability.Volatile .NET Enumerator — The change was installed in an in-memory spool and is lost when the endpoint is disposed.
• GemSpoolMutation.Activated .NET Enumerator — Spooling became active because it is enabled and communication is down.
• GemSpoolMutation.Captured .NET Enumerator — A message was stored; GemSpoolWriteResult.AffectedCount is the number of older entries that GemSpoolOverflow.OverwriteOldest removed to make room.
• GemSpoolMutation.Configured .NET Enumerator — The policy or the stream selection was replaced, or a new spool was created with its initial disabled configuration.
• GemSpoolMutation.Discarded .NET Enumerator — A selected message was discarded because it did not fit, and only the counters changed.
• GemSpoolMutation.None .NET Enumerator — Nothing was changed.
• GemSpoolMutation.Purged .NET Enumerator — Every entry was removed; GemSpoolWriteResult.AffectedCount is the number of removed entries.
• GemSpoolMutation.Removed .NET Enumerator — The delivered head entry was removed from the spool.
• GemSpoolOverflow.DiscardNew .NET Enumerator — Keeps the stored entries and discards the new message.
• GemSpoolOverflow.OverwriteOldest .NET Enumerator — Removes the oldest entries until the new message fits, but never the entry whose delivery is in progress.
• HsmsConnectionState.Connecting .NET Enumerator — An active endpoint is opening a TCP connection.
• HsmsConnectionState.Listening .NET Enumerator — A passive endpoint is waiting for a TCP connection.
• HsmsConnectionState.NotSelected .NET Enumerator — A TCP connection exists but the HSMS session is not selected yet.
• HsmsConnectionState.RetryWait .NET Enumerator — An active endpoint is waiting for the T5 connect separation time before it reconnects.
• HsmsConnectionState.Selected .NET Enumerator — The HSMS session is selected; data messages can be exchanged.
• HsmsConnectionState.Stopped .NET Enumerator — The endpoint is not started, or it has stopped.
• HsmsEventKind.Failed .NET Enumerator — A request or control transaction of this endpoint failed; HsmsEventInfo.Code holds the HsmsFailureReason.
• HsmsEventKind.ProtocolError .NET Enumerator — The peer violated the HSMS protocol; HsmsEventInfo.Code holds the HsmsProtocolError.
• HsmsEventKind.Received .NET Enumerator — A data message arrived: a primary message or the reply to one of this endpoint's requests.
• HsmsEventKind.StateChanged .NET Enumerator — The connection state changed; see HsmsEventInfo.FromState and HsmsEventInfo.ToState.
• HsmsEventKind.TransportError .NET Enumerator — A socket operation failed; HsmsEventInfo.Code holds the HsmsIoOperation and HsmsEventInfo.Detail the HsmsIoErrorKind.
• HsmsEventKind.W0Written .NET Enumerator — A message sent without the reply-expected (W) bit was completely written to the socket.
• HsmsFailureReason.Cancelled .NET Enumerator — The transaction was cancelled locally.
• HsmsFailureReason.DeselectStatus .NET Enumerator — The peer refused Deselect.req; HsmsEventInfo.Value1 holds the DeselectStatus.
• HsmsFailureReason.Deselected .NET Enumerator — The session was deselected before the transaction completed.
• HsmsFailureReason.Disconnected .NET Enumerator — The connection closed before the transaction completed.
• HsmsFailureReason.Rejected .NET Enumerator — The peer answered with Reject.req; HsmsEventInfo.Value1 holds the rejected message type and HsmsEventInfo.Value2 the reason code.
• HsmsFailureReason.SelectStatus .NET Enumerator — The peer refused Select.req; HsmsEventInfo.Value1 holds the SelectStatus.
• HsmsFailureReason.T3Timeout .NET Enumerator — No reply arrived within the T3 reply timeout.
• HsmsFailureReason.T6Timeout .NET Enumerator — No control response arrived within the T6 control transaction timeout.
• HsmsFrameError.BufferTooSmall .NET Enumerator — An output buffer was too small for the frame.
• HsmsFrameError.ControlBody .NET Enumerator — A control message carried a body.
• HsmsFrameError.ControlSession .NET Enumerator — A control message other than Reject.req did not carry session ID 0xFFFF.
• HsmsFrameError.HeaderField .NET Enumerator — A header byte has a value that the message type does not allow.
• HsmsFrameError.InvalidLength .NET Enumerator — The length field declares fewer bytes than the 10-byte HSMS header.
• HsmsFrameError.LengthOverflow .NET Enumerator — The declared length overflows the platform's size range.
• HsmsFrameError.LimitExceeded .NET Enumerator — The frame exceeds the configured frame limit.
• HsmsFrameError.NeedMore .NET Enumerator — More bytes are needed to complete the frame.
• HsmsFrameError.NotData .NET Enumerator — A data message was expected but a control message arrived.
• HsmsFrameError.ReaderFailed .NET Enumerator — The frame reader already failed on this connection and accepts no more input.
• HsmsFrameError.SecsBody .NET Enumerator — The body of a data message is not one valid SECS-II item.
• HsmsFrameError.TrailingData .NET Enumerator — Bytes follow the frame where none were expected.
• HsmsFrameError.UnsupportedPType .NET Enumerator — The header's PType is not 0 (SECS-II).
• HsmsFrameError.UnsupportedSType .NET Enumerator — The header's SType is not a supported HSMS message type.
• HsmsIoErrorKind.Aborted .NET Enumerator — The connection was aborted.
• HsmsIoErrorKind.AddressInUse .NET Enumerator — The local address is already in use.
• HsmsIoErrorKind.AddressUnavailable .NET Enumerator — The requested address is not available.
• HsmsIoErrorKind.BrokenPipe .NET Enumerator — The connection was closed while writing.
• HsmsIoErrorKind.Interrupted .NET Enumerator — The operation was interrupted.
• HsmsIoErrorKind.InvalidData .NET Enumerator — Invalid data was encountered.
• HsmsIoErrorKind.InvalidInput .NET Enumerator — An input parameter was invalid.
• HsmsIoErrorKind.NotConnected .NET Enumerator — The socket is not connected.
• HsmsIoErrorKind.NotFound .NET Enumerator — An entity was not found.
• HsmsIoErrorKind.Other .NET Enumerator — Any error not listed below.
• HsmsIoErrorKind.Permission .NET Enumerator — The operation lacked permission.
• HsmsIoErrorKind.Refused .NET Enumerator — The peer refused the connection.
• HsmsIoErrorKind.Reset .NET Enumerator — The peer reset the connection.
• HsmsIoErrorKind.TimedOut .NET Enumerator — The operation timed out.
• HsmsIoErrorKind.UnexpectedEof .NET Enumerator — The connection ended in the middle of a frame.
• HsmsIoErrorKind.WouldBlock .NET Enumerator — The operation would block.
• HsmsIoErrorKind.WriteZero .NET Enumerator — A write returned zero bytes.
• HsmsIoOperation.Accept .NET Enumerator — Accepting an incoming connection.
• HsmsIoOperation.Bind .NET Enumerator — Binding the listening socket.
• HsmsIoOperation.Configure .NET Enumerator — Configuring socket options.
• HsmsIoOperation.Connect .NET Enumerator — Connecting to the peer.
• HsmsIoOperation.LocalAddress .NET Enumerator — Reading the local socket address.
• HsmsIoOperation.Read .NET Enumerator — Reading from the connection.
• HsmsIoOperation.Write .NET Enumerator — Writing to the connection.
• HsmsMode.Active .NET Enumerator — The endpoint opens the TCP connection and sends Select.req.
• HsmsMode.Passive .NET Enumerator — The endpoint binds a listening socket when it is created and accepts one connection at a time.
• HsmsProtocolError.DuplicatePrimary .NET Enumerator — A primary that expects a reply reused the system bytes of a received primary that is still open.
• HsmsProtocolError.FrameLimit .NET Enumerator — Reserved for a frame above HsmsOptions.MaxFrameBytes. The current native library does not report it: such a frame closes the connection with a transport error (HsmsIoOperation.Read, HsmsIoErrorKind.InvalidData).
• HsmsProtocolError.IncomingLimit .NET Enumerator — Too many received primaries are waiting for replies; the endpoint answered the new one with an abort (function 0).
• HsmsProtocolError.InvalidFrame .NET Enumerator — A frame was malformed; HsmsEventInfo.Detail holds the HsmsFrameError.
• HsmsProtocolError.InvalidReject .NET Enumerator — A Reject.req message was malformed.
• HsmsProtocolError.InvalidReply .NET Enumerator — A reply message was malformed or did not fit its request.
• HsmsProtocolError.UnexpectedControl .NET Enumerator — A control response matched no open control transaction.
• HsmsProtocolError.UnexpectedReply .NET Enumerator — A reply matched no open request of this endpoint.
• HsmsProtocolError.WrongSession .NET Enumerator — A data message carried another session ID; HsmsEventInfo.Value1 holds the expected and HsmsEventInfo.Value2 the received ID.
• Secs1Direction.ToEquipment .NET Enumerator — The message travels from the host to the equipment (R-bit 0).
• Secs1Direction.ToHost .NET Enumerator — The message travels from the equipment to the host (R-bit 1).
• Secs1EventKind.Fault .NET Enumerator — The line faulted; see Secs1Event.FaultKind. The endpoint stops until Secs1Worker.ResetAsync clears the fault.
• Secs1EventKind.Inbound .NET Enumerator — A complete message was received; see Secs1Event.Message.
• Secs1EventKind.OutboundComplete .NET Enumerator — The peer acknowledged every block of a submitted message; see Secs1Event.Token.
• Secs1EventKind.OutboundFailed .NET Enumerator — A submitted message failed after its retries were exhausted; see Secs1Event.Token.
• Secs1IoStatus.Aborted .NET Enumerator — The connection was aborted.
• Secs1IoStatus.AddressInUse .NET Enumerator — The address is already in use.
• Secs1IoStatus.AddressUnavailable .NET Enumerator — The address is not available.
• Secs1IoStatus.BrokenPipe .NET Enumerator — The peer closed the stream while writing.
• Secs1IoStatus.Closed .NET Enumerator — The serial port or stream is closed.
• Secs1IoStatus.Interrupted .NET Enumerator — The operation was interrupted; try again on a later poll.
• Secs1IoStatus.InvalidData .NET Enumerator — Invalid data was encountered.
• Secs1IoStatus.InvalidInput .NET Enumerator — An input parameter was invalid.
• Secs1IoStatus.NotConnected .NET Enumerator — The stream is not connected.
• Secs1IoStatus.NotFound .NET Enumerator — The device was not found.
• Secs1IoStatus.Ok .NET Enumerator — The operation transferred Secs1IoResult.Count bytes.
• Secs1IoStatus.Other .NET Enumerator — Any other failure; also reported when a callback throws.
• Secs1IoStatus.Permission .NET Enumerator — Access was denied.
• Secs1IoStatus.Refused .NET Enumerator — The connection was refused.
• Secs1IoStatus.Reset .NET Enumerator — The connection was reset.
• Secs1IoStatus.TimedOut .NET Enumerator — The operation timed out.
• Secs1IoStatus.WouldBlock .NET Enumerator — No bytes are available now; try again on a later poll.
• Secs1IoStatus.WriteZero .NET Enumerator — A write accepted zero bytes.
• Secs1Priority.Master .NET Enumerator — On contention (both sides send ENQ), keep waiting for the peer's EOT.
• Secs1Priority.Slave .NET Enumerator — On contention, yield: answer the peer's ENQ with EOT and receive first.
• SecsFormat.Ascii .NET Enumerator — ASCII text (A, octal 20): 7-bit characters, one byte each.
• SecsFormat.Binary .NET Enumerator — Binary (B, octal 10): uninterpreted bytes.
• SecsFormat.Boolean .NET Enumerator — Boolean (BOOLEAN, octal 11): one byte per value, nonzero means true.
• SecsFormat.F4 .NET Enumerator — 4-byte IEEE 754 floating-point values (F4, octal 44).
• SecsFormat.F8 .NET Enumerator — 8-byte IEEE 754 floating-point values (F8, octal 40).
• SecsFormat.I1 .NET Enumerator — 1-byte signed integers (I1, octal 31).
• SecsFormat.I2 .NET Enumerator — 2-byte signed integers (I2, octal 32).
• SecsFormat.I4 .NET Enumerator — 4-byte signed integers (I4, octal 34).
• SecsFormat.I8 .NET Enumerator — 8-byte signed integers (I8, octal 30).
• SecsFormat.Jis8 .NET Enumerator — JIS-8 text (J, octal 21): bytes kept as received.
• SecsFormat.List .NET Enumerator — List (L, octal 00): an ordered sequence of child items.
• SecsFormat.U1 .NET Enumerator — 1-byte unsigned integers (U1, octal 51).
• SecsFormat.U2 .NET Enumerator — 2-byte unsigned integers (U2, octal 52).
• SecsFormat.U4 .NET Enumerator — 4-byte unsigned integers (U4, octal 54).
• SecsFormat.U8 .NET Enumerator — 8-byte unsigned integers (U8, octal 50).
• Gem300Capability.Gem300Capability .NET Constructor — One capability of a GEM300 capability profile.
• Gem300CapabilityCatalog.Gem300CapabilityCatalog .NET Constructor — Creates an empty catalog with the given limits.
• Gem300CapabilityCatalog.Clear .NET Method — Removes every profile from the catalog.
• Gem300CapabilityCatalog.GetInfo .NET Method — Gets the revision and size of the catalog.
• Gem300CapabilityCatalog.Replace .NET Method — Replaces the whole catalog with the given profiles.
• Gem300CapabilityCatalog.Snapshot .NET Method — Takes an immutable copy of the catalog.
• Gem300CapabilityCatalogInfo.Gem300CapabilityCatalogInfo .NET Constructor — Describes the contents of a GEM300 capability catalog or of a snapshot of it.
• Gem300CapabilityInfo.Gem300CapabilityInfo .NET Constructor — Describes one capability of a GEM300 capability profile.
• Gem300CapabilityOptions.Gem300CapabilityOptions .NET Constructor — Limits that bound the contents of a Gem300CapabilityCatalog.
• Gem300CapabilityProfile.Gem300CapabilityProfile .NET Constructor — A named set of GEM300 capabilities, at most one per axis.
• Gem300CapabilityProfileInfo.Gem300CapabilityProfileInfo .NET Constructor — Describes one profile of a GEM300 capability snapshot.
• Gem300CapabilitySnapshot.GetInfo .NET Method — Gets the revision and size of the catalog when the snapshot was taken.
• Gem300CapabilitySnapshot.GetProfile .NET Method — Gets one profile of the snapshot with all of its capabilities.
• Gem300CatalogChange.Gem300CatalogChange .NET Constructor — The outcome of a change to a Gem300CapabilityCatalog.
• GemAlarmChange.GemAlarmChange .NET Constructor — Represents the result of GemEquipment.ObserveAlarm.
• GemAlarmConfiguration.GemAlarmConfiguration .NET Constructor — Represents the alarm store that GemEquipmentWorker installs on its equipment endpoint at startup.
• GemAlarmDefinition.GemAlarmDefinition .NET Constructor — Defines one equipment alarm for GemEquipment.ConfigureAlarms.
• GemAlarmEntry.GemAlarmEntry .NET Constructor — Represents one configured equipment alarm together with its text.
• GemAlarmInfo.GemAlarmInfo .NET Constructor — Represents the local state and metadata of one configured equipment alarm.
• GemAlarmOptions.GemAlarmOptions .NET Constructor — Initializes a new instance with default values.
• GemAlarmResultInfo.GemAlarmResultInfo .NET Constructor — Describes an alarm report or alarm list carried by a host-side GemResult.
• GemAlarmState.GemAlarmState .NET Constructor — Represents a snapshot of the counters of the configured equipment alarm store.
• GemAlarmValue.GemAlarmValue .NET Constructor — Represents one alarm entry received from the equipment together with its text.
• GemAlarmValueInfo.GemAlarmValueInfo .NET Constructor — Represents the fields of one alarm entry received from the equipment.
• GemBindingOptions.GemBindingOptions .NET Constructor — Initializes a new instance with default values.
• GemBindingState.GemBindingState .NET Constructor — Represents the current state of an equipment's report variable bindings.
• GemCommandArgument.Dispose .NET Method — Releases the native name and value items.
• GemCommandConfiguration.GemCommandConfiguration .NET Constructor — Represents the remote command store that GemEquipmentWorker installs on its equipment endpoint at startup.
• GemCommandDefinition.GemCommandDefinition .NET Constructor — Defines one remote command that the equipment validates on receipt.
• GemCommandEntry.Dispose .NET Method — Releases the native name item.
• GemCommandError.Dispose .NET Method — Releases the native name item.
• GemCommandInfo.GemCommandInfo .NET Constructor — Represents the metadata of one configured remote command.
• GemCommandIssue.GemCommandIssue .NET Constructor — Represents one parameter acknowledgement that the equipment returns in an S2F42 reply.
• GemCommandOptions.GemCommandOptions .NET Constructor — Initializes a new instance with default values.
• GemCommandParameter.GemCommandParameter .NET Constructor — Represents one parameter that the host sends with a remote command.
• GemCommandParameterDefinition.GemCommandParameterDefinition .NET Constructor — Defines one parameter of a remote command definition.
• GemCommandParameterEntry.Dispose .NET Method — Releases the native name item.
• GemCommandParameterInfo.GemCommandParameterInfo .NET Constructor — Represents the validation rules of one configured remote command parameter.
• GemCommandReply.GemCommandReply .NET Constructor — Represents the S2F42 reply that the equipment sent for a remote command.
• GemCommandResultInfo.GemCommandResultInfo .NET Constructor — Describes a remote command request received by the equipment (S2F41) or a remote command reply received by the host (S2F42).
• GemCommandState.GemCommandState .NET Constructor — Represents a snapshot of the counters of the configured remote command store.
• GemConstantChange.GemConstantChange .NET Constructor — Represents one new value for an equipment constant in an S2F15 (New Equipment Constant Send) request.
• GemConstantChangeEntry.Dispose .NET Method — Releases GemConstantChangeEntry.Id, GemConstantChangeEntry.Value and GemConstantChangeEntry.Original.
• GemConstantChangeInfo.GemConstantChangeInfo .NET Constructor — Represents the processing state of an S2F15 request result or an S2F16 reply result.
• GemConstantConfiguration.GemConstantConfiguration .NET Constructor — Represents the equipment constant store that GemEquipmentWorker installs on its equipment endpoint at startup.
• GemConstantDefinition.GemConstantDefinition .NET Constructor — Represents one equipment constant to register with GemEquipment.ConfigureConstants.
• GemConstantEntry.Dispose .NET Method — Releases GemConstantEntry.Id.
• GemConstantInfo.GemConstantInfo .NET Constructor — Represents the declared shape of one registered equipment constant.
• GemConstantOptions.GemConstantOptions .NET Constructor — Initializes a new instance with default values.
• GemConstantReply.GemConstantReply .NET Constructor — Represents the S2F16 reply sent by GemEquipment.RespondConstants.
• GemConstantState.GemConstantState .NET Constructor — Represents the counters of the equipment constant store.
• GemConstantValue.Dispose .NET Method — Releases GemConstantValue.Id and GemConstantValue.Value.
• GemDataConfiguration.GemDataConfiguration .NET Constructor — Represents the data variables and optional report bindings that a GemEquipmentWorker configures when it starts.
• GemDataDefinition.GemDataDefinition .NET Constructor — Represents the definition of one data variable in an equipment's data variable store.
• GemDataInfo.GemDataInfo .NET Constructor — Represents the shape and cache state of one data variable.
• GemDataOptions.GemDataOptions .NET Constructor — Initializes a new instance with default values.
• GemDataSample.GemDataSample .NET Constructor — Represents a data variable value supplied for one event report.
• GemDataState.GemDataState .NET Constructor — Represents the current counters of an equipment's data variable store.
• GemDirectoryConfiguration.GemDirectoryConfiguration .NET Constructor — Represents the collection event directory that a GemEquipmentWorker configures when it starts.
• GemDirectoryEntryInfo.GemDirectoryEntryInfo .NET Constructor — Represents the ID and variable count of one directory entry.
• GemDirectoryOptions.GemDirectoryOptions .NET Constructor — Initializes a new instance with default values.
• GemDirectoryState.GemDirectoryState .NET Constructor — Represents the current counters of an equipment's event directory.
• GemEndpoint.BeginCommunication .NET Method — Sends S1F13 (Establish Communications Request) to start GEM communication.
• GemEndpoint.Cancel .NET Method — Cancels a pending transaction.
• GemEndpoint.Deselect .NET Method — Sends an HSMS Deselect.req control message.
• GemEndpoint.Dispose .NET Method — Releases the native endpoint without a graceful wire shutdown.
• GemEndpoint.GetLocalAddress .NET Method — Gets the numeric local socket address, for example the bound address of a passive endpoint.
• GemEndpoint.GetState .NET Method — Gets a snapshot of the GEM state.
• GemEndpoint.GetTransportState .NET Method — Gets the HSMS connection state of the underlying transport.
• GemEndpoint.HandleEvent .NET Method — Processes one transport event with the GEM layer.
• GemEndpoint.IsPending .NET Method — Gets whether a transaction is still waiting for its reply.
• GemEndpoint.Linktest .NET Method — Sends an HSMS Linktest.req control message.
• GemEndpoint.NextEvent .NET Method — Removes the next transport event from the endpoint queue.
• GemEndpoint.Poll .NET Method — Performs pending transport work such as connecting, reading, writing and timer checks.
• GemEndpoint.ReplyRaw .NET Method — Sends a raw SECS-II reply to a received primary message.
• GemEndpoint.RequestRaw .NET Method — Sends a raw SECS-II primary message that GEM does not track.
• GemEndpoint.Select .NET Method — Sends an HSMS Select.req control message.
• GemEndpoint.Start .NET Method — Starts the HSMS transport: an active endpoint starts connecting and a passive endpoint starts listening.
• GemEndpoint.Stop .NET Method — Starts closing the HSMS transport; keep polling and draining events until the state reports closed.
• GemEnhancedCommandConfiguration.GemEnhancedCommandConfiguration .NET Constructor — Represents the enhanced remote command store that GemEquipmentWorker installs on its equipment endpoint at startup.
• GemEnhancedCommandOptions.GemEnhancedCommandOptions .NET Constructor — Initializes a new instance with default values.
• GemEnhancedCommandResultInfo.GemEnhancedCommandResultInfo .NET Constructor — Describes an enhanced remote command request received by the equipment (S2F49) or an enhanced remote command reply received by the host (S2F50).
• GemEnhancedCommandState.GemEnhancedCommandState .NET Constructor — Represents a snapshot of the counters of the configured enhanced remote command store.
• GemEnhancedObjectDefinition.GemEnhancedObjectDefinition .NET Constructor — Defines one object (OBJSPEC) and the enhanced remote commands it accepts.
• GemEnhancedObjectEntry.Dispose .NET Method — Releases the native name item.
• GemEnhancedObjectInfo.GemEnhancedObjectInfo .NET Constructor — Represents the metadata of one configured enhanced command object.
• GemEquipment.CancelProgramGrant .NET Method — Withdraws the grant that an answered S7F1 request activated.
• GemEquipment.CaptureSpool .NET Method — Stores a primary message in the spool if spooling is active and the message is selected.
• GemEquipment.CaptureSpoolAlarm .NET Method — Builds an S5F1 (Alarm Report Send) as GemEquipment.PublishAlarm does and stores it in the spool instead of sending it.
• GemEquipment.CaptureSpoolEvent .NET Method — Builds an S6F11 (Event Report Send) as GemEquipment.PublishEventWithData does and stores it in the spool instead of sending it.
• GemEquipment.ClearDataVariable .NET Method — Removes the cached value of a data variable.
• GemEquipment.ClearReportBindings .NET Method — Removes the explicit report variable bindings.
• GemEquipment.CompleteSpoolDelivery .NET Method — Reports the application's verdict on a delivery and, on success, removes the delivered entry from the spool.
• GemEquipment.ConfigureAlarms .NET Method — Installs the alarm store that backs S5F1 alarm reports and the automatic replies to S5F3, S5F5 and S5F7.
• GemEquipment.ConfigureCommands .NET Method — Installs the remote command store used to validate received S2F41 (Host Command Send) requests.
• GemEquipment.ConfigureConstants .NET Method — Installs the equipment constant store that answers S2F13, S2F29 and S2F15.
• GemEquipment.ConfigureDataVariables .NET Method — Configures or replaces the equipment's data variable store.
• GemEquipment.ConfigureEnhancedCommands .NET Method — Installs the enhanced remote command store used to validate received S2F49 (Enhanced Remote Command) requests.
• GemEquipment.ConfigureEventDirectory .NET Method — Configures or replaces the equipment's collection event directory, which answers S1F23 (Collection Event Namelist Request).
• GemEquipment.ConfigureFixedCatalog .NET Method — Installs a complete fixed report catalog and its explicit report variable bindings in one atomic step.
• GemEquipment.ConfigureLocalSpooling .NET Method — Sets the local spooling policy and the streams and functions selected for spooling.
• GemEquipment.ConfigurePrograms .NET Method — Installs the process program store and enables the stream 7 process program transactions.
• GemEquipment.ConfigureReportBindings .NET Method — Configures or replaces the explicit bindings from report variable IDs (VIDs) to value sources.
• GemEquipment.ConfigureReports .NET Method — Creates the equipment's event report store and registers its collection events.
• GemEquipment.ConfigureSpooling .NET Method — Attaches a spool to the equipment, kept in memory or in a snapshot file.
• GemEquipment.ConfirmProgramReply .NET Method — Accepts an unconfirmed installation so that its saved reply can be sent.
• GemEquipment.ConfirmSpoolReply .NET Method — Accepts the unconfirmed persistence of a held spooling reply so that GemEquipment.RespondSpool can send it.
• GemEquipment.Create .NET Method — Creates an HSMS endpoint and configures it as GEM equipment.
• GemEquipment.DeleteLocalPrograms .NET Method — Deletes process programs from the local store.
• GemEquipment.GetAlarmAt .NET Method — Gets the configured alarm at a position in registration order.
• GemEquipment.GetAlarmState .NET Method — Gets the counters of the configured alarm store.
• GemEquipment.GetBindingAt .NET Method — Gets the report variable binding at a position in stored order.
• GemEquipment.GetBindingState .NET Method — Gets the current state of the report variable bindings.
• GemEquipment.GetCommandAt .NET Method — Gets the configured remote command at a position in registration order.
• GemEquipment.GetCommandParameterAt .NET Method — Gets one parameter definition of a configured remote command.
• GemEquipment.GetCommandState .NET Method — Gets the counters of the configured remote command store.
• GemEquipment.GetConstant .NET Method — Gets one field of a registered equipment constant.
• GemEquipment.GetConstantAt .NET Method — Gets the ID and declared shape of the constant at a position in registration order.
• GemEquipment.GetConstantState .NET Method — Gets the counters of the equipment constant store.
• GemEquipment.GetData .NET Method — Gets one field of a data variable as a new item.
• GemEquipment.GetDataAt .NET Method — Gets the shape and cache state of the data variable at a position in the store.
• GemEquipment.GetDataState .NET Method — Gets the current counters of the equipment's data variable store.
• GemEquipment.GetDirectory .NET Method — Gets one field of an event directory entry as a new item.
• GemEquipment.GetDirectoryAt .NET Method — Gets the event ID and variable count of the directory entry at a position in stored order.
• GemEquipment.GetDirectoryState .NET Method — Gets the current counters of the equipment's event directory.
• GemEquipment.GetEnhancedCommandAt .NET Method — Gets one command definition of a configured enhanced command object.
• GemEquipment.GetEnhancedCommandParameterAt .NET Method — Gets one parameter definition of a command of a configured enhanced command object.
• GemEquipment.GetEnhancedCommandState .NET Method — Gets the counters of the configured enhanced remote command store.
• GemEquipment.GetEnhancedObjectAt .NET Method — Gets the configured enhanced command object at a position in registration order.
• GemEquipment.GetEventAt .NET Method — Gets the collection event at a position in the equipment's report store.
• GemEquipment.GetProgram .NET Method — Gets a copy of the body of a stored process program.
• GemEquipment.GetProgramAt .NET Method — Gets a copy of the stored process program at a position in the store.
• GemEquipment.GetProgramState .NET Method — Gets the counters of the process program store.
• GemEquipment.GetReportAt .NET Method — Gets the report definition at a position in the equipment's report store.
• GemEquipment.GetReportState .NET Method — Gets the current counters of the equipment's event report store.
• GemEquipment.GetReportValue .NET Method — Gets a copy of the current value that a report variable ID resolves to.
• GemEquipment.GetSpoolCatalogAt .NET Method — Gets one entry of the spool catalog.
• GemEquipment.GetSpoolEntryAt .NET Method — Gets a copy of one stored spool entry.
• GemEquipment.GetSpoolEntryCapturedAt .NET Method — Gets the capture time recorded for a spool entry.
• GemEquipment.GetSpoolSelectionAt .NET Method — Gets one stream selection of the current spooling configuration.
• GemEquipment.GetSpoolState .NET Method — Gets the counters, policy and flags of the spool.
• GemEquipment.GetStatus .NET Method — Gets a copy of the current value of a registered status variable.
• GemEquipment.GetStatusIdAt .NET Method — Gets the ID of the status variable at a position in registration order.
• GemEquipment.GetStatusMetadata .NET Method — Gets the name and units of a registered status variable.
• GemEquipment.GrantProgram .NET Method — Sends S7F1 (Process Program Load Inquire) to ask the peer to accept a process program.
• GemEquipment.ObserveAlarm .NET Method — Records the current active state of a configured alarm without sending a message.
• GemEquipment.OperatorOffline .NET Method — Switches the equipment to GemControlState.EquipmentOffline, as the operator's OFF-LINE switch does.
• GemEquipment.OperatorOnline .NET Method — Starts an operator request to go on-line by sending S1F1 (Are You There) to the host.
• GemEquipment.PublishAlarm .NET Method — Sends an S5F1 (Alarm Report Send) message with the current state of a configured alarm.
• GemEquipment.PublishEvent .NET Method — Sends an event report (S6F11) for an enabled collection event; an event without linked reports is sent with an empty report list.
• GemEquipment.PublishEventWithData .NET Method — Sends an event report (S6F11) whose data variable values come from the supplied samples first and from the cached values second.
• GemEquipment.PurgeSpool .NET Method — Removes every stored entry from the spool.
• GemEquipment.PutProgram .NET Method — Stores a process program in the local store.
• GemEquipment.RegisterStatus .NET Method — Registers a status variable that the equipment reports in S1F4 and S1F12.
• GemEquipment.RequestProgram .NET Method — Sends S7F5 (Process Program Request) for a process program of the peer.
• GemEquipment.RespondCommand .NET Method — Sends the S2F42 (Host Command Acknowledge) reply to a received S2F41 remote command.
• GemEquipment.RespondConstants .NET Method — Sends the S2F16 (New Equipment Constant Acknowledge) reply to a received S2F15 request.
• GemEquipment.RespondEnhancedCommand .NET Method — Sends the S2F50 (Enhanced Remote Command Acknowledge) reply to a received S2F49 request.
• GemEquipment.RespondProgram .NET Method — Answers a received stream 7 process program request.
• GemEquipment.RespondReportQuery .NET Method — Answers a received S6F15, S6F19 or S6F21 report query with S6F16, S6F20 or S6F22.
• GemEquipment.RespondSpool .NET Method — Applies a spooling request received by the equipment and sends its reply: S2F44 for S2F43, S2F60 for S2F59 or S6F24 for S6F23.
• GemEquipment.ResyncPrograms .NET Method — Synchronizes the parent directory of the storage file again.
• GemEquipment.ResyncSpool .NET Method — Retries synchronizing the parent directory of the spool snapshot file.
• GemEquipment.RetrySpoolDequeue .NET Method — Retries removing a delivered entry whose success was accepted but whose removal failed.
• GemEquipment.SendNextSpool .NET Method — Sends the oldest stored entry as the next delivery of the current transmission run.
• GemEquipment.SendProgram .NET Method — Sends S7F3 (Process Program Send) with a process program.
• GemEquipment.SetOnlineMode .NET Method — Sets the operator's REMOTE/LOCAL switch.
• GemEquipment.StopSpoolTransmit .NET Method — Ends the current transmission run and keeps the stored entries.
• GemEquipment.SyncSpool .NET Method — Records the current communication and selection state for spooling and activates spooling while communication is down.
• GemEquipment.TryCopyAlarmAt .NET Method — Copies the configured alarm at a position in registration order into a caller-supplied buffer.
• GemEquipment.TryCopyEventAt .NET Method — Copies the collection event at a position in the equipment's report store into a caller buffer.
• GemEquipment.TryCopyReportAt .NET Method — Copies the report definition at a position in the equipment's report store into a caller buffer.
• GemEquipment.TryCopyStatusMetadata .NET Method — Copies the name and units of a registered status variable into caller buffers.
• GemEquipment.UpdateDataVariable .NET Method — Replaces the cached value of a data variable.
• GemEquipment.UpdateStatus .NET Method — Replaces the value of a registered status variable.
• GemEquipmentOptions.GemEquipmentOptions .NET Constructor — Initializes a new instance with default values.
• GemEquipmentSpoolConfiguration.GemEquipmentSpoolConfiguration .NET Constructor — Represents the spool that GemEquipmentWorker.StartWithSpoolingAsync attaches to the equipment.
• GemEquipmentWorker.CancelProgramGrantAsync .NET Method — Queues GemEquipment.CancelProgramGrant on the worker thread.
• GemEquipmentWorker.CaptureSpoolAlarmAsync .NET Method — Queues GemEquipment.CaptureSpoolAlarm on the worker thread.
• GemEquipmentWorker.CaptureSpoolAsync .NET Method — Queues GemEquipment.CaptureSpool on the worker thread.
• GemEquipmentWorker.CaptureSpoolEventAsync .NET Method — Queues GemEquipment.CaptureSpoolEvent on the worker thread.
• GemEquipmentWorker.ClearDataVariableAsync .NET Method — Queues GemEquipment.ClearDataVariable on the worker thread.
• GemEquipmentWorker.CompleteSpoolDeliveryAsync .NET Method — Queues GemEquipment.CompleteSpoolDelivery on the worker thread.
• GemEquipmentWorker.ConfirmProgramReplyAsync .NET Method — Queues GemEquipment.ConfirmProgramReply on the worker thread.
• GemEquipmentWorker.ConfirmSpoolReplyAsync .NET Method — Queues GemEquipment.ConfirmSpoolReply on the worker thread.
• GemEquipmentWorker.GetAlarmAtAsync .NET Method — Queues GemEquipment.GetAlarmAt on the worker thread.
• GemEquipmentWorker.GetAlarmStateAsync .NET Method — Queues GemEquipment.GetAlarmState on the worker thread.
• GemEquipmentWorker.GetBindingAtAsync .NET Method — Queues GemEquipment.GetBindingAt on the worker thread.
• GemEquipmentWorker.GetBindingStateAsync .NET Method — Queues GemEquipment.GetBindingState on the worker thread.
• GemEquipmentWorker.GetCommandAtAsync .NET Method — Queues GemEquipment.GetCommandAt on the worker thread.
• GemEquipmentWorker.GetCommandParameterAtAsync .NET Method — Queues GemEquipment.GetCommandParameterAt on the worker thread.
• GemEquipmentWorker.GetCommandStateAsync .NET Method — Queues GemEquipment.GetCommandState on the worker thread.
• GemEquipmentWorker.GetConstantAsync .NET Method — Queues GemEquipment.GetConstant on the worker thread.
• GemEquipmentWorker.GetConstantAtAsync .NET Method — Queues GemEquipment.GetConstantAt on the worker thread.
• GemEquipmentWorker.GetConstantStateAsync .NET Method — Queues GemEquipment.GetConstantState on the worker thread.
• GemEquipmentWorker.GetDataAsync .NET Method — Queues GemEquipment.GetData on the worker thread.
• GemEquipmentWorker.GetDataAtAsync .NET Method — Queues GemEquipment.GetDataAt on the worker thread.
• GemEquipmentWorker.GetDataStateAsync .NET Method — Queues GemEquipment.GetDataState on the worker thread.
• GemEquipmentWorker.GetDirectoryAsync .NET Method — Queues GemEquipment.GetDirectory on the worker thread.
• GemEquipmentWorker.GetDirectoryAtAsync .NET Method — Queues GemEquipment.GetDirectoryAt on the worker thread.
• GemEquipmentWorker.GetDirectoryStateAsync .NET Method — Queues GemEquipment.GetDirectoryState on the worker thread.
• GemEquipmentWorker.GetEnhancedCommandAtAsync .NET Method — Queues GemEquipment.GetEnhancedCommandAt on the worker thread.
• GemEquipmentWorker.GetEnhancedCommandParameterAtAsync .NET Method — Queues GemEquipment.GetEnhancedCommandParameterAt on the worker thread.
• GemEquipmentWorker.GetEnhancedCommandStateAsync .NET Method — Queues GemEquipment.GetEnhancedCommandState on the worker thread.
• GemEquipmentWorker.GetEnhancedObjectAtAsync .NET Method — Queues GemEquipment.GetEnhancedObjectAt on the worker thread.
• GemEquipmentWorker.GetEventAtAsync .NET Method — Queues GemEquipment.GetEventAt on the worker thread.
• GemEquipmentWorker.GetProgramAsync .NET Method — Queues GemEquipment.GetProgram on the worker thread.
• GemEquipmentWorker.GetProgramAtAsync .NET Method — Queues GemEquipment.GetProgramAt on the worker thread.
• GemEquipmentWorker.GetProgramStateAsync .NET Method — Queues GemEquipment.GetProgramState on the worker thread.
• GemEquipmentWorker.GetReportAtAsync .NET Method — Queues GemEquipment.GetReportAt on the worker thread.
• GemEquipmentWorker.GetReportStateAsync .NET Method — Queues GemEquipment.GetReportState on the worker thread.
• GemEquipmentWorker.GetReportValueAsync .NET Method — Queues GemEquipment.GetReportValue on the worker thread.
• GemEquipmentWorker.GetSpoolCatalogAtAsync .NET Method — Queues GemEquipment.GetSpoolCatalogAt on the worker thread.
• GemEquipmentWorker.GetSpoolEntryAtAsync .NET Method — Queues GemEquipment.GetSpoolEntryAt on the worker thread.
• GemEquipmentWorker.GetSpoolEntryCapturedAtAsync .NET Method — Queues GemEquipment.GetSpoolEntryCapturedAt on the worker thread.
• GemEquipmentWorker.GetSpoolSelectionAtAsync .NET Method — Queues GemEquipment.GetSpoolSelectionAt on the worker thread.
• GemEquipmentWorker.GetSpoolStateAsync .NET Method — Queues GemEquipment.GetSpoolState on the worker thread.
• GemEquipmentWorker.GetStatusAsync .NET Method — Queues GemEquipment.GetStatus on the worker thread.
• GemEquipmentWorker.GetStatusIdAtAsync .NET Method — Queues GemEquipment.GetStatusIdAt on the worker thread.
• GemEquipmentWorker.GetStatusMetadataAsync .NET Method — Queues GemEquipment.GetStatusMetadata on the worker thread.
• GemEquipmentWorker.GrantProgramAsync .NET Method — Queues GemEquipment.GrantProgram on the worker thread.
• GemEquipmentWorker.ObserveAlarmAsync .NET Method — Queues GemEquipment.ObserveAlarm on the worker thread.
• GemEquipmentWorker.OperatorOfflineAsync .NET Method — Queues GemEquipment.OperatorOffline on the worker thread.
• GemEquipmentWorker.OperatorOnlineAsync .NET Method — Queues GemEquipment.OperatorOnline on the worker thread to send S1F1 and attempt to go on-line.
• GemEquipmentWorker.PublishAlarmAsync .NET Method — Queues GemEquipment.PublishAlarm on the worker thread.
• GemEquipmentWorker.PublishEventAsync .NET Method — Queues GemEquipment.PublishEvent on the worker thread.
• GemEquipmentWorker.PublishEventWithDataAsync .NET Method — Queues GemEquipment.PublishEventWithData on the worker thread.
• GemEquipmentWorker.RequestProgramAsync .NET Method — Queues GemEquipment.RequestProgram on the worker thread.
• GemEquipmentWorker.RespondCommandAsync .NET Method — Queues GemEquipment.RespondCommand on the worker thread.
• GemEquipmentWorker.RespondConstantsAsync .NET Method — Queues GemEquipment.RespondConstants on the worker thread.
• GemEquipmentWorker.RespondEnhancedCommandAsync .NET Method — Queues GemEquipment.RespondEnhancedCommand on the worker thread.
• GemEquipmentWorker.RespondProgramAsync .NET Method — Queues GemEquipment.RespondProgram on the worker thread.
• GemEquipmentWorker.RespondReportQueryAsync .NET Method — Queues GemEquipment.RespondReportQuery on the worker thread to answer a received S6F15, S6F19 or S6F21 report query.
• GemEquipmentWorker.RespondSpoolingAsync .NET Method — Queues GemEquipment.RespondSpool on the worker thread.
• GemEquipmentWorker.ResyncProgramsAsync .NET Method — Queues GemEquipment.ResyncPrograms on the worker thread.
• GemEquipmentWorker.ResyncSpoolingAsync .NET Method — Queues GemEquipment.ResyncSpool on the worker thread.
• GemEquipmentWorker.RetrySpoolDequeueAsync .NET Method — Queues GemEquipment.RetrySpoolDequeue on the worker thread.
• GemEquipmentWorker.SendNextSpoolAsync .NET Method — Queues GemEquipment.SendNextSpool on the worker thread.
• GemEquipmentWorker.SendProgramAsync .NET Method — Queues GemEquipment.SendProgram on the worker thread.
• GemEquipmentWorker.SetOnlineModeAsync .NET Method — Queues GemEquipment.SetOnlineMode on the worker thread.
• GemEquipmentWorker.StartAsync .NET Method — Starts an equipment worker whose endpoint is configured with status variables, reports, alarms, remote commands, enhanced remote commands and equipment constants.
• GemEquipmentWorker.StartAsync .NET Method — Starts an equipment worker whose endpoint is configured with a collection event directory and optional status variables, report store, alarms, remote commands, enhanced remote commands, data variables and equipment constants.
• GemEquipmentWorker.StartAsync .NET Method — Starts an equipment worker whose endpoint is configured with data variables and optional status variables, report store, alarms, remote commands, enhanced remote commands and equipment constants.
• GemEquipmentWorker.StartAsync .NET Method — Starts an equipment worker whose endpoint is configured with status variables, reports, alarms, remote commands and enhanced remote commands.
• GemEquipmentWorker.StartAsync .NET Method — Starts an equipment worker whose endpoint is configured with status variables, reports, alarms and remote commands.
• GemEquipmentWorker.StartAsync .NET Method — Starts an equipment worker whose endpoint is configured with status variables, reports and alarms.
• GemEquipmentWorker.StartAsync .NET Method — Starts an equipment worker whose endpoint is configured with initial status variables and an event report store.
• GemEquipmentWorker.StartAsync .NET Method — Starts a polling thread that creates, configures and starts a GEM equipment endpoint.
• GemEquipmentWorker.StartWithFormattedProgramsAsync .NET Method — Starts a polling thread that creates and configures a GEM equipment endpoint, enables formatted process program services on it and starts it.
• GemEquipmentWorker.StartWithProgramsAsync .NET Method — Starts an equipment worker whose process program store is loaded with initial programs.
• GemEquipmentWorker.StartWithProgramsAsync .NET Method — Starts an equipment worker with an empty process program store.
• GemEquipmentWorker.StartWithSpoolingAsync .NET Method — Starts an equipment worker whose endpoint gets a spool before the transport starts.
• GemEquipmentWorker.StopSpoolTransmitAsync .NET Method — Queues GemEquipment.StopSpoolTransmit on the worker thread.
• GemEquipmentWorker.SyncSpoolingAsync .NET Method — Queues GemEquipment.SyncSpool on the worker thread.
• GemEquipmentWorker.UpdateDataVariableAsync .NET Method — Queues GemEquipment.UpdateDataVariable on the worker thread.
• GemEquipmentWorker.UpdateStatusAsync .NET Method — Queues GemEquipment.UpdateStatus on the worker thread.
• GemEvent.Dispose .NET Method — Disposes GemEvent.Result and GemEvent.TransportEvent.
• GemEventDefinition.GemEventDefinition .NET Constructor — Represents a collection event stored by the equipment, with its enable state and linked reports.
• GemEventDirectoryDefinition.GemEventDirectoryDefinition .NET Constructor — Represents one collection event entry of an equipment's event directory.
• GemEventInfo.GemEventInfo .NET Constructor — Represents the header fields of an event report (S6F11) that a host received.
• GemEventReport.GemEventReport .NET Constructor — Represents one report inside a received event report (S6F11).
• GemFixedEventDefinition.GemFixedEventDefinition .NET Constructor — One collection event of a fixed report catalog: its ID, its linked reports and its initial enable state.
• GemFormattedProgramCapabilityCommand.GemFormattedProgramCapabilityCommand .NET Constructor — One command entry of the equipment's process capabilities catalog, sent in S7F22.
• GemFormattedProgramCapabilityCommandInfo.GemFormattedProgramCapabilityCommandInfo .NET Constructor — Describes one command of S7F22 process capabilities data.
• GemFormattedProgramCapabilityInfo.GemFormattedProgramCapabilityInfo .NET Constructor — Describes an S7F21/S7F22 process capabilities transaction held by a GemResult.
• GemFormattedProgramCapabilityOptions.GemFormattedProgramCapabilityOptions .NET Constructor — Limits for the S7F21/S7F22 process capabilities exchange and the equipment's capability catalog.
• GemFormattedProgramCommand.GemFormattedProgramCommand .NET Constructor — One command of a formatted process program: a command code and its parameters.
• GemFormattedProgramCommandInfo.GemFormattedProgramCommandInfo .NET Constructor — Describes one command of a received, stored, selected or executed formatted process program.
• GemFormattedProgramConfiguration.GemFormattedProgramConfiguration .NET Constructor — The set of formatted process program services to enable on a GEM endpoint; a null option skips its service.
• GemFormattedProgramConfiguration.Configure .NET Method — Configures every service whose options are set on a stopped endpoint.
• GemFormattedProgramDryRunInfo.GemFormattedProgramDryRunInfo .NET Constructor — Summarizes a formatted process program dry run report.
• GemFormattedProgramDryRunIssueInfo.GemFormattedProgramDryRunIssueInfo .NET Constructor — Describes one issue of a formatted process program dry run report.
• GemFormattedProgramDryRunOptions.GemFormattedProgramDryRunOptions .NET Constructor — The policy version and limits of one formatted process program dry run.
• GemFormattedProgramDryRunReport.GetInfo .NET Method — Gets the summary of the dry run report.
• GemFormattedProgramDryRunReport.GetIssueInfo .NET Method — Gets one issue of the dry run report.
• GemFormattedProgramDryRunReport.GetModel .NET Method — Gets the equipment model type (MDLN) of the evaluated program.
• GemFormattedProgramDryRunReport.GetProgramId .NET Method — Gets the process program ID (PPID) of the evaluated program.
• GemFormattedProgramDryRunReport.GetProgramIdBytes .NET Method — Gets the raw bytes of the evaluated program's PPID.
• GemFormattedProgramDryRunReport.GetSoftwareRevision .NET Method — Gets the software revision (SOFTREV) of the evaluated program.
• GemFormattedProgramExecutionAction.GetCommandCode .NET Method — Gets the command code (CCODE) of the command that a step action performs.
• GemFormattedProgramExecutionAction.GetInfo .NET Method — Gets the description of the action.
• GemFormattedProgramExecutionAction.GetModel .NET Method — Gets the equipment model type (MDLN) of the program that a start action starts.
• GemFormattedProgramExecutionAction.GetParameter .NET Method — Gets one parameter (PPARM) of the command that a step action performs.
• GemFormattedProgramExecutionAction.GetProgramId .NET Method — Gets the process program ID (PPID) of the program that a start action starts.
• GemFormattedProgramExecutionAction.GetSoftwareRevision .NET Method — Gets the software revision (SOFTREV) of the program that a start action starts.
• GemFormattedProgramExecutionActionInfo.GemFormattedProgramExecutionActionInfo .NET Constructor — Describes an action that a formatted process program execution asks the application to perform.
• GemFormattedProgramExecutionActionToken.GemFormattedProgramExecutionActionToken .NET Constructor — Identifies one action that a formatted process program execution asks the application to perform.
• GemFormattedProgramExecutionInfo.GemFormattedProgramExecutionInfo .NET Constructor — Summarizes the equipment's formatted process program execution at the time of a snapshot.
• GemFormattedProgramExecutionSnapshot.GetApplicationDetailBytes .NET Method — Gets the detail bytes that the application passed with its terminal report.
• GemFormattedProgramExecutionSnapshot.GetCommandCode .NET Method — Gets the command code (CCODE) of one command of the executed program.
• GemFormattedProgramExecutionSnapshot.GetCommandInfo .NET Method — Gets the parameter count and the command code format of one command of the executed program.
• GemFormattedProgramExecutionSnapshot.GetInfo .NET Method — Gets the execution state captured by the snapshot.
• GemFormattedProgramExecutionSnapshot.GetModel .NET Method — Gets the equipment model type (MDLN) of the executed program.
• GemFormattedProgramExecutionSnapshot.GetParameter .NET Method — Gets one parameter (PPARM) of one command of the executed program.
• GemFormattedProgramExecutionSnapshot.GetProgramId .NET Method — Gets the process program ID (PPID) of the executed program.
• GemFormattedProgramExecutionSnapshot.GetSoftwareRevision .NET Method — Gets the software revision (SOFTREV) of the executed program.
• GemFormattedProgramExecutionStart.GemFormattedProgramExecutionStart .NET Constructor — The result of GemFormattedPrograms.StartExecution: the token of the new execution and its start action.
• GemFormattedProgramExecutionStart.Dispose .NET Method — Releases the native memory of GemFormattedProgramExecutionStart.Action.
• GemFormattedProgramExecutionToken.GemFormattedProgramExecutionToken .NET Constructor — Identifies one formatted process program execution of an equipment endpoint.
• GemFormattedProgramInfo.GemFormattedProgramInfo .NET Constructor — Describes an S7F27/S7F28 process program verification send held by a GemResult.
• GemFormattedProgramIssue.GemFormattedProgramIssue .NET Constructor — One issue of an S7F27 process program verification report.
• GemFormattedProgramOptions.GemFormattedProgramOptions .NET Constructor — Limits for S7F27/S7F28 process program verification sends.
• GemFormattedProgramPayload.GemFormattedProgramPayload .NET Constructor — A complete formatted process program: its identifier, model, software revision and commands.
• GemFormattedProgramQueryInfo.GemFormattedProgramQueryInfo .NET Constructor — Describes an S7F25/S7F26 formatted process program request held by a GemResult.
• GemFormattedProgramQueryOptions.GemFormattedProgramQueryOptions .NET Constructor — Limits for S7F25/S7F26 formatted process program requests and the equipment's program store.
• GemFormattedProgramSelectionInfo.GemFormattedProgramSelectionInfo .NET Constructor — Describes the equipment's formatted process program selection at the time of a snapshot.
• GemFormattedProgramSelectionSnapshot.GetCommandCode .NET Method — Gets the command code (CCODE) of one command of the selected program.
• GemFormattedProgramSelectionSnapshot.GetCommandInfo .NET Method — Gets the parameter count and the command code format of one command of the selected program.
• GemFormattedProgramSelectionSnapshot.GetId .NET Method — Gets the process program ID (PPID) of the selected program.
• GemFormattedProgramSelectionSnapshot.GetInfo .NET Method — Gets the selection state captured by the snapshot.
• GemFormattedProgramSelectionSnapshot.GetModel .NET Method — Gets the equipment model type (MDLN) of the selected program.
• GemFormattedProgramSelectionSnapshot.GetParameter .NET Method — Gets one parameter (PPARM) of one command of the selected program.
• GemFormattedProgramSelectionSnapshot.GetSoftwareRevision .NET Method — Gets the software revision (SOFTREV) of the selected program.
• GemFormattedProgramSelectionToken.GemFormattedProgramSelectionToken .NET Constructor — Identifies the equipment's current formatted process program selection.
• GemFormattedProgramStoreEntryInfo.GemFormattedProgramStoreEntryInfo .NET Constructor — Describes one process program of a formatted process program store snapshot.
• GemFormattedProgramStoreInfo.GemFormattedProgramStoreInfo .NET Constructor — Describes the equipment's formatted process program store.
• GemFormattedProgramStoreSnapshot.GetEntryCommandCode .NET Method — Gets the command code (CCODE) of one command of a stored program.
• GemFormattedProgramStoreSnapshot.GetEntryCommandInfo .NET Method — Gets the parameter count and the command code format of one command of a stored program.
• GemFormattedProgramStoreSnapshot.GetEntryId .NET Method — Gets the process program ID (PPID) of one stored program.
• GemFormattedProgramStoreSnapshot.GetEntryInfo .NET Method — Gets the description of one stored program.
• GemFormattedProgramStoreSnapshot.GetEntryModel .NET Method — Gets the equipment model type (MDLN) of one stored program.
• GemFormattedProgramStoreSnapshot.GetEntryParameter .NET Method — Gets one parameter (PPARM) of one command of a stored program.
• GemFormattedProgramStoreSnapshot.GetEntrySoftwareRevision .NET Method — Gets the software revision (SOFTREV) of one stored program.
• GemFormattedProgramStoreSnapshot.GetSnapshotInfo .NET Method — Gets the store information captured by the snapshot.
• GemFormattedProgramTransferInfo.GemFormattedProgramTransferInfo .NET Constructor — Describes an S7F23/S7F24 formatted process program send held by a GemResult.
• GemFormattedProgramTransferOptions.GemFormattedProgramTransferOptions .NET Constructor — Limits for S7F23/S7F24 formatted process program sends.
• GemFormattedProgramVerificationNegotiationInfo.GemFormattedProgramVerificationNegotiationInfo .NET Constructor — Describes an S7F29/S7F30 process program verification negotiation held by a GemResult.
• GemFormattedProgramVerificationNegotiationOptions.GemFormattedProgramVerificationNegotiationOptions .NET Constructor — Limits for the S7F29/S7F30 process program verification inquire and grant that precedes an S7F27 verification send.
• GemFormattedProgramVerificationRequestInfo.GemFormattedProgramVerificationRequestInfo .NET Constructor — Describes an S7F31/S7F32 verification request held by a GemResult.
• GemFormattedProgramVerificationRequestOptions.GemFormattedProgramVerificationRequestOptions .NET Constructor — Limits for S7F31/S7F32 verification requests.
• GemFormattedPrograms.CancelExecution .NET Method — Requests the cancellation of a running execution as a cancel action.
• GemFormattedPrograms.ClearCapabilities .NET Method — Removes the equipment's process capabilities catalog.
• GemFormattedPrograms.ClearSelection .NET Method — Clears the current program selection.
• GemFormattedPrograms.CompleteExecution .NET Method — Reports the final outcome of a running execution and ends it.
• GemFormattedPrograms.ConfigureCapabilities .NET Method — Enables the S7F21/S7F22 process capabilities service and, on equipment, its local capability catalog.
• GemFormattedPrograms.ConfigureQueries .NET Method — Enables the S7F25/S7F26 formatted process program request service and, on equipment, the local formatted program store, selection and execution tracking.
• GemFormattedPrograms.ConfigureTransfers .NET Method — Enables the S7F23/S7F24 formatted process program send service.
• GemFormattedPrograms.ConfigureVerificationNegotiation .NET Method — Enables the S7F29/S7F30 verification inquire and grant negotiation that precedes an S7F27 verification send.
• GemFormattedPrograms.ConfigureVerificationReports .NET Method — Enables the S7F27/S7F28 process program verification report service.
• GemFormattedPrograms.ConfigureVerificationRequests .NET Method — Enables the S7F31/S7F32 verification request service.
• GemFormattedPrograms.DryRun .NET Method — Analyzes the selected program against the equipment's capability catalog without executing it.
• GemFormattedPrograms.GetActionToken .NET Method — Gets the token that identifies an execution action, for GemFormattedPrograms.SubmitActionResult.
• GemFormattedPrograms.GetExecutionSnapshot .NET Method — Gets a snapshot of the equipment's formatted program execution tracker.
• GemFormattedPrograms.GetSelectionSnapshot .NET Method — Gets a snapshot of the current program selection.
• GemFormattedPrograms.GetStoreInfo .NET Method — Gets the revision, usage and limits of the equipment's local formatted program store.
• GemFormattedPrograms.GetStoreSnapshot .NET Method — Gets a copy of every program in the equipment's local formatted program store.
• GemFormattedPrograms.PrepareVerification .NET Method — Prepares an S7F27 verification report for the S7F29/S7F30 negotiation without sending anything.
• GemFormattedPrograms.PutProgram .NET Method — Writes a program to the equipment's local formatted program store.
• GemFormattedPrograms.RemoveProgram .NET Method — Removes a program from the equipment's local formatted program store.
• GemFormattedPrograms.RemoveQuery .NET Method — Removes a program from the equipment's local formatted program store.
• GemFormattedPrograms.ReplaceCapabilities .NET Method — Replaces the equipment's process capabilities catalog that answers S7F21.
• GemFormattedPrograms.RespondCapabilityQuery .NET Method — Answers a received S7F21 with an S7F22 (Process Capabilities Data) built from the local catalog.
• GemFormattedPrograms.RespondQuery .NET Method — Answers a received S7F25 with an S7F26 (Formatted Process Program Data) from the local store.
• GemFormattedPrograms.RespondTransfer .NET Method — Answers a received S7F23 with an S7F24 (Formatted Process Program Acknowledge).
• GemFormattedPrograms.RespondTransferAndStore .NET Method — Answers a received S7F23 with an S7F24 and, in the same step, writes the received program to the local store.
• GemFormattedPrograms.RespondVerification .NET Method — Answers a received S7F29 with an S7F30 (Process Program Verification Grant).
• GemFormattedPrograms.RespondVerificationReport .NET Method — Answers a received S7F27 verification report with S7F28 (Process Program Verification Acknowledge).
• GemFormattedPrograms.RespondVerificationRequest .NET Method — Answers a received S7F31 with an S7F32 (Verification Request Acknowledge).
• GemFormattedPrograms.RetryVerification .NET Method — Sends the S7F27 of a granted verification negotiation when the automatic send after the grant failed.
• GemFormattedPrograms.RetryVerificationResponse .NET Method — Sends again the S7F30 reply that an earlier GemFormattedPrograms.RespondVerification could not queue.
• GemFormattedPrograms.SeedQuery .NET Method — Adds a program to the equipment's local formatted program store, or replaces the stored program with the same PPID.
• GemFormattedPrograms.SelectProgram .NET Method — Selects a stored program for a dry run and execution.
• GemFormattedPrograms.StartExecution .NET Method — Starts tracking the execution of the selected formatted program and returns its first action, a start action.
• GemFormattedPrograms.StepExecution .NET Method — Requests the next command of a running execution as a step action.
• GemFormattedPrograms.SubmitActionResult .NET Method — Reports the application's result for the pending start, step or cancel action.
• GemFormattedPrograms.SubmitCapabilityQuery .NET Method — Sends an S7F21 (Process Capabilities Request) to the equipment.
• GemFormattedPrograms.SubmitPreparedVerification .NET Method — Sends the S7F29 (Process Program Verification Inquire) of a prepared verification report.
• GemFormattedPrograms.SubmitQuery .NET Method — Sends an S7F25 (Formatted Process Program Request) to the equipment.
• GemFormattedPrograms.SubmitTransfer .NET Method — Sends an S7F23 (Formatted Process Program Send) to the equipment.
• GemFormattedPrograms.SubmitVerificationReport .NET Method — Sends an S7F27 (Process Program Verification Send) report to the host.
• GemFormattedPrograms.SubmitVerificationRequest .NET Method — Sends an S7F31 (Verification Request Send) to the equipment.
• GemFormattedPrograms.ValidateSelection .NET Method — Checks that a selection is still valid for execution and returns a snapshot of the selected program.
• GemFormattedProgramsWorker.CancelExecutionAsync .NET Method — Queues GemFormattedPrograms.CancelExecution to run on the worker's polling thread.
• GemFormattedProgramsWorker.ClearCapabilitiesAsync .NET Method — Queues GemFormattedPrograms.ClearCapabilities to run on the worker's polling thread.
• GemFormattedProgramsWorker.ClearSelectionAsync .NET Method — Queues GemFormattedPrograms.ClearSelection to run on the worker's polling thread.
• GemFormattedProgramsWorker.CompleteExecutionAsync .NET Method — Queues GemFormattedPrograms.CompleteExecution to run on the worker's polling thread.
• GemFormattedProgramsWorker.ConfigureCapabilitiesAsync .NET Method — Queues GemFormattedPrograms.ConfigureCapabilities to run on the worker's polling thread.
• GemFormattedProgramsWorker.ConfigureQueriesAsync .NET Method — Queues GemFormattedPrograms.ConfigureQueries to run on the worker's polling thread.
• GemFormattedProgramsWorker.ConfigureTransfersAsync .NET Method — Queues GemFormattedPrograms.ConfigureTransfers to run on the worker's polling thread.
• GemFormattedProgramsWorker.ConfigureVerificationNegotiationAsync .NET Method — Queues GemFormattedPrograms.ConfigureVerificationNegotiation to run on the worker's polling thread.
• GemFormattedProgramsWorker.ConfigureVerificationReportsAsync .NET Method — Queues GemFormattedPrograms.ConfigureVerificationReports to run on the worker's polling thread.
• GemFormattedProgramsWorker.ConfigureVerificationRequestsAsync .NET Method — Queues GemFormattedPrograms.ConfigureVerificationRequests to run on the worker's polling thread.
• GemFormattedProgramsWorker.DryRunAsync .NET Method — Queues GemFormattedPrograms.DryRun to run on the worker's polling thread.
• GemFormattedProgramsWorker.GetExecutionSnapshotAsync .NET Method — Queues GemFormattedPrograms.GetExecutionSnapshot to run on the worker's polling thread.
• GemFormattedProgramsWorker.GetSelectionSnapshotAsync .NET Method — Queues GemFormattedPrograms.GetSelectionSnapshot to run on the worker's polling thread.
• GemFormattedProgramsWorker.GetStoreInfoAsync .NET Method — Queues GemFormattedPrograms.GetStoreInfo to run on the worker's polling thread.
• GemFormattedProgramsWorker.GetStoreSnapshotAsync .NET Method — Queues GemFormattedPrograms.GetStoreSnapshot to run on the worker's polling thread.
• GemFormattedProgramsWorker.PrepareVerificationAsync .NET Method — Queues GemFormattedPrograms.PrepareVerification to run on the worker's polling thread.
• GemFormattedProgramsWorker.PutProgramAsync .NET Method — Queues GemFormattedPrograms.PutProgram to run on the worker's polling thread.
• GemFormattedProgramsWorker.RemoveProgramAsync .NET Method — Queues GemFormattedPrograms.RemoveProgram to run on the worker's polling thread.
• GemFormattedProgramsWorker.RemoveQueryAsync .NET Method — Queues GemFormattedPrograms.RemoveQuery to run on the worker's polling thread.
• GemFormattedProgramsWorker.ReplaceCapabilitiesAsync .NET Method — Queues GemFormattedPrograms.ReplaceCapabilities to run on the worker's polling thread.
• GemFormattedProgramsWorker.RespondCapabilityQueryAsync .NET Method — Queues GemFormattedPrograms.RespondCapabilityQuery to run on the worker's polling thread.
• GemFormattedProgramsWorker.RespondQueryAsync .NET Method — Queues GemFormattedPrograms.RespondQuery to run on the worker's polling thread.
• GemFormattedProgramsWorker.RespondTransferAndStoreAsync .NET Method — Queues GemFormattedPrograms.RespondTransferAndStore to run on the worker's polling thread.
• GemFormattedProgramsWorker.RespondTransferAsync .NET Method — Queues GemFormattedPrograms.RespondTransfer to run on the worker's polling thread.
• GemFormattedProgramsWorker.RespondVerificationAsync .NET Method — Queues GemFormattedPrograms.RespondVerification to run on the worker's polling thread.
• GemFormattedProgramsWorker.RespondVerificationReportAsync .NET Method — Queues GemFormattedPrograms.RespondVerificationReport to run on the worker's polling thread.
• GemFormattedProgramsWorker.RespondVerificationRequestAsync .NET Method — Queues GemFormattedPrograms.RespondVerificationRequest to run on the worker's polling thread.
• GemFormattedProgramsWorker.RetryVerificationAsync .NET Method — Queues GemFormattedPrograms.RetryVerification to run on the worker's polling thread.
• GemFormattedProgramsWorker.RetryVerificationResponseAsync .NET Method — Queues GemFormattedPrograms.RetryVerificationResponse to run on the worker's polling thread.
• GemFormattedProgramsWorker.SeedQueryAsync .NET Method — Queues GemFormattedPrograms.SeedQuery to run on the worker's polling thread.
• GemFormattedProgramsWorker.SelectProgramAsync .NET Method — Queues GemFormattedPrograms.SelectProgram to run on the worker's polling thread.
• GemFormattedProgramsWorker.StartExecutionAsync .NET Method — Queues GemFormattedPrograms.StartExecution to run on the worker's polling thread.
• GemFormattedProgramsWorker.StepExecutionAsync .NET Method — Queues GemFormattedPrograms.StepExecution to run on the worker's polling thread.
• GemFormattedProgramsWorker.SubmitActionResultAsync .NET Method — Queues GemFormattedPrograms.SubmitActionResult to run on the worker's polling thread.
• GemFormattedProgramsWorker.SubmitCapabilityQueryAsync .NET Method — Queues GemFormattedPrograms.SubmitCapabilityQuery to run on the worker's polling thread.
• GemFormattedProgramsWorker.SubmitPreparedVerificationAsync .NET Method — Queues GemFormattedPrograms.SubmitPreparedVerification to run on the worker's polling thread.
• GemFormattedProgramsWorker.SubmitQueryAsync .NET Method — Queues GemFormattedPrograms.SubmitQuery to run on the worker's polling thread.
• GemFormattedProgramsWorker.SubmitTransferAsync .NET Method — Queues GemFormattedPrograms.SubmitTransfer to run on the worker's polling thread.
• GemFormattedProgramsWorker.SubmitVerificationReportAsync .NET Method — Queues GemFormattedPrograms.SubmitVerificationReport to run on the worker's polling thread.
• GemFormattedProgramsWorker.SubmitVerificationRequestAsync .NET Method — Queues GemFormattedPrograms.SubmitVerificationRequest to run on the worker's polling thread.
• GemFormattedProgramsWorker.ValidateSelectionAsync .NET Method — Queues GemFormattedPrograms.ValidateSelection to run on the worker's polling thread.
• GemHost.AcknowledgeAlarm .NET Method — Sends the S5F2 (Alarm Report Acknowledge) reply to a received S5F1 alarm report.
• GemHost.AcknowledgeEvent .NET Method — Sends S6F12 (Event Report Acknowledge) for an event report received from the equipment.
• GemHost.AreYouOnline .NET Method — Sends S1F1 (Are You There) to the equipment.
• GemHost.CancelProgramGrant .NET Method — Withdraws the grant that an answered S7F1 request activated.
• GemHost.ChangeConstants .NET Method — Sends S2F15 (New Equipment Constant Send) with new equipment constant values.
• GemHost.ConfigurePrograms .NET Method — Installs the process program store and enables the stream 7 process program transactions.
• GemHost.ConfigureSpoolHost .NET Method — Enables the host spooling requests and sets their limits.
• GemHost.ConfirmProgramReply .NET Method — Accepts an unconfirmed installation so that its saved reply can be sent.
• GemHost.Create .NET Method — Creates an HSMS endpoint and configures it as a GEM host.
• GemHost.DefineReports .NET Method — Sends S2F33 (Define Report) to the equipment.
• GemHost.DeleteLocalPrograms .NET Method — Deletes process programs from the local store.
• GemHost.DeletePrograms .NET Method — Sends S7F17 (Delete Process Program Send) to delete process programs on the equipment.
• GemHost.EnableAlarm .NET Method — Sends an S5F3 (Enable/Disable Alarm Send) request for one alarm.
• GemHost.EnableEvents .NET Method — Sends S2F37 (Enable/Disable Event Report) to the equipment.
• GemHost.EnhancedRemoteCommand .NET Method — Sends an S2F49 (Enhanced Remote Command) request.
• GemHost.GetProgram .NET Method — Gets a copy of the body of a stored process program.
• GemHost.GetProgramAt .NET Method — Gets a copy of the stored process program at a position in the store.
• GemHost.GetProgramState .NET Method — Gets the counters of the process program store.
• GemHost.GrantProgram .NET Method — Sends S7F1 (Process Program Load Inquire) to ask the peer to accept a process program.
• GemHost.LinkReports .NET Method — Sends S2F35 (Link Event Report) to the equipment.
• GemHost.PutProgram .NET Method — Stores a process program in the local store.
• GemHost.QueryRemoteSpooling .NET Method — Sends S2F59 to request the equipment's current spooling selection.
• GemHost.RemoteCommand .NET Method — Sends an S2F41 (Host Command Send) remote command request.
• GemHost.RequestAlarmList .NET Method — Sends an S5F5 (List Alarms Request) for selected alarms or for all alarms.
• GemHost.RequestAnnotatedQuery .NET Method — Sends S6F21 (Annotated Individual Report Request) for a report.
• GemHost.RequestConstantMetadata .NET Method — Sends S2F29 (Equipment Constant Namelist Request) for equipment constant metadata.
• GemHost.RequestConstantValues .NET Method — Sends S2F13 (Equipment Constant Request) for equipment constant values.
• GemHost.RequestDataDirectory .NET Method — Sends S1F21 (Data Variable Namelist Request) to the equipment.
• GemHost.RequestDirectory .NET Method — Sends S1F21 (Data Variable Namelist Request) or S1F23 (Collection Event Namelist Request) to the equipment.
• GemHost.RequestEnabledAlarmList .NET Method — Sends an S5F7 (List Enabled Alarm Request) for the alarms whose reporting is enabled.
• GemHost.RequestEventDirectory .NET Method — Sends S1F23 (Collection Event Namelist Request) to the equipment.
• GemHost.RequestEventQuery .NET Method — Sends S6F15 (Event Report Request) for a collection event.
• GemHost.RequestIndividualQuery .NET Method — Sends S6F19 (Individual Report Request) for a report.
• GemHost.RequestOffline .NET Method — Sends S1F15 (Request Off-line) to the equipment.
• GemHost.RequestOnline .NET Method — Sends S1F17 (Request On-line) to the equipment.
• GemHost.RequestProgram .NET Method — Sends S7F5 (Process Program Request) for a process program of the peer.
• GemHost.RequestProgramDirectory .NET Method — Sends the header-only S7F19 (Current EPPD Request) for the equipment's process program list.
• GemHost.RequestReportQuery .NET Method — Sends an S6 report query to the equipment.
• GemHost.RequestSpoolConfiguration .NET Method — Sends S2F43 (Reset Spooling Streams and Functions) to set the equipment's spooling selection.
• GemHost.RequestSpooledData .NET Method — Sends S6F23 (Request Spooled Data) to make the equipment transmit or purge its spool.
• GemHost.RequestStatusNames .NET Method — Sends S1F11 (Status Variable Namelist Request) for status variable names and units.
• GemHost.RequestStatusValues .NET Method — Sends S1F3 (Selected Equipment Status Request) for status variable values.
• GemHost.RespondProgram .NET Method — Answers a received stream 7 process program request.
• GemHost.ResyncPrograms .NET Method — Synchronizes the parent directory of the storage file again.
• GemHost.SendProgram .NET Method — Sends S7F3 (Process Program Send) with a process program.
• GemHostOptions.GemHostOptions .NET Constructor — Initializes a new instance with default values.
• GemHostWorker.AcknowledgeAlarmAsync .NET Method — Queues GemHost.AcknowledgeAlarm on the worker thread.
• GemHostWorker.AcknowledgeEventAsync .NET Method — Queues GemHost.AcknowledgeEvent on the worker thread.
• GemHostWorker.AreYouOnlineAsync .NET Method — Queues GemHost.AreYouOnline on the worker thread to send S1F1 (Are You There).
• GemHostWorker.CancelProgramGrantAsync .NET Method — Queues GemHost.CancelProgramGrant on the worker thread.
• GemHostWorker.ChangeConstantsAsync .NET Method — Queues GemHost.ChangeConstants on the worker thread.
• GemHostWorker.ConfirmProgramReplyAsync .NET Method — Queues GemHost.ConfirmProgramReply on the worker thread.
• GemHostWorker.DefineReportsAsync .NET Method — Queues GemHost.DefineReports on the worker thread.
• GemHostWorker.DeleteProgramsAsync .NET Method — Queues GemHost.DeletePrograms on the worker thread.
• GemHostWorker.EnableAlarmAsync .NET Method — Queues GemHost.EnableAlarm on the worker thread.
• GemHostWorker.EnableEventsAsync .NET Method — Queues GemHost.EnableEvents on the worker thread.
• GemHostWorker.EnhancedRemoteCommandAsync .NET Method — Queues GemHost.EnhancedRemoteCommand on the worker thread.
• GemHostWorker.GetProgramAsync .NET Method — Queues GemHost.GetProgram on the worker thread.
• GemHostWorker.GetProgramAtAsync .NET Method — Queues GemHost.GetProgramAt on the worker thread.
• GemHostWorker.GetProgramStateAsync .NET Method — Queues GemHost.GetProgramState on the worker thread.
• GemHostWorker.GrantProgramAsync .NET Method — Queues GemHost.GrantProgram on the worker thread.
• GemHostWorker.LinkReportsAsync .NET Method — Queues GemHost.LinkReports on the worker thread.
• GemHostWorker.QueryRemoteSpoolingAsync .NET Method — Queues GemHost.QueryRemoteSpooling on the worker thread.
• GemHostWorker.RemoteCommandAsync .NET Method — Queues GemHost.RemoteCommand on the worker thread.
• GemHostWorker.RequestAlarmListAsync .NET Method — Queues GemHost.RequestAlarmList on the worker thread.
• GemHostWorker.RequestAnnotatedQueryAsync .NET Method — Queues GemHost.RequestAnnotatedQuery on the worker thread to send S6F21.
• GemHostWorker.RequestConstantMetadataAsync .NET Method — Queues GemHost.RequestConstantMetadata on the worker thread.
• GemHostWorker.RequestConstantValuesAsync .NET Method — Queues GemHost.RequestConstantValues on the worker thread.
• GemHostWorker.RequestDirectoryAsync .NET Method — Queues GemHost.RequestDirectory on the worker thread.
• GemHostWorker.RequestEnabledAlarmListAsync .NET Method — Queues GemHost.RequestEnabledAlarmList on the worker thread.
• GemHostWorker.RequestEventQueryAsync .NET Method — Queues GemHost.RequestEventQuery on the worker thread to send S6F15.
• GemHostWorker.RequestIndividualQueryAsync .NET Method — Queues GemHost.RequestIndividualQuery on the worker thread to send S6F19.
• GemHostWorker.RequestOfflineAsync .NET Method — Queues GemHost.RequestOffline on the worker thread to send S1F15 (Request Off-line).
• GemHostWorker.RequestOnlineAsync .NET Method — Queues GemHost.RequestOnline on the worker thread to send S1F17 (Request On-line).
• GemHostWorker.RequestProgramAsync .NET Method — Queues GemHost.RequestProgram on the worker thread.
• GemHostWorker.RequestProgramDirectoryAsync .NET Method — Queues GemHost.RequestProgramDirectory on the worker thread.
• GemHostWorker.RequestReportQueryAsync .NET Method — Queues GemHost.RequestReportQuery on the worker thread to send an S6 report query.
• GemHostWorker.RequestSpoolConfigurationAsync .NET Method — Queues GemHost.RequestSpoolConfiguration on the worker thread.
• GemHostWorker.RequestSpooledDataAsync .NET Method — Queues GemHost.RequestSpooledData on the worker thread.
• GemHostWorker.RequestStatusNamesAsync .NET Method — Queues GemHost.RequestStatusNames on the worker thread to send S1F11 for status variable names and units.
• GemHostWorker.RequestStatusValuesAsync .NET Method — Queues GemHost.RequestStatusValues on the worker thread to send S1F3 for status variable values.
• GemHostWorker.RespondProgramAsync .NET Method — Queues GemHost.RespondProgram on the worker thread.
• GemHostWorker.ResyncProgramsAsync .NET Method — Queues GemHost.ResyncPrograms on the worker thread.
• GemHostWorker.SendProgramAsync .NET Method — Queues GemHost.SendProgram on the worker thread.
• GemHostWorker.StartAsync .NET Method — Starts a polling thread that creates and starts a GEM host endpoint.
• GemHostWorker.StartWithFormattedProgramsAsync .NET Method — Starts a polling thread that creates a GEM host endpoint, enables formatted process program services on it and starts it.
• GemHostWorker.StartWithProgramsAsync .NET Method — Starts a host worker whose process program store is loaded with initial programs.
• GemHostWorker.StartWithProgramsAsync .NET Method — Starts a host worker with an empty process program store.
• GemHostWorker.StartWithSpoolingAsync .NET Method — Starts a host worker whose endpoint can send spooling requests.
• GemLinkSpec.GemLinkSpec .NET Constructor — Represents one event link that a host sends in S2F35 (Link Event Report).
• GemOwnedSnapshot.Dispose .NET Method — Releases the snapshot's native memory.
• GemProgramConfiguration.GemProgramConfiguration .NET Constructor — Represents the process program store that a worker installs at startup.
• GemProgramDefinition.GemProgramDefinition .NET Constructor — Represents a process program that a worker stores at startup.
• GemProgramEntry.Dispose .NET Method — Releases GemProgramEntry.Id and GemProgramEntry.Body.
• GemProgramInfo.GemProgramInfo .NET Constructor — Represents the state of a received stream 7 process program request or reply.
• GemProgramOptions.GemProgramOptions .NET Constructor — Initializes a new instance with default values.
• GemProgramState.GemProgramState .NET Constructor — Represents the counters of a process program store.
• GemProgramWriteInfo.GemProgramWriteInfo .NET Constructor — Represents the outcome of a local process program change.
• GemQueryInfo.GemQueryInfo .NET Constructor — Represents the report query details of a GemResult.
• GemQueryReportInfo.GemQueryReportInfo .NET Constructor — Represents one report of an S6F16 event report reply.
• GemQueryValue.Dispose .NET Method — Releases GemQueryValue.Value.
• GemReportBinding.GemReportBinding .NET Constructor — Represents a binding from a report variable ID (VID) to the source of its value.
• GemReportBindingEntry.Dispose .NET Method — Releases the GemReportBindingEntry.ConstantId item, if any.
• GemReportConfiguration.GemReportConfiguration .NET Constructor — Represents the event report store that a GemEquipmentWorker configures when it starts.
• GemReportDefinition.GemReportDefinition .NET Constructor — Represents a report definition: a report ID and its ordered variable IDs.
• GemReportOptions.GemReportOptions .NET Constructor — Initializes a new instance with default values.
• GemReportSpec.GemReportSpec .NET Constructor — Represents one report definition that a host sends in S2F33 (Define Report).
• GemReportState.GemReportState .NET Constructor — Represents the current counters of an equipment's event report store.
• GemResult.Dispose .NET Method — Releases the native result.
• GemResult.GetAlarmAt .NET Method — Gets one alarm entry of the alarm report or alarm list carried by the result.
• GemResult.GetAlarmInfo .NET Method — Gets the summary of the alarm report or alarm list carried by the result.
• GemResult.GetBody .NET Method — Gets a copy of the SECS-II body captured with the result.
• GemResult.GetCommandInfo .NET Method — Gets the summary of the remote command request or reply carried by the result.
• GemResult.GetCommandIssue .NET Method — Gets one parameter acknowledgement (CPNAME and CPACK) of a remote command result.
• GemResult.GetCommandName .NET Method — Gets the remote command name (RCMD) of a received S2F41 request.
• GemResult.GetCommandParameter .NET Method — Gets one parameter of a received S2F41 request.
• GemResult.GetConstantChange .NET Method — Gets one ECID/ECV pair of a received S2F15 request.
• GemResult.GetConstantChangeInfo .NET Method — Gets the processing state of a received S2F15 request or S2F16 reply.
• GemResult.GetConstantMetadata .NET Method — Gets one field of an entry of a received S2F30 (Equipment Constant Namelist) reply.
• GemResult.GetConstantValue .NET Method — Gets one entry of a received S2F14 (Equipment Constant Data) reply.
• GemResult.GetDirectory .NET Method — Gets one field of a row in a received namelist reply (S1F22 or S1F24) as a new item.
• GemResult.GetDirectoryAt .NET Method — Gets the ID and variable count of one row in a received namelist reply (S1F22 or S1F24).
• GemResult.GetEnhancedCommandAcknowledgements .NET Method — Gets the parameter acknowledgement list of an enhanced remote command result.
• GemResult.GetEnhancedCommandInfo .NET Method — Gets the summary of the enhanced remote command request or reply carried by the result.
• GemResult.GetEnhancedCommandName .NET Method — Gets the remote command name (RCMD) of a received S2F49 request.
• GemResult.GetEnhancedCommandObject .NET Method — Gets the object specifier (OBJSPEC) of a received S2F49 request.
• GemResult.GetEnhancedCommandParameter .NET Method — Gets one parameter of a received S2F49 request.
• GemResult.GetEventInfo .NET Method — Gets the header fields of an event report (S6F11) received by a host.
• GemResult.GetEventReport .NET Method — Gets the report ID and value count of one report in a received event report (S6F11).
• GemResult.GetEventValue .NET Method — Gets a copy of one variable value (V) from a report in a received event report (S6F11).
• GemResult.GetFormattedProgramCapabilityCommandCode .NET Method — Gets the command code (CCODE) of one command of the process capabilities data.
• GemResult.GetFormattedProgramCapabilityCommandInfo .NET Method — Gets the description of one command of the process capabilities data.
• GemResult.GetFormattedProgramCapabilityCommandName .NET Method — Gets the command name (CNAME) of one command of the process capabilities data.
• GemResult.GetFormattedProgramCapabilityDependencyAt .NET Method — Gets one value of a dependency list of one command of the process capabilities data.
• GemResult.GetFormattedProgramCapabilityInfo .NET Method — Gets the S7F21/S7F22 process capabilities information of this result.
• GemResult.GetFormattedProgramCapabilityModel .NET Method — Gets the equipment model type (MDLN) of the process capabilities data.
• GemResult.GetFormattedProgramCapabilityParameter .NET Method — Gets one parameter description of one command of the process capabilities data.
• GemResult.GetFormattedProgramCapabilitySoftwareRevision .NET Method — Gets the software revision (SOFTREV) of the process capabilities data.
• GemResult.GetFormattedProgramId .NET Method — Gets the process program ID (PPID) of the S7F27 verification report.
• GemResult.GetFormattedProgramInfo .NET Method — Gets the S7F27/S7F28 process program verification information of this result.
• GemResult.GetFormattedProgramIssueAt .NET Method — Gets one issue of the S7F27 verification report.
• GemResult.GetFormattedProgramQueryCommandCode .NET Method — Gets the command code (CCODE) of one command of the returned formatted process program.
• GemResult.GetFormattedProgramQueryCommandInfo .NET Method — Gets the parameter count and the command code format of one command of the returned formatted process program.
• GemResult.GetFormattedProgramQueryId .NET Method — Gets the process program ID (PPID) that the S7F25 requested.
• GemResult.GetFormattedProgramQueryInfo .NET Method — Gets the S7F25/S7F26 formatted process program request information of this result.
• GemResult.GetFormattedProgramQueryModel .NET Method — Gets the equipment model type (MDLN) of the returned formatted process program.
• GemResult.GetFormattedProgramQueryParameter .NET Method — Gets one parameter (PPARM) of one command of the returned formatted process program.
• GemResult.GetFormattedProgramQuerySoftwareRevision .NET Method — Gets the software revision (SOFTREV) of the returned formatted process program.
• GemResult.GetFormattedProgramTransferCommandCode .NET Method — Gets the command code (CCODE) of one command of the received formatted process program.
• GemResult.GetFormattedProgramTransferCommandInfo .NET Method — Gets the parameter count and the command code format of one command of the received formatted process program.
• GemResult.GetFormattedProgramTransferId .NET Method — Gets the process program ID (PPID) of the received formatted process program.
• GemResult.GetFormattedProgramTransferInfo .NET Method — Gets the S7F23/S7F24 formatted process program send information of this result.
• GemResult.GetFormattedProgramTransferModel .NET Method — Gets the equipment model type (MDLN) of the received formatted process program.
• GemResult.GetFormattedProgramTransferParameter .NET Method — Gets one parameter (PPARM) of one command of the received formatted process program.
• GemResult.GetFormattedProgramTransferSoftwareRevision .NET Method — Gets the software revision (SOFTREV) of the received formatted process program.
• GemResult.GetFormattedProgramVerificationNegotiationInfo .NET Method — Gets the S7F29/S7F30 process program verification negotiation information of this result.
• GemResult.GetFormattedProgramVerificationRequestCommandCode .NET Method — Gets the command code (CCODE) of one command of the received formatted process program.
• GemResult.GetFormattedProgramVerificationRequestCommandInfo .NET Method — Gets the parameter count and the command code format of one command of the received formatted process program.
• GemResult.GetFormattedProgramVerificationRequestId .NET Method — Gets the process program ID (PPID) of the received formatted process program.
• GemResult.GetFormattedProgramVerificationRequestInfo .NET Method — Gets the S7F31/S7F32 verification request information of this result.
• GemResult.GetFormattedProgramVerificationRequestModel .NET Method — Gets the equipment model type (MDLN) of the received formatted process program.
• GemResult.GetFormattedProgramVerificationRequestParameter .NET Method — Gets one parameter (PPARM) of one command of the received formatted process program.
• GemResult.GetFormattedProgramVerificationRequestSoftwareRevision .NET Method — Gets the software revision (SOFTREV) of the received formatted process program.
• GemResult.GetInfo .NET Method — Gets the summary of the result: kind, outcome, transaction, codes, token and GEM state.
• GemResult.GetProgramBody .NET Method — Gets a copy of the PPBODY of a received S7F3 request or S7F6 reply.
• GemResult.GetProgramId .NET Method — Gets a copy of a PPID of a process program result.
• GemResult.GetProgramInfo .NET Method — Gets the state of a received stream 7 process program request or reply.
• GemResult.GetProgramItem .NET Method — Gets a copy of a PPID or the PPBODY of a process program result.
• GemResult.GetQueryInfo .NET Method — Gets the report query details of a received query or a query reply.
• GemResult.GetQueryReport .NET Method — Gets one report of an S6F16 event report reply.
• GemResult.GetQueryValue .NET Method — Gets one value of a report query reply.
• GemResult.GetSpoolError .NET Method — Gets one stream error of an S2F44 received by the host.
• GemResult.GetSpoolInfo .NET Method — Gets the spooling details of a spooling request, reply or delivery result.
• GemResult.GetSpoolSelection .NET Method — Gets one stream selection of an S2F43 received by the equipment or of an S2F60 received by the host.
• GemResult.GetStatusName .NET Method — Gets one entry of a validated S1F12 status variable name list.
• GemResult.GetStatusValue .NET Method — Gets one status variable value of a validated S1F4 reply.
• GemResult.TryCopyAlarmAt .NET Method — Copies one alarm entry of the alarm report or alarm list into a caller-supplied buffer.
• GemResult.TryCopyStatusName .NET Method — Copies one entry of a validated S1F12 status variable name list into caller buffers.
• GemResultInfo.GemResultInfo .NET Constructor — Represents the summary of a GemResult.
• GemSpoolEntry.Dispose .NET Method — Releases the body.
• GemSpoolEntryInfo.GemSpoolEntryInfo .NET Constructor — Represents the header of one stored spool entry.
• GemSpoolHostOptions.GemSpoolHostOptions .NET Constructor — Initializes a new instance with default values.
• GemSpoolInfo.GemSpoolInfo .NET Constructor — Represents the spooling details of a GemResult.
• GemSpoolMessageKey.GemSpoolMessageKey .NET Constructor — Represents a primary message (stream and function) in the equipment spool catalog.
• GemSpoolOptions.GemSpoolOptions .NET Constructor — Initializes a new instance with default values.
• GemSpoolPolicy.GemSpoolPolicy .NET Constructor — Initializes a new instance with default values.
• GemSpoolResultError.Dispose .NET Method — Releases GemSpoolResultError.Functions.
• GemSpoolResultSelection.Dispose .NET Method — Releases GemSpoolResultSelection.Functions.
• GemSpoolSelection.GemSpoolSelection .NET Constructor — Represents the functions of one stream that are selected for spooling.
• GemSpoolState.GemSpoolState .NET Constructor — Represents the counters, policy and flags of the equipment spool.
• GemSpoolWriteResult.GemSpoolWriteResult .NET Constructor — Represents the outcome of an equipment spool operation that can change the spool.
• GemState.GemState .NET Constructor — Represents a snapshot of the GEM state of an endpoint.
• GemStatusName.GemStatusName .NET Constructor — Represents the name and units of a status variable.
• GemStatusValue.Dispose .NET Method — Releases GemStatusValue.Value.
• GemStatusVariable.GemStatusVariable .NET Constructor — Represents a status variable that GemEquipmentWorker registers on its endpoint at startup.
• GemWorker.BeginCommunicationAsync .NET Method — Queues GemEndpoint.BeginCommunication on the worker thread to send S1F13.
• GemWorker.CancelAsync .NET Method — Queues GemEndpoint.Cancel on the worker thread.
• GemWorker.DeselectAsync .NET Method — Queues GemEndpoint.Deselect on the worker thread to send an HSMS Deselect.req control message.
• GemWorker.DisposeAsync .NET Method — Stops the worker, releases the endpoint and waits for the worker thread to exit.
• GemWorker.GetLocalAddressAsync .NET Method — Queues GemEndpoint.GetLocalAddress on the worker thread.
• GemWorker.GetStateAsync .NET Method — Queues GemEndpoint.GetState on the worker thread.
• GemWorker.GetTransportStateAsync .NET Method — Queues GemEndpoint.GetTransportState on the worker thread.
• GemWorker.IsPendingAsync .NET Method — Queues GemEndpoint.IsPending on the worker thread.
• GemWorker.LinktestAsync .NET Method — Queues GemEndpoint.Linktest on the worker thread to send an HSMS Linktest.req control message.
• GemWorker.ReadEventsAsync .NET Method — Reads the GEM events produced by the worker thread, in order.
• GemWorker.ReplyRawAsync .NET Method — Queues GemEndpoint.ReplyRaw on the worker thread to send a raw SECS-II reply.
• GemWorker.RequestRawAsync .NET Method — Queues GemEndpoint.RequestRaw on the worker thread to send a raw SECS-II primary message.
• GemWorker.SelectAsync .NET Method — Queues GemEndpoint.Select on the worker thread to send an HSMS Select.req control message.
• GemWorker.StopAsync .NET Method — Queues a graceful stop of the transport on the worker thread.
• HsmsEndpoint.Cancel .NET Method — Cancels an open transaction of this endpoint.
• HsmsEndpoint.Create .NET Method — Creates an HSMS endpoint.
• HsmsEndpoint.Deselect .NET Method — Sends Deselect.req to end the selected HSMS session without closing the connection.
• HsmsEndpoint.Dispose .NET Method — Releases the native endpoint and closes its sockets.
• HsmsEndpoint.GetLocalAddress .NET Method — Gets the local socket address, for example the port a passive endpoint actually listens on.
• HsmsEndpoint.GetState .NET Method — Gets the endpoint's connection state.
• HsmsEndpoint.IsPending .NET Method — Determines whether a transaction of this endpoint is still open.
• HsmsEndpoint.Linktest .NET Method — Sends Linktest.req to check that the connection is alive.
• HsmsEndpoint.NextEvent .NET Method — Takes the next queued event.
• HsmsEndpoint.Poll .NET Method — Advances timers, connection handling and socket I/O.
• HsmsEndpoint.Reply .NET Method — Queues the reply to a received primary message.
• HsmsEndpoint.Request .NET Method — Queues a primary data message.
• HsmsEndpoint.Select .NET Method — Sends Select.req to select the HSMS session.
• HsmsEndpoint.Start .NET Method — Starts connecting (active) or listening (passive).
• HsmsEndpoint.Stop .NET Method — Begins a graceful shutdown of the connection.
• HsmsEvent.DecodeBody .NET Method — Decodes the body of a received message as a SECS-II item.
• HsmsEvent.Dispose .NET Method — Releases the event's native data.
• HsmsEvent.GetBody .NET Method — Copies the encoded SECS-II body of a received message.
• HsmsEvent.GetInfo .NET Method — Gets the event's kind, header, token and kind-specific values.
• HsmsEvent.TryCopyBody .NET Method — Copies the encoded SECS-II body into a caller-supplied span when it is large enough.
• HsmsEventInfo.HsmsEventInfo .NET Constructor — Describes one HsmsEvent.
• HsmsHeader.HsmsHeader .NET Constructor — The 10-byte HSMS message header of a received message.
• HsmsOptions.HsmsOptions .NET Constructor — Initializes a new instance with default values.
• HsmsState.HsmsState .NET Constructor — A snapshot of an HSMS endpoint's state.
• HsmsToken.HsmsToken .NET Constructor — Identifies one transaction of an HSMS endpoint.
• HsmsWorker.CancelAsync .NET Method — Cancels an open transaction on the worker thread.
• HsmsWorker.DeselectAsync .NET Method — Queues Deselect.req on the worker thread.
• HsmsWorker.DisposeAsync .NET Method — Stops the worker, closes the endpoint and waits for the worker thread to exit.
• HsmsWorker.GetLocalAddressAsync .NET Method — Reads the endpoint's local socket address on the worker thread.
• HsmsWorker.GetStateAsync .NET Method — Reads the endpoint's connection state on the worker thread.
• HsmsWorker.IsPendingAsync .NET Method — Determines on the worker thread whether a transaction is still open.
• HsmsWorker.LinktestAsync .NET Method — Queues Linktest.req on the worker thread.
• HsmsWorker.ReadEventsAsync .NET Method — Reads the events produced by the endpoint, in order.
• HsmsWorker.ReplyAsync .NET Method — Queues the reply to a received primary message on the worker thread.
• HsmsWorker.SelectAsync .NET Method — Queues Select.req on the worker thread.
• HsmsWorker.StartAsync .NET Method — Creates an HSMS endpoint on a new worker thread and starts it.
• HsmsWorker.StopAsync .NET Method — Begins a graceful shutdown of the connection and of the worker.
• HsmsWorker.SubmitRequestAsync .NET Method — Queues a primary data message on the worker thread.
• HsmsWorkerOptions.HsmsWorkerOptions .NET Constructor — Initializes a new instance with default values.
• Secs1Event.Secs1Event .NET Constructor — An event produced by a Secs1Worker.
• Secs1IoResult.Secs1IoResult .NET Constructor — The result of a Secs1Read or Secs1Write callback.
• Secs1Message.Secs1Message .NET Constructor — A SECS-I message: block header identity plus the message body.
• Secs1Options.Secs1Options .NET Constructor — Line timing, retry and capacity options for a SECS-I (SEMI E4) endpoint.
• Secs1State.Secs1State .NET Constructor — A snapshot of a SECS-I endpoint's lifecycle flags.
• Secs1Token.Secs1Token .NET Constructor — Identifies one message submitted to a SECS-I endpoint.
• Secs1Worker.DisposeAsync .NET Method — Stops the worker thread, which stops and destroys the native endpoint.
• Secs1Worker.GetStateAsync .NET Method — Reads the endpoint's lifecycle flags on the worker thread.
• Secs1Worker.ReadEventsAsync .NET Method — Reads the events produced by the endpoint, in order.
• Secs1Worker.ResetAsync .NET Method — Clears a line fault so the endpoint can resume.
• Secs1Worker.RestartAsync .NET Method — Starts a stopped endpoint again with a new generation.
• Secs1Worker.StartAsync .NET Method — Creates a SECS-I endpoint on a new worker thread and starts it.
• Secs1Worker.StopAsync .NET Method — Stops the endpoint and discards its runtime state, without invoking the callbacks.
• Secs1Worker.SubmitAsync .NET Method — Queues a message for transmission on the serial line.
• Secs1WorkerOptions.Secs1WorkerOptions .NET Constructor — Queue capacities and timing for a Secs1Worker.
• SecsItem.CreateList .NET Method — Creates a list item from copies of existing items.
• SecsItem.Decode .NET Method — Decodes exactly one encoded SECS-II item.
• SecsItem.Dispose .NET Method — Releases the item's native memory.
• SecsItem.Encode .NET Method — Encodes the item in SECS-II wire format.
• SecsItem.FromAscii .NET Method — Creates an SecsFormat.Ascii item from text.
• SecsItem.FromBinary .NET Method — Creates a SecsFormat.Binary item from raw bytes.
• SecsItem.FromBoolean .NET Method — Creates a SecsFormat.Boolean item from Boolean values, one byte each (1 for true, 0 for false).
• SecsItem.FromF4 .NET Method — Creates a SecsFormat.F4 item from Single IEEE 754 values, big-endian.
• SecsItem.FromF8 .NET Method — Creates a SecsFormat.F8 item from Double IEEE 754 values, big-endian.
• SecsItem.FromI1 .NET Method — Creates a SecsFormat.I1 item from SByte signed integers.
• SecsItem.FromI2 .NET Method — Creates a SecsFormat.I2 item from Int16 signed integers, big-endian.
• SecsItem.FromI4 .NET Method — Creates a SecsFormat.I4 item from Int32 signed integers, big-endian.
• SecsItem.FromI8 .NET Method — Creates a SecsFormat.I8 item from Int64 signed integers, big-endian.
• SecsItem.FromJis8 .NET Method — Creates a SecsFormat.Jis8 item from JIS-8 encoded bytes.
• SecsItem.FromU1 .NET Method — Creates a SecsFormat.U1 item from Byte unsigned integers.
• SecsItem.FromU2 .NET Method — Creates a SecsFormat.U2 item from UInt16 unsigned integers, big-endian.
• SecsItem.FromU4 .NET Method — Creates a SecsFormat.U4 item from UInt32 unsigned integers, big-endian.
• SecsItem.FromU8 .NET Method — Creates a SecsFormat.U8 item from UInt64 unsigned integers, big-endian.
• SecsItem.GetAscii .NET Method — Reads the text of an ASCII item.
• SecsItem.GetBinary .NET Method — Reads the values of a Binary item as raw bytes.
• SecsItem.GetBoolean .NET Method — Reads the values of a Boolean item as Boolean values; any nonzero byte is true.
• SecsItem.GetChild .NET Method — Copies one child of a list item.
• SecsItem.GetF4 .NET Method — Reads the values of an F4 item as Single values.
• SecsItem.GetF8 .NET Method — Reads the values of an F8 item as Double values.
• SecsItem.GetI1 .NET Method — Reads the values of an I1 item as SByte values.
• SecsItem.GetI2 .NET Method — Reads the values of an I2 item as Int16 values.
• SecsItem.GetI4 .NET Method — Reads the values of an I4 item as Int32 values.
• SecsItem.GetI8 .NET Method — Reads the values of an I8 item as Int64 values.
• SecsItem.GetInfo .NET Method — Gets the item's format, element count, encoded size and tree shape.
• SecsItem.GetJis8 .NET Method — Reads the values of a Jis8 item as its JIS-8 bytes, unchanged.
• SecsItem.GetPayload .NET Method — Copies the raw payload bytes of a primitive item.
• SecsItem.GetU1 .NET Method — Reads the values of a U1 item as Byte values.
• SecsItem.GetU2 .NET Method — Reads the values of a U2 item as UInt16 values.
• SecsItem.GetU4 .NET Method — Reads the values of a U4 item as UInt32 values.
• SecsItem.GetU8 .NET Method — Reads the values of a U8 item as UInt64 values.
• SecsItem.Primitive .NET Method — Creates a primitive item from its raw payload bytes.
• SecsItem.TryCopyPayload .NET Method — Copies the raw payload bytes of a primitive item into a caller-supplied span when it is large enough.
• SecsItem.TryEncode .NET Method — Encodes the item into a caller-supplied span when it is large enough.
• SecsLimits.SecsLimits .NET Constructor — Initializes a set of SECS-II limits.
• Gem300Capability.Axis .NET Property — The object area of the capability; each axis occurs at most once per profile.
• Gem300Capability.Id .NET Property — The capability identifier: nonempty printable ASCII without spaces (bytes 0x21 through 0x7E), unique within its profile.
• Gem300Capability.Status .NET Property — The declared status label.
• Gem300Capability.Verification .NET Property — The verification label; the default is the only defined value.
• Gem300CapabilityCatalogInfo.CapabilityCount .NET Property — The number of capabilities across all profiles.
• Gem300CapabilityCatalogInfo.IdentifierBytes .NET Property — The total length, in bytes, of all profile and capability IDs.
• Gem300CapabilityCatalogInfo.ProfileCount .NET Property — The number of profiles.
• Gem300CapabilityCatalogInfo.Revision .NET Property — The catalog revision. It starts at 0 and increases by one for each replace or clear that changes the contents.
• Gem300CapabilityInfo.Axis .NET Property — The Gem300Axis code: 1 process job, 2 carrier, 3 substrate or 4 control job.
• Gem300CapabilityInfo.IdLength .NET Property — The length of the capability ID, in bytes.
• Gem300CapabilityInfo.Status .NET Property — The Gem300Status label code that the application assigns: 1 planned, 2 model only or 3 experimental.
• Gem300CapabilityInfo.Verification .NET Property — The Gem300Verification label code: 1, the only defined value.
• Gem300CapabilityOptions.MaxCapabilitiesPerProfile .NET Property — The largest number of capabilities in one profile, at most 4: the capabilities of a profile must use distinct Gem300Axis values.
• Gem300CapabilityOptions.MaxCapabilityIdBytes .NET Property — The longest capability ID, in bytes.
• Gem300CapabilityOptions.MaxProfileIdBytes .NET Property — The longest profile ID, in bytes.
• Gem300CapabilityOptions.MaxProfiles .NET Property — The largest number of profiles in the catalog.
• Gem300CapabilityOptions.MaxTotalCapabilities .NET Property — The largest number of capabilities across all profiles.
• Gem300CapabilityOptions.MaxTotalIdentifierBytes .NET Property — The largest total length, in bytes, of all profile and capability IDs.
• Gem300CapabilityProfile.Capabilities .NET Property — The capabilities in order: at least one and at most Gem300CapabilityOptions.MaxCapabilitiesPerProfile.
• Gem300CapabilityProfile.Id .NET Property — The profile identifier: nonempty printable ASCII without spaces (bytes 0x21 through 0x7E), unique within the catalog.
• Gem300CapabilityProfileInfo.CapabilityCount .NET Property — The number of capabilities in the profile.
• Gem300CapabilityProfileInfo.IdLength .NET Property — The length of the profile ID, in bytes.
• Gem300CatalogChange.Changed .NET Property — Whether the contents changed; when false, Gem300CatalogChange.Revision is unchanged.
• Gem300CatalogChange.Revision .NET Property — The catalog revision after the call.
• GemAlarmChange.Active .NET Property — The active state of the alarm after the observation.
• GemAlarmChange.Changed .NET Property — Whether the observation changed the active state of the alarm.
• GemAlarmChange.EventId .NET Property — The collection event ID (CEID) mapped to the transition (the set event when the alarm became active, the clear event when it cleared), or null when the state did not change or no event is mapped.
• GemAlarmChange.Id .NET Property — The alarm ID (ALID).
• GemAlarmChange.ReportingEnabled .NET Property — Whether alarm reporting is currently enabled for the alarm.
• GemAlarmConfiguration.Definitions .NET Property — The alarm definitions in registration order.
• GemAlarmConfiguration.Options .NET Property — The alarm store limits.
• GemAlarmDefinition.Category .NET Property — The alarm category, 1 through 63. It is sent in the low bits of the alarm code (ALCD); bit 8 of ALCD carries the active state.
• GemAlarmDefinition.ClearEvent .NET Property — The optional collection event ID (CEID) that GemEquipment.ObserveAlarm returns when the alarm clears. It must be one of the configured report event IDs.
• GemAlarmDefinition.Id .NET Property — The alarm ID (ALID). IDs must be unique within the store.
• GemAlarmDefinition.SetEvent .NET Property — The optional collection event ID (CEID) that GemEquipment.ObserveAlarm returns when the alarm becomes active. It must be one of the event IDs configured with GemEquipment.ConfigureReports.
• GemAlarmDefinition.Text .NET Property — The alarm text (ALTX). It must contain only ASCII characters and be at most the smaller of GemAlarmOptions.MaxTextBytes and 120 bytes. An empty text is allowed.
• GemAlarmEntry.Info .NET Property — The alarm state and metadata.
• GemAlarmEntry.Text .NET Property — The alarm text (ALTX).
• GemAlarmInfo.Active .NET Property — Whether the last observed state of the alarm is active (set).
• GemAlarmInfo.Category .NET Property — The alarm category, 1 through 63.
• GemAlarmInfo.ClearEvent .NET Property — The collection event ID (CEID) mapped to the clear transition, if any.
• GemAlarmInfo.Enabled .NET Property — Whether alarm reporting is enabled. Alarms start disabled; the host enables them with S5F3.
• GemAlarmInfo.Id .NET Property — The alarm ID (ALID).
• GemAlarmInfo.SetEvent .NET Property — The collection event ID (CEID) mapped to the set transition, if any.
• GemAlarmOptions.MaxAlarms .NET Property — Gets the maximum number of alarm definitions. The value must be greater than zero.
• GemAlarmOptions.MaxTextBytes .NET Property — Gets the maximum size, in bytes, of one alarm text (ALTX). The effective limit is the smaller of this value and 120 bytes.
• GemAlarmOptions.MaxTotalTextBytes .NET Property — Gets the maximum combined size, in bytes, of all alarm texts (ALTX) in the store.
• GemAlarmResultInfo.Acknowledged .NET Property — Whether GemHost.AcknowledgeAlarm has sent the S5F2 reply for the report.
• GemAlarmResultInfo.Count .NET Property — The number of alarm entries: 1 for an alarm report (S5F1), or the number of entries in an S5F6 or S5F8 list.
• GemAlarmResultInfo.IsReport .NET Property — Whether the result is a received alarm report (S5F1) rather than a list reply.
• GemAlarmResultInfo.ReplyExpected .NET Property — Whether the alarm report requested a reply (W-bit set). Always false for list replies.
• GemAlarmState.ActiveCount .NET Property — The number of alarms whose observed state is active (set).
• GemAlarmState.AlarmCount .NET Property — The number of configured alarms.
• GemAlarmState.EnabledCount .NET Property — The number of alarms whose reporting the host has enabled with S5F3.
• GemAlarmState.TextBytes .NET Property — The combined size, in bytes, of all alarm texts.
• GemAlarmValue.Info .NET Property — The alarm ID, category and active state from the wire.
• GemAlarmValue.Text .NET Property — The alarm text (ALTX).
• GemAlarmValueInfo.Active .NET Property — Whether bit 8 of the alarm code (ALCD) marks the alarm as active (set).
• GemAlarmValueInfo.Category .NET Property — The alarm category taken from the low six bits of the alarm code (ALCD).
• GemAlarmValueInfo.Id .NET Property — The alarm ID (ALID).
• GemBindingOptions.MaxBindings .NET Property — Gets the maximum number of bindings.
• GemBindingOptions.MaxIdentifierBytes .NET Property — Gets the maximum length, in bytes, of one ASCII constant identifier.
• GemBindingOptions.MaxTotalIdentifierBytes .NET Property — Gets the maximum total length, in bytes, of all ASCII constant identifiers.
• GemBindingState.BindingCount .NET Property — The number of bindings.
• GemBindingState.ExplicitMode .NET Property — true when explicit bindings are configured, even an empty set; false when every VID resolves to the status variable with the same ID.
• GemBindingState.IdentifierBytes .NET Property — The total length, in bytes, of all ASCII constant identifiers.
• GemCommandArgument.Name .NET Property — Gets the parameter name (CPNAME) in its wire format.
• GemCommandArgument.Value .NET Property — Gets the parameter value (CPVAL or CEPVAL).
• GemCommandConfiguration.Definitions .NET Property — The command definitions in registration order.
• GemCommandConfiguration.Options .NET Property — The command store limits.
• GemCommandDefinition.CompletionEvent .NET Property — The optional collection event ID (CEID) returned in GemCommandReply.CompletionEvent when the reply carries HCACK 0 or 4. It must be one of the event IDs configured with GemEquipment.ConfigureReports.
• GemCommandDefinition.Name .NET Property — The remote command name (RCMD): a nonempty ASCII item, or a scalar integer item from -128 through 255. Names must be unique. The item is read only during configuration.
• GemCommandDefinition.Parameters .NET Property — The parameter definitions. Parameter names must be unique within the command.
• GemCommandDefinition.RequireOnlineRemote .NET Property — Whether the command is accepted only in the online remote control state. Otherwise validation rejects it with HCACK 2 (cannot perform now).
• GemCommandEntry.Info .NET Property — Gets the command metadata.
• GemCommandEntry.Name .NET Property — Gets the remote command name (RCMD). A numeric name is returned as an I1 or U1 item, which may differ from the configured format.
• GemCommandError.Code .NET Property — Gets the parameter acknowledge code (CPACK).
• GemCommandError.Name .NET Property — Gets the parameter name (CPNAME).
• GemCommandInfo.CompletionEvent .NET Property — The completion collection event ID (CEID), if any.
• GemCommandInfo.ParameterCount .NET Property — The number of parameter definitions of the command.
• GemCommandInfo.RequireOnlineRemote .NET Property — Whether the command requires the online remote control state.
• GemCommandIssue.Code .NET Property — The parameter acknowledge code (CPACK), 1 through 3: 1 means the parameter name does not exist, 2 means the value is illegal, and 3 means the value format is illegal.
• GemCommandIssue.Name .NET Property — The parameter name (CPNAME): an ASCII item or a scalar integer item.
• GemCommandOptions.MaxCommands .NET Property — Gets the maximum number of remote command definitions. The value must be greater than zero.
• GemCommandOptions.MaxErrors .NET Property — Gets the maximum number of parameter issues (CPACK entries) in a validation result or in a reply.
• GemCommandOptions.MaxIdentifierBytes .NET Property — Gets the maximum size, in bytes, of one ASCII command or parameter name.
• GemCommandOptions.MaxParametersPerCommand .NET Property — Gets the maximum number of parameters of one command definition and of one received S2F41 request.
• GemCommandOptions.MaxTotalIdentifierBytes .NET Property — Gets the maximum combined size, in bytes, of all ASCII command and parameter names. Numeric names count as zero bytes.
• GemCommandOptions.MaxTotalParameters .NET Property — Gets the maximum number of parameter definitions across all commands.
• GemCommandParameter.Name .NET Property — The parameter name (CPNAME): an ASCII item or a scalar integer item. Integer names are sent as I8 or U8.
• GemCommandParameter.Value .NET Property — The parameter value: CPVAL for S2F41, or CEPVAL for S2F49.
• GemCommandParameterDefinition.Format .NET Property — The exact SECS-II format the value must have, or null to accept any allowed format. A value with another format is reported with CPACK 3. For S2F41 commands only Binary, Boolean, ASCII and integer formats are allowed; for S2F49 commands every format except JIS-8 is allowed.
• GemCommandParameterDefinition.MaxCount .NET Property — The maximum element count of the value. It must not be less than MinCount. A longer value is reported with CPACK 2.
• GemCommandParameterDefinition.Maximum .NET Property — The optional inclusive upper bound of every element of an integer value. It must not be less than Minimum. A value above the bound is reported with CPACK 2.
• GemCommandParameterDefinition.MinCount .NET Property — The minimum element count of the value. A shorter value is reported with CPACK 2.
• GemCommandParameterDefinition.Minimum .NET Property — The optional inclusive lower bound of every element of an integer value. Bounds require an integer Format. A value below the bound is reported with CPACK 2.
• GemCommandParameterDefinition.Name .NET Property — The parameter name (CPNAME): an ASCII item, or a scalar integer item (I1, I2, I4, I8, U1, U2, U4 or U8). Positive signed and unsigned names compare equal. The item is read only during configuration.
• GemCommandParameterDefinition.Required .NET Property — Whether the parameter must be present. A missing required parameter is reported with CPACK 2.
• GemCommandParameterEntry.Info .NET Property — Gets the parameter validation rules.
• GemCommandParameterEntry.Name .NET Property — Gets the parameter name (CPNAME). A numeric name is returned as an I8 or U8 item, which may differ from the configured format.
• GemCommandParameterInfo.Format .NET Property — The required SECS-II format of the value, or null when any allowed format is accepted.
• GemCommandParameterInfo.MaxCount .NET Property — The maximum element count of the value.
• GemCommandParameterInfo.Maximum .NET Property — The inclusive upper bound of integer elements, if any.
• GemCommandParameterInfo.MinCount .NET Property — The minimum element count of the value.
• GemCommandParameterInfo.Minimum .NET Property — The inclusive lower bound of integer elements, if any.
• GemCommandParameterInfo.Required .NET Property — Whether the parameter must be present.
• GemCommandReply.Acknowledgement .NET Property — The host command acknowledge code (HCACK) that was sent.
• GemCommandReply.CompletionEvent .NET Property — The completion collection event ID (CEID) of the command when the sent HCACK is 0 or 4; otherwise null. Publish the event separately when the work completes.
• GemCommandResultInfo.CompletionEvent .NET Property — The completion collection event ID (CEID) of an accepted request, or null.
• GemCommandResultInfo.IsRequest .NET Property — true for an equipment-side S2F41 request; false for a host-side S2F42 reply.
• GemCommandResultInfo.IssueCount .NET Property — For a request, the number of parameter issues found by validation on receipt; for a reply, the number of received parameter acknowledgements (CPACK entries).
• GemCommandResultInfo.ParameterCount .NET Property — The number of parameters in the received request, or 0 for a reply.
• GemCommandResultInfo.Responded .NET Property — Whether GemEquipment.RespondCommand has sent the S2F42 reply. Always false for a reply.
• GemCommandResultInfo.ValidationAccepted .NET Property — Whether the built-in validation accepted the request on receipt. Always false for a reply.
• GemCommandResultInfo.ValidationAcknowledgement .NET Property — For a request, the HCACK chosen by validation on receipt: 0 when accepted, otherwise 1, 2 or 3. For a reply, the HCACK received from the equipment.
• GemCommandState.CommandCount .NET Property — The number of configured commands.
• GemCommandState.IdentifierBytes .NET Property — The combined size, in bytes, of all ASCII command and parameter names. Numeric names count as zero bytes.
• GemCommandState.TotalParameters .NET Property — The number of parameter definitions across all commands.
• GemConstantChange.Id .NET Property — The equipment constant ID (ECID): an ASCII item or a scalar integer item.
• GemConstantChange.Value .NET Property — The new value (ECV).
• GemConstantChangeEntry.Id .NET Property — Gets the proposed equipment constant ID (ECID) in its wire format.
• GemConstantChangeEntry.Original .NET Property — Gets the current value of the constant when the request was received, or null when the ID is unknown.
• GemConstantChangeEntry.Value .NET Property — Gets the proposed new value (ECV) in its wire format.
• GemConstantChangeInfo.Applied .NET Property — Whether a nonempty change was applied to the equipment constant store.
• GemConstantChangeInfo.ChangeCount .NET Property — The number of ECID/ECV pairs in the received request; zero for a reply.
• GemConstantChangeInfo.IsRequest .NET Property — true for an S2F15 request received by the equipment; false for an S2F16 reply received by the host, whose other fields are then zero.
• GemConstantChangeInfo.Responded .NET Property — Whether the S2F16 reply was sent.
• GemConstantChangeInfo.ValidationAccepted .NET Property — Whether the automatic receipt validation accepted all changes, so that the application decision is used.
• GemConstantChangeInfo.ValidationAcknowledgement .NET Property — The EAC from the receipt validation: 0 when accepted, 1 when a constant does not exist, or 3 when a value is invalid, for example a wrong format or count, a value outside the bounds, a NaN or a duplicate ID. A rejected receipt is always answered with this code, whatever the application decides.
• GemConstantConfiguration.Definitions .NET Property — The constant definitions in registration order.
• GemConstantConfiguration.Options .NET Property — The constant store limits.
• GemConstantDefinition.Current .NET Property — The initial value (ECV). Its format is the declared format of the constant; later changes must use the same format. JIS-8 items and NaN floating-point values are rejected, also inside lists.
• GemConstantDefinition.DefaultValue .NET Property — The default value (ECDEF), or null when the constant has none. Must have the format of Current.
• GemConstantDefinition.Id .NET Property — The equipment constant ID (ECID): an ASCII item (case-sensitive, may be empty) or a scalar integer item (I1 to I8 or U1 to U8 with one value). Positive signed and unsigned IDs with the same value are the same ID.
• GemConstantDefinition.MaxCount .NET Property — The largest element count that a value of the constant may have; must not be less than MinCount.
• GemConstantDefinition.Maximum .NET Property — The upper bound (ECMAX), or null for none. Must have the format of Current.
• GemConstantDefinition.MinCount .NET Property — The smallest element count that a value of the constant may have.
• GemConstantDefinition.Minimum .NET Property — The lower bound (ECMIN), or null for none. Must have the format of Current.
• GemConstantDefinition.Name .NET Property — The constant name (ECNAME); ASCII only, may be empty.
• GemConstantDefinition.Units .NET Property — The units (UNITS); ASCII only, may be empty.
• GemConstantEntry.Id .NET Property — Gets the equipment constant ID (ECID); a stored integer ID may be returned as an I8 or U8 item.
• GemConstantEntry.Info .NET Property — Gets the declared shape of the constant.
• GemConstantInfo.DefaultPresent .NET Property — Whether the constant has a default value (ECDEF).
• GemConstantInfo.Format .NET Property — The format of the current value, which every new value must use.
• GemConstantInfo.MaxCount .NET Property — The largest element count a value may have.
• GemConstantInfo.MaximumPresent .NET Property — Whether the constant has an upper bound (ECMAX).
• GemConstantInfo.MinCount .NET Property — The smallest element count a value may have.
• GemConstantInfo.MinimumPresent .NET Property — Whether the constant has a lower bound (ECMIN).
• GemConstantOptions.ItemLimits .NET Property — Gets the SECS-II limits that every stored value must satisfy.
• GemConstantOptions.MaxChangesPerRequest .NET Property — Gets the maximum number of ECID/ECV pairs that one received S2F15 request can carry.
• GemConstantOptions.MaxConstants .NET Property — Gets the maximum number of equipment constants (ECIDs) the store can hold.
• GemConstantOptions.MaxIdentifierBytes .NET Property — Gets the maximum length in bytes of an ASCII constant ID, in definitions and in received requests.
• GemConstantOptions.MaxMetadataBytes .NET Property — Gets the maximum total bytes of all ASCII constant IDs, names (ECNAME) and units (UNITS) in the store.
• GemConstantOptions.MaxQueryIds .NET Property — Gets the maximum number of IDs that one received S2F13 or S2F29 request can carry.
• GemConstantOptions.MaxValueBytes .NET Property — Gets the maximum total encoded bytes of all current, default, minimum and maximum values in the store.
• GemConstantReply.Acknowledgement .NET Property — The EAC (equipment acknowledge code) that was sent.
• GemConstantReply.Applied .NET Property — Whether the new values replaced the store contents; false for a rejection and for an empty request.
• GemConstantState.ConstantCount .NET Property — The number of registered constants.
• GemConstantState.MetadataBytes .NET Property — The total bytes of ASCII IDs, names and units in use.
• GemConstantState.ValueBytes .NET Property — The total encoded bytes of current, default, minimum and maximum values in use.
• GemConstantValue.Id .NET Property — Gets the requested equipment constant ID (ECID) in its original request format, or null when the request asked for all constants and the reply carries no IDs.
• GemConstantValue.Value .NET Property — Gets the reported value (ECV). An empty list alone does not prove that the ID is unknown to the equipment.
• GemDataConfiguration.BindingOptions .NET Property — The capacity limits of the report bindings, or null for no explicit bindings. Supply it together with Bindings.
• GemDataConfiguration.Bindings .NET Property — The report variable bindings, or null for none. Supply it together with BindingOptions.
• GemDataConfiguration.Definitions .NET Property — The data variable definitions. The worker validates them and copies names, units and cached values when it is started.
• GemDataConfiguration.Options .NET Property — The capacity limits of the data variable store.
• GemDataDefinition.Cached .NET Property — The initial cached value, or null for no value. An absent value differs from an empty one. The configuring call copies the item; the caller keeps ownership.
• GemDataDefinition.Format .NET Property — The SECS-II format that every value of the variable must have at the top level.
• GemDataDefinition.Id .NET Property — The data variable ID. Report bindings refer to it with GemDataSourceKind.Data.
• GemDataDefinition.MaxCount .NET Property — The maximum top-level count (SecsInfo.Count) of a value; must not be less than MinCount.
• GemDataDefinition.MinCount .NET Property — The minimum top-level count (SecsInfo.Count) of a value.
• GemDataDefinition.Name .NET Property — The ASCII name. The equipment reports it as DVVALNAME in S1F22 for VIDs bound to this variable.
• GemDataDefinition.Units .NET Property — The ASCII units (UNITS); may be empty.
• GemDataInfo.CachedPresent .NET Property — true when the variable has a cached value.
• GemDataInfo.Format .NET Property — The SECS-II format that every value must have.
• GemDataInfo.Id .NET Property — The data variable ID.
• GemDataInfo.MaxCount .NET Property — The maximum top-level count of a value.
• GemDataInfo.MinCount .NET Property — The minimum top-level count of a value.
• GemDataOptions.ItemLimits .NET Property — Gets the SECS-II item limits that every cached value and data sample must satisfy.
• GemDataOptions.MaxMetadataBytes .NET Property — Gets the maximum total size, in bytes, of all ASCII names and units.
• GemDataOptions.MaxSampleBytes .NET Property — Gets the maximum total encoded size, in bytes, of the data samples supplied with one event report.
• GemDataOptions.MaxSamplesPerEvent .NET Property — Gets the maximum number of data samples supplied with one event report.
• GemDataOptions.MaxValueBytes .NET Property — Gets the maximum total encoded size, in bytes, of all cached values.
• GemDataOptions.MaxVariables .NET Property — Gets the maximum number of data variables in the store.
• GemDataSample.Id .NET Property — The data variable ID (not the VID).
• GemDataSample.Value .NET Property — The value. It must match the variable's format and count range. The publishing call copies it; the caller keeps ownership.
• GemDataState.MetadataBytes .NET Property — The total size, in bytes, of all names and units.
• GemDataState.ValueBytes .NET Property — The total encoded size, in bytes, of all cached values.
• GemDataState.VariableCount .NET Property — The number of data variables.
• GemDirectoryConfiguration.Definitions .NET Property — The event entries. The worker validates them and copies names and variable IDs when it is started.
• GemDirectoryConfiguration.Options .NET Property — The capacity limits of the directory.
• GemDirectoryEntryInfo.Id .NET Property — The entry ID: the CEID of an event entry, or the VID of a data variable entry in a received S1F22.
• GemDirectoryEntryInfo.VariableCount .NET Property — The number of variable IDs of an event entry; 0 for data variable entries.
• GemDirectoryOptions.MaxEvents .NET Property — Gets the maximum number of event entries.
• GemDirectoryOptions.MaxMetadataBytes .NET Property — Gets the maximum total length, in bytes, of all event names.
• GemDirectoryOptions.MaxNameBytes .NET Property — Gets the maximum length, in bytes, of one ASCII event name.
• GemDirectoryOptions.MaxTotalVariables .NET Property — Gets the maximum number of variable IDs across all event entries.
• GemDirectoryOptions.MaxVariablesPerEvent .NET Property — Gets the maximum number of variable IDs (VIDs) in one event entry.
• GemDirectoryState.Configured .NET Property — true when a directory is configured, even an empty one; false when none is.
• GemDirectoryState.EventCount .NET Property — The number of event entries.
• GemDirectoryState.MetadataBytes .NET Property — The total length, in bytes, of all event names.
• GemDirectoryState.TotalVariables .NET Property — The number of variable IDs across all event entries.
• GemEndpoint.FormattedPrograms .NET Property — Gets the formatted process program services of this endpoint.
• GemEnhancedCommandConfiguration.Objects .NET Property — The object definitions in registration order.
• GemEnhancedCommandConfiguration.Options .NET Property — The enhanced command store limits.
• GemEnhancedCommandOptions.ItemLimits .NET Property — Gets the SECS-II limits that every received parameter value must satisfy. Every limit must be greater than zero.
• GemEnhancedCommandOptions.MaxCommandsPerObject .NET Property — Gets the maximum number of command definitions of one object.
• GemEnhancedCommandOptions.MaxErrors .NET Property — Gets the maximum number of nonzero parameter acknowledgement codes in a validation result or in a reply.
• GemEnhancedCommandOptions.MaxIdentifierBytes .NET Property — Gets the maximum size, in bytes, of one ASCII command or parameter name.
• GemEnhancedCommandOptions.MaxObjectBytes .NET Property — Gets the maximum size, in bytes, of one object name, configured or received.
• GemEnhancedCommandOptions.MaxObjects .NET Property — Gets the maximum number of object definitions (OBJSPEC).
• GemEnhancedCommandOptions.MaxParametersPerCommand .NET Property — Gets the maximum number of parameters of one command definition and of one received S2F49 request.
• GemEnhancedCommandOptions.MaxRequestValueBytes .NET Property — Gets the maximum combined encoded size, in bytes, of all parameter values (CEPVAL) in one received S2F49 request.
• GemEnhancedCommandOptions.MaxTotalCommands .NET Property — Gets the maximum number of command definitions across all objects.
• GemEnhancedCommandOptions.MaxTotalIdentifierBytes .NET Property — Gets the maximum combined size, in bytes, of all ASCII command and parameter names. Numeric names count as zero bytes.
• GemEnhancedCommandOptions.MaxTotalObjectBytes .NET Property — Gets the maximum combined size, in bytes, of all configured object names.
• GemEnhancedCommandOptions.MaxTotalParameters .NET Property — Gets the maximum number of parameter definitions across all commands.
• GemEnhancedCommandResultInfo.CompletionEvent .NET Property — The completion collection event ID (CEID) of an accepted request, or null.
• GemEnhancedCommandResultInfo.DataId .NET Property — The data ID (DATAID) of the request, or 0 for a reply.
• GemEnhancedCommandResultInfo.IsRequest .NET Property — true for an equipment-side S2F49 request; false for a host-side S2F50 reply.
• GemEnhancedCommandResultInfo.IssueCount .NET Property — The number of outer entries of the parameter acknowledgement list: the validation errors found on receipt for a request (0 when accepted), or the received entries for a reply.
• GemEnhancedCommandResultInfo.ParameterCount .NET Property — The number of parameters in the received request, or 0 for a reply.
• GemEnhancedCommandResultInfo.Responded .NET Property — Whether GemEquipment.RespondEnhancedCommand has sent the S2F50 reply. Always false for a reply.
• GemEnhancedCommandResultInfo.ValidationAccepted .NET Property — Whether the built-in validation accepted the request on receipt. Always false for a reply.
• GemEnhancedCommandResultInfo.ValidationAcknowledgement .NET Property — For a request, the HCACK chosen by validation on receipt: 0 when accepted, otherwise 1, 2, 3 or 6. For a reply, the HCACK received from the equipment.
• GemEnhancedCommandState.CommandCount .NET Property — The number of command definitions across all objects.
• GemEnhancedCommandState.IdentifierBytes .NET Property — The combined size, in bytes, of all ASCII command and parameter names.
• GemEnhancedCommandState.ObjectCount .NET Property — The number of configured objects.
• GemEnhancedCommandState.TotalObjectBytes .NET Property — The combined size, in bytes, of all object names.
• GemEnhancedCommandState.TotalParameters .NET Property — The number of parameter definitions across all commands.
• GemEnhancedObjectDefinition.Commands .NET Property — The command definitions of the object. The rules of GemCommandDefinition apply, except that parameter values may use every format except JIS-8.
• GemEnhancedObjectDefinition.Name .NET Property — The object name: an ASCII item matched exactly and case-sensitively. An empty name is allowed when registered explicitly. Object names must be unique.
• GemEnhancedObjectEntry.Info .NET Property — Gets the object metadata.
• GemEnhancedObjectEntry.Name .NET Property — Gets the object name (OBJSPEC) as an ASCII item.
• GemEnhancedObjectInfo.CommandCount .NET Property — The number of command definitions of the object.
• GemEquipmentOptions.InitialControl .NET Property — Gets the control state the equipment starts in. GemControlState.AttemptOnline is rejected.
• GemEquipmentOptions.ItemLimits .NET Property — Gets the SECS-II limits applied to GEM messages, status values and each GemResult.
• GemEquipmentOptions.MaxMetadataBytes .NET Property — Gets the maximum total bytes of all registered status variable names and units.
• GemEquipmentOptions.MaxValueBytes .NET Property — Gets the maximum total encoded bytes of all registered status variable values.
• GemEquipmentOptions.MaxVariables .NET Property — Gets the maximum number of status variables (SVIDs) that can be registered.
• GemEquipmentOptions.Model .NET Property — Gets the equipment model type (MDLN) reported in S1F2 and S1F13/S1F14. Must contain only ASCII characters.
• GemEquipmentOptions.OnlineMode .NET Property — Gets the on-line state (local or remote) the equipment enters when it goes on-line.
• GemEquipmentOptions.SoftwareRevision .NET Property — Gets the software revision (SOFTREV) reported in S1F2 and S1F13/S1F14. Must contain only ASCII characters.
• GemEquipmentSpoolConfiguration.Catalog .NET Property — The primary messages that can be spooled, in order; empty to accept the catalog of an existing snapshot file.
• GemEquipmentSpoolConfiguration.LocalPolicy .NET Property — The local spooling policy, or null to keep the policy of a new spool (disabled) or of the loaded file.
• GemEquipmentSpoolConfiguration.Options .NET Property — The spool limits.
• GemEquipmentSpoolConfiguration.Path .NET Property — The path of the snapshot file, whose parent directory must exist, or null for an in-memory spool.
• GemEquipmentSpoolConfiguration.Selections .NET Property — The stream selections applied with LocalPolicy; not applied when it is null, but still checked against the limits.
• GemEvent.ProcessingStatus .NET Property — Gets PdcommStatus.Ok when GemEvent.Result is available, or the status that GemEndpoint.HandleEvent failed with, for example PdcommStatus.StaleToken.
• GemEvent.Result .NET Property — Gets the GEM result, or null when processing failed; GemEvent.ProcessingStatus then holds the reason.
• GemEvent.TransportEvent .NET Property — Gets the raw HSMS event, which stays readable after GEM processing.
• GemEventDefinition.Enabled .NET Property — true when reporting of the event is enabled.
• GemEventDefinition.EventId .NET Property — The collection event ID (CEID).
• GemEventDefinition.ReportIds .NET Property — The linked report IDs (RPTIDs) in link order; empty when the event is not linked.
• GemEventDirectoryDefinition.Id .NET Property — The collection event ID (CEID). The directory must list exactly the events registered in the event report store.
• GemEventDirectoryDefinition.Name .NET Property — The ASCII event name (CENAME) reported in S1F24; may be empty.
• GemEventDirectoryDefinition.VariableIds .NET Property — The variable IDs (VIDs) reported for the event in S1F24, without duplicates. Each VID must be bound to an existing data variable (GemDataSourceKind.Data).
• GemEventInfo.Acknowledged .NET Property — true after GemHost.AcknowledgeEvent sent S6F12 for the result.
• GemEventInfo.DataId .NET Property — The data ID (DATAID) of the message.
• GemEventInfo.EventId .NET Property — The collection event ID (CEID).
• GemEventInfo.ReportCount .NET Property — The number of reports in the message.
• GemEventReport.ReportId .NET Property — The report ID (RPTID).
• GemEventReport.ValueCount .NET Property — The number of variable values (V) in the report.
• GemFixedEventDefinition.Enabled .NET Property — Whether the event starts enabled for reporting.
• GemFixedEventDefinition.Id .NET Property — The collection event ID (CEID).
• GemFixedEventDefinition.ReportIds .NET Property — The report IDs (RPTID) linked to the event, in report order.
• GemFormattedProgramCapabilityCommand.AfterDependency .NET Property — The after-dependency value (ACDS); it is sent as a single U2 value.
• GemFormattedProgramCapabilityCommand.BeforeDependencies .NET Property — The before-dependency values (BCDS); they are sent as a U2 array.
• GemFormattedProgramCapabilityCommand.BlockDefinition .NET Property — The block definition (BLKDEF): -1, 0 or 1; it is sent as an I1 item.
• GemFormattedProgramCapabilityCommand.Code .NET Property — The command code (CCODE): ASCII text of at most GemFormattedProgramCapabilityOptions.MaxCommandCodeBytes bytes.
• GemFormattedProgramCapabilityCommand.ImmediateAfterDependencies .NET Property — The immediately-after dependency values (IACDS); they are sent as a U2 array.
• GemFormattedProgramCapabilityCommand.ImmediateBeforeDependencies .NET Property — The immediately-before dependency values (IBCDS); they are sent as a U2 array.
• GemFormattedProgramCapabilityCommand.Name .NET Property — The command name (CNAME): ASCII text of at most 16 bytes.
• GemFormattedProgramCapabilityCommand.NonAfterDependencies .NET Property — The not-after dependency values (NACDS); they are sent as a U2 array.
• GemFormattedProgramCapabilityCommand.NonBeforeDependencies .NET Property — The not-before dependency values (NBCDS); they are sent as a U2 array.
• GemFormattedProgramCapabilityCommand.Parameters .NET Property — The parameter descriptors in wire order: each one is a list item with 4, 5 or 9 elements.
• GemFormattedProgramCapabilityCommand.Required .NET Property — Whether a program must contain the command (RQCMD); it is sent as a Boolean item.
• GemFormattedProgramCapabilityCommandInfo.AfterDependency .NET Property — The single U2 after-dependency value (ACDS).
• GemFormattedProgramCapabilityCommandInfo.BeforeDependencyCount .NET Property — The number of U2 values in the before-dependency list (BCDS).
• GemFormattedProgramCapabilityCommandInfo.BlockDefinition .NET Property — The block definition (BLKDEF): -1, 0 or 1.
• GemFormattedProgramCapabilityCommandInfo.ImmediateAfterDependencyCount .NET Property — The number of U2 values in the immediate-after list (IACDS).
• GemFormattedProgramCapabilityCommandInfo.ImmediateBeforeDependencyCount .NET Property — The number of U2 values in the immediate-before list (IBCDS).
• GemFormattedProgramCapabilityCommandInfo.NonAfterDependencyCount .NET Property — The number of U2 values in the not-after list (NACDS).
• GemFormattedProgramCapabilityCommandInfo.NonBeforeDependencyCount .NET Property — The number of U2 values in the not-before list (NBCDS).
• GemFormattedProgramCapabilityCommandInfo.ParameterCount .NET Property — The number of parameter descriptions; each is a list of 4, 5 or 9 items.
• GemFormattedProgramCapabilityCommandInfo.Required .NET Property — The RQCMD flag: 1 when a process program must contain the command, otherwise 0.
• GemFormattedProgramCapabilityInfo.ByteMaximum .NET Property — The BYTMAX value: the largest encoded size, in bytes, of a process program.
• GemFormattedProgramCapabilityInfo.CommandCount .NET Property — The number of commands in the capability data.
• GemFormattedProgramCapabilityInfo.CommandMaximum .NET Property — The CMDMAX value: the largest number of commands a process program may contain.
• GemFormattedProgramCapabilityInfo.IsRequest .NET Property — Whether the result is a received S7F21 that this equipment answers.
• GemFormattedProgramCapabilityInfo.ReplyReady .NET Property — Whether a received S7F21 still waits for GemFormattedPrograms.RespondCapabilityQuery.
• GemFormattedProgramCapabilityInfo.RequestKind .NET Property — The request kind 39 (GemRequestKind.FormattedCapability).
• GemFormattedProgramCapabilityInfo.Responded .NET Property — Whether the S7F22 was sent by this equipment or received by this host.
• GemFormattedProgramCapabilityOptions.MaxCapabilityBytes .NET Property — The largest encoded size, in bytes, of the whole S7F22 capability data.
• GemFormattedProgramCapabilityOptions.MaxCommandCodeBytes .NET Property — The longest command code (CCODE), in bytes.
• GemFormattedProgramCapabilityOptions.MaxCommands .NET Property — The largest number of commands in the capability data.
• GemFormattedProgramCapabilityOptions.MaxDependenciesPerField .NET Property — The largest number of values in one dependency list of a command (BCDS, IBCDS, NBCDS, IACDS or NACDS).
• GemFormattedProgramCapabilityOptions.MaxHistory .NET Property — The number of completed transaction identities the endpoint remembers to reject a replayed reply or a repeated response; the oldest is forgotten when full. Must be nonzero.
• GemFormattedProgramCapabilityOptions.MaxParametersPerCommand .NET Property — The largest number of parameter descriptions in one command.
• GemFormattedProgramCapabilityOptions.MaxPending .NET Property — The largest number of primaries this endpoint sent that still wait for their reply; a further send fails with PdcommStatus.LimitExceeded. Must be nonzero.
• GemFormattedProgramCapabilityOptions.MaxReceived .NET Property — The largest number of received primaries that wait for this endpoint's response; a further primary is reported as an GemResultKind.Unhandled result. Must be nonzero.
• GemFormattedProgramCapabilityOptions.MaxResults .NET Property — The number of completed transactions the endpoint retains; the oldest is discarded when full. Must be nonzero.
• GemFormattedProgramCapabilityOptions.MaxTotalDependencies .NET Property — The largest number of dependency values across all commands; the single ACDS value of each command counts as one.
• GemFormattedProgramCapabilityOptions.MaxTotalParameterBytes .NET Property — The largest total encoded size, in bytes, of all parameter descriptions.
• GemFormattedProgramCapabilityOptions.MaxTotalParameters .NET Property — The largest number of parameter descriptions across all commands.
• GemFormattedProgramCommand.Code .NET Property — The command code (CCODE): an ASCII item, or a U1, U2, U4 or U8 item that holds exactly one value.
• GemFormattedProgramCommand.Parameters .NET Property — The command parameters (PPARM) in wire order; any item format is accepted.
• GemFormattedProgramCommandInfo.CodeFormat .NET Property — The SECS-II format of the command code (CCODE) item.
• GemFormattedProgramCommandInfo.ParameterCount .NET Property — The number of parameters (PPARM) of the command.
• GemFormattedProgramConfiguration.Capabilities .NET Property — The options for the S7F21/S7F22 process capabilities service, passed to GemFormattedPrograms.ConfigureCapabilities.
• GemFormattedProgramConfiguration.Queries .NET Property — The options for the S7F25/S7F26 formatted program request service and the equipment's local store, selection and execution tracking, passed to GemFormattedPrograms.ConfigureQueries.
• GemFormattedProgramConfiguration.Transfers .NET Property — The options for the S7F23/S7F24 formatted program send service, passed to GemFormattedPrograms.ConfigureTransfers.
• GemFormattedProgramConfiguration.VerificationNegotiation .NET Property — The options for the S7F29/S7F30 verification negotiation, passed to GemFormattedPrograms.ConfigureVerificationNegotiation.
• GemFormattedProgramConfiguration.VerificationReports .NET Property — The options for the S7F27/S7F28 verification report service, passed to GemFormattedPrograms.ConfigureVerificationReports.
• GemFormattedProgramConfiguration.VerificationRequests .NET Property — The options for the S7F31/S7F32 verification request service, passed to GemFormattedPrograms.ConfigureVerificationRequests.
• GemFormattedProgramDryRunInfo.CapabilityPresent .NET Property — Whether the equipment's capability catalog held data; without it the report has an indeterminate capability-missing issue. 1 when set, otherwise 0.
• GemFormattedProgramDryRunInfo.CapabilityRevision .NET Property — The revision of the capability catalog the program was compared with.
• GemFormattedProgramDryRunInfo.CommandCount .NET Property — The number of commands in the evaluated program.
• GemFormattedProgramDryRunInfo.EncodedBytes .NET Property — The encoded size, in bytes, of the evaluated program (its S7F23 body).
• GemFormattedProgramDryRunInfo.EndpointId .NET Property — The process-local identity of the endpoint that produced the report.
• GemFormattedProgramDryRunInfo.EntryGeneration .NET Property — The store entry generation captured when the program was selected.
• GemFormattedProgramDryRunInfo.IdFormat .NET Property — The SECS-II format code of the evaluated program's PPID: 16 (SecsFormat.Ascii) or 8 (SecsFormat.Binary).
• GemFormattedProgramDryRunInfo.IssueCount .NET Property — The number of issues; read each with GemFormattedProgramDryRunReport.GetIssueInfo.
• GemFormattedProgramDryRunInfo.Outcome .NET Property — The overall outcome, the most severe outcome of all issues: 0 pass, 1 indeterminate or 2 reject; see GemFormattedProgramDryRunOutcome.
• GemFormattedProgramDryRunInfo.PolicyVersion .NET Property — The policy version the report was evaluated with.
• GemFormattedProgramDryRunInfo.SelectionGeneration .NET Property — The selection generation of the evaluated selection.
• GemFormattedProgramDryRunInfo.SessionGeneration .NET Property — The connection generation in which the evaluated program was selected.
• GemFormattedProgramDryRunInfo.StoreRevision .NET Property — The program store revision captured when the program was selected.
• GemFormattedProgramDryRunIssueInfo.Code .NET Property — The issue code: 1 capability missing, 2 model mismatch, 3 software revision mismatch, 4 command count exceeded, 5 encoded bytes exceeded, 6 unknown ASCII command, 7 required command missing, 8 unsigned command code unmapped, 9 dependency semantics not evaluated, 10 program parameter semantics not evaluated, 11 capability parameter semantics not evaluated.
• GemFormattedProgramDryRunIssueInfo.CommandIndex .NET Property — The zero-based command index: a command of the program for codes 6, 8 and 10, a command of the capability catalog for codes 7, 9 and 11.
• GemFormattedProgramDryRunIssueInfo.Expected .NET Property — The expected maximum: CMDMAX for code 4 and BYTMAX for code 5.
• GemFormattedProgramDryRunIssueInfo.FieldIndex .NET Property — The zero-based field index; policy version 1 never sets it.
• GemFormattedProgramDryRunIssueInfo.Observed .NET Property — The observed value: the program's command count for code 4, its encoded size in bytes for code 5, and the command's parameter count for codes 10 and 11.
• GemFormattedProgramDryRunIssueInfo.Outcome .NET Property — The outcome the issue contributes: 1 indeterminate or 2 reject; see GemFormattedProgramDryRunOutcome.
• GemFormattedProgramDryRunIssueInfo.PresenceMask .NET Property — Bit flags of the optional fields: 1 GemFormattedProgramDryRunIssueInfo.CommandIndex, 2 GemFormattedProgramDryRunIssueInfo.FieldIndex, 4 GemFormattedProgramDryRunIssueInfo.Observed, 8 GemFormattedProgramDryRunIssueInfo.Expected.
• GemFormattedProgramDryRunOptions.MaxIssues .NET Property — The largest number of issues the report may hold.
• GemFormattedProgramDryRunOptions.MaxProgramEncodedBytes .NET Property — The largest encoded size, in bytes, of the selected process program (its S7F23 body) that the dry run evaluates.
• GemFormattedProgramDryRunOptions.PolicyVersion .NET Property — The evaluation policy version. Only 1 is supported; other values fail with PdcommStatus.InvalidArgument.
• GemFormattedProgramExecutionActionInfo.ActionSequence .NET Property — The sequence number of the action within its execution; the start action is 1.
• GemFormattedProgramExecutionActionInfo.CancelNextCommandIndex .NET Property — For a cancel action, the zero-based index of the next command that had not been applied when the cancellation was requested.
• GemFormattedProgramExecutionActionInfo.CapabilityRevision .NET Property — For a start action, the capability catalog revision of the dry run.
• GemFormattedProgramExecutionActionInfo.CodeFormat .NET Property — For a step action, the SECS-II format code of the command code (CCODE): 16 ASCII, or 41, 42, 44 or 40 for U1, U2, U4 or U8; see SecsFormat.
• GemFormattedProgramExecutionActionInfo.CommandCount .NET Property — The number of commands in the executed program.
• GemFormattedProgramExecutionActionInfo.CommandIndex .NET Property — For a step action, the zero-based index of the command to perform.
• GemFormattedProgramExecutionActionInfo.DryRunOutcome .NET Property — For a start action, the GemFormattedProgramDryRunOutcome code of the dry run that admitted the execution.
• GemFormattedProgramExecutionActionInfo.EndpointId .NET Property — The process-local identity of the endpoint that runs the execution.
• GemFormattedProgramExecutionActionInfo.ExecutionGeneration .NET Property — The execution number of the execution the action belongs to.
• GemFormattedProgramExecutionActionInfo.IdFormat .NET Property — For a start action, the SECS-II format code of the program's PPID: 16 (SecsFormat.Ascii) or 8 (SecsFormat.Binary).
• GemFormattedProgramExecutionActionInfo.Kind .NET Property — The action kind: 1 start, 2 step or 3 cancel.
• GemFormattedProgramExecutionActionInfo.ParameterCount .NET Property — For a step action, the number of parameters of the command.
• GemFormattedProgramExecutionActionInfo.PolicyVersion .NET Property — For a start action, the dry run policy version.
• GemFormattedProgramExecutionActionInfo.PresenceMask .NET Property — Bit flags: 1 program ID, 2 model and 4 software revision for a start action, 8 command for a step action, 16 GemFormattedProgramExecutionActionInfo.CancelNextCommandIndex for a cancel action.
• GemFormattedProgramExecutionActionInfo.SessionGeneration .NET Property — The connection generation in which the execution started.
• GemFormattedProgramExecutionActionToken.ActionSequence .NET Property — The sequence number of the action within its execution; the start action is 1.
• GemFormattedProgramExecutionActionToken.EndpointId .NET Property — The process-local identity of the endpoint that runs the execution.
• GemFormattedProgramExecutionActionToken.ExecutionGeneration .NET Property — The execution number of the execution the action belongs to.
• GemFormattedProgramExecutionActionToken.Kind .NET Property — The action kind: 1 start, 2 step or 3 cancel.
• GemFormattedProgramExecutionActionToken.SessionGeneration .NET Property — The connection generation in which the execution started.
• GemFormattedProgramExecutionInfo.ApplicationDetailLength .NET Property — The length, in bytes, of the detail of the application report; read it with GemFormattedProgramExecutionSnapshot.GetApplicationDetailBytes.
• GemFormattedProgramExecutionInfo.ApplicationReportId .NET Property — The report ID that the application passed with its terminal report.
• GemFormattedProgramExecutionInfo.ApplicationReportKind .NET Property — The GemFormattedProgramTerminalOutcome code of the application report, or 0 when there is none.
• GemFormattedProgramExecutionInfo.CapabilityPresent .NET Property — Whether the starting dry run had capability data; 1 when set, otherwise 0.
• GemFormattedProgramExecutionInfo.CapabilityRevision .NET Property — The capability catalog revision of the starting dry run.
• GemFormattedProgramExecutionInfo.CommandCount .NET Property — The number of commands in the executed program.
• GemFormattedProgramExecutionInfo.DryRunOutcome .NET Property — The GemFormattedProgramDryRunOutcome code of the dry run the execution started from.
• GemFormattedProgramExecutionInfo.EndpointId .NET Property — The process-local identity of the endpoint that runs the execution.
• GemFormattedProgramExecutionInfo.EntryGeneration .NET Property — The store entry generation captured when the executed program was selected.
• GemFormattedProgramExecutionInfo.ExecutionGeneration .NET Property — The execution number.
• GemFormattedProgramExecutionInfo.IdFormat .NET Property — The SECS-II format code of the executed program's PPID: 16 (SecsFormat.Ascii) or 8 (SecsFormat.Binary).
• GemFormattedProgramExecutionInfo.NextCommandIndex .NET Property — The zero-based index of the next command to step; it advances when a step action is reported as applied.
• GemFormattedProgramExecutionInfo.PendingActionSequence .NET Property — The sequence number of the pending action.
• GemFormattedProgramExecutionInfo.PendingKind .NET Property — The kind of the pending action: 0 none, 1 start, 2 step or 3 cancel.
• GemFormattedProgramExecutionInfo.PolicyVersion .NET Property — The dry run policy version the execution started from.
• GemFormattedProgramExecutionInfo.PresenceMask .NET Property — Bit flags: 1 an action is pending, 2 the application reported a terminal outcome with GemFormattedPrograms.CompleteExecution, 4 that report has detail bytes.
• GemFormattedProgramExecutionInfo.SelectionGeneration .NET Property — The selection generation of the selection the execution started from.
• GemFormattedProgramExecutionInfo.SessionGeneration .NET Property — The connection generation in which the execution started.
• GemFormattedProgramExecutionInfo.State .NET Property — The GemFormattedProgramExecutionState code, 0 empty to 9 outcome unknown; the states from 5 on are terminal.
• GemFormattedProgramExecutionInfo.StoreRevision .NET Property — The program store revision captured when the executed program was selected.
• GemFormattedProgramExecutionStart.Action .NET Property — The start action, which owns native memory. Disposing this object disposes it.
• GemFormattedProgramExecutionStart.Token .NET Property — The token that identifies the execution; pass it to GemFormattedPrograms.StepExecution, GemFormattedPrograms.CancelExecution and GemFormattedPrograms.CompleteExecution.
• GemFormattedProgramExecutionToken.EndpointId .NET Property — The process-local identity of the endpoint that started the execution.
• GemFormattedProgramExecutionToken.ExecutionGeneration .NET Property — The execution number; each start of a new execution increases it by one.
• GemFormattedProgramExecutionToken.SessionGeneration .NET Property — The connection generation in which the execution started.
• GemFormattedProgramInfo.IdFormat .NET Property — The SECS-II format code of the received PPID: 16 (SecsFormat.Ascii) or 8 (SecsFormat.Binary). 0 on an acknowledgement result.
• GemFormattedProgramInfo.IsRequest .NET Property — Whether the result is a received S7F27 that this host answers.
• GemFormattedProgramInfo.IssueCount .NET Property — The number of issues in the received report; 0 on an acknowledgement result.
• GemFormattedProgramInfo.ReplyReady .NET Property — Whether a received S7F27 still waits for GemFormattedPrograms.RespondVerificationReport.
• GemFormattedProgramInfo.RequestKind .NET Property — The request kind 35 (GemRequestKind.FormattedVerificationReport).
• GemFormattedProgramInfo.Responded .NET Property — Whether the S7F28 was sent by this host or received by this equipment.
• GemFormattedProgramIssue.Code .NET Property — The verification result code, from 0 through 5; it is sent as a U4 item.
• GemFormattedProgramIssue.Sequence .NET Property — The sequence number (SEQNUM) that the issue refers to; it is sent as a U4 item.
• GemFormattedProgramIssue.Text .NET Property — The error text (ERRW7): ASCII and possibly empty. A code of 0 with empty text is still an issue, distinct from an empty issue list.
• GemFormattedProgramOptions.MaxHistory .NET Property — The number of completed transaction identities the endpoint remembers to reject a replayed reply or a repeated response; the oldest is forgotten when full. Must be nonzero.
• GemFormattedProgramOptions.MaxIssueTextBytes .NET Property — The longest issue text (ERRW7), in bytes.
• GemFormattedProgramOptions.MaxIssues .NET Property — The largest number of issues in one S7F27 report, sent or received.
• GemFormattedProgramOptions.MaxPending .NET Property — The largest number of primaries this endpoint sent that still wait for their reply; a further send fails with PdcommStatus.LimitExceeded. Must be nonzero.
• GemFormattedProgramOptions.MaxReceived .NET Property — The largest number of received primaries that wait for this endpoint's response; a further primary is reported as an GemResultKind.Unhandled result. Must be nonzero.
• GemFormattedProgramOptions.MaxResults .NET Property — The number of completed transactions the endpoint retains; the oldest is discarded when full. Must be nonzero.
• GemFormattedProgramOptions.MaxTotalIssueTextBytes .NET Property — The largest total length, in bytes, of all issue texts of one report.
• GemFormattedProgramPayload.Commands .NET Property — The program commands in execution order.
• GemFormattedProgramPayload.Id .NET Property — The process program ID (PPID): a nonempty ASCII or Binary item of at most 120 bytes.
• GemFormattedProgramPayload.Model .NET Property — The equipment model type (MDLN): ASCII text of at most 20 bytes, possibly empty.
• GemFormattedProgramPayload.SoftwareRevision .NET Property — The software revision (SOFTREV): ASCII text of at most 20 bytes, possibly empty.
• GemFormattedProgramQueryInfo.CommandCount .NET Property — The number of commands in the returned program; 0 when no program is present.
• GemFormattedProgramQueryInfo.IdFormat .NET Property — The SECS-II format code of the requested PPID: 16 (SecsFormat.Ascii) or 8 (SecsFormat.Binary).
• GemFormattedProgramQueryInfo.IsRequest .NET Property — Whether the result is a received S7F25 that this equipment answers.
• GemFormattedProgramQueryInfo.Present .NET Property — Whether the S7F26 data carries the requested process program.
• GemFormattedProgramQueryInfo.PresentKnown .NET Property — Whether the answer is known, so that GemFormattedProgramQueryInfo.Present is meaningful; a received S7F25 that is not answered yet has 0.
• GemFormattedProgramQueryInfo.ReplyReady .NET Property — Whether a received S7F25 still waits for GemFormattedPrograms.RespondQuery.
• GemFormattedProgramQueryInfo.RequestKind .NET Property — The request kind 37 (GemRequestKind.FormattedQuery).
• GemFormattedProgramQueryInfo.Responded .NET Property — Whether the S7F26 was sent by this equipment or received by this host.
• GemFormattedProgramQueryOptions.MaxCatalogEntries .NET Property — The largest number of process programs the equipment's store holds.
• GemFormattedProgramQueryOptions.MaxCatalogIdentifierBytes .NET Property — The largest total length, in bytes, of the PPIDs of all stored programs.
• GemFormattedProgramQueryOptions.MaxCommands .NET Property — The largest number of commands in one process program that is stored or received in S7F26.
• GemFormattedProgramQueryOptions.MaxHistory .NET Property — The number of completed transaction identities the endpoint remembers to reject a replayed reply or a repeated response; the oldest is forgotten when full. Must be nonzero.
• GemFormattedProgramQueryOptions.MaxParametersPerCommand .NET Property — The largest number of parameters (PPARM) in one command.
• GemFormattedProgramQueryOptions.MaxPending .NET Property — The largest number of primaries this endpoint sent that still wait for their reply; a further send fails with PdcommStatus.LimitExceeded. Must be nonzero.
• GemFormattedProgramQueryOptions.MaxReceived .NET Property — The largest number of received primaries that wait for this endpoint's response; a further primary is reported as an GemResultKind.Unhandled result. Must be nonzero.
• GemFormattedProgramQueryOptions.MaxResults .NET Property — The number of completed transactions the endpoint retains; the oldest is discarded when full. Must be nonzero.
• GemFormattedProgramQueryOptions.MaxTotalParameterBytes .NET Property — The largest total encoded size, in bytes, of all parameters of one process program.
• GemFormattedProgramQueryOptions.MaxTotalParameters .NET Property — The largest number of parameters across all commands of one process program.
• GemFormattedProgramSelectionInfo.CommandCount .NET Property — The number of commands in the selected program.
• GemFormattedProgramSelectionInfo.EntryGeneration .NET Property — The generation of the selected store entry when the program was selected.
• GemFormattedProgramSelectionInfo.IdFormat .NET Property — The SECS-II format code of the selected PPID: 16 (SecsFormat.Ascii) or 8 (SecsFormat.Binary).
• GemFormattedProgramSelectionInfo.SelectionGeneration .NET Property — The current selection generation.
• GemFormattedProgramSelectionInfo.SessionGeneration .NET Property — The connection generation in which the program was selected.
• GemFormattedProgramSelectionInfo.StaleReason .NET Property — Why a stale selection is stale: 1 the store entry was deleted, 2 the entry changed, 3 the connection generation changed, 4 the connection was lost; 0 when the selection is not stale.
• GemFormattedProgramSelectionInfo.State .NET Property — The selection state: 0 empty, 1 ready or 2 stale.
• GemFormattedProgramSelectionInfo.StoreRevision .NET Property — The program store revision when the program was selected.
• GemFormattedProgramSelectionInfo.ValidForExecution .NET Property — Whether the selection is ready and can start an execution; 1 when set, otherwise 0.
• GemFormattedProgramSelectionToken.EndpointId .NET Property — The process-local identity of the endpoint that made the selection.
• GemFormattedProgramSelectionToken.EntryGeneration .NET Property — The generation of the selected store entry when the program was selected.
• GemFormattedProgramSelectionToken.SelectionGeneration .NET Property — The selection generation; it increases when a new selection replaces the current one and when the selection is cleared.
• GemFormattedProgramSelectionToken.SessionGeneration .NET Property — The connection generation in which the program was selected.
• GemFormattedProgramSelectionToken.StoreRevision .NET Property — The program store revision when the program was selected.
• GemFormattedProgramStoreEntryInfo.CommandCount .NET Property — The number of commands in the program.
• GemFormattedProgramStoreEntryInfo.IdFormat .NET Property — The SECS-II format code of the program's PPID: 16 (SecsFormat.Ascii) or 8 (SecsFormat.Binary).
• GemFormattedProgramStoreInfo.EncodedBytes .NET Property — The total encoded size, in bytes, of the stored programs, each counted as its S7F23 body.
• GemFormattedProgramStoreInfo.EntryCount .NET Property — The number of stored process programs.
• GemFormattedProgramStoreInfo.IdentifierBytes .NET Property — The total length, in bytes, of the PPIDs of the stored programs.
• GemFormattedProgramStoreInfo.MaxEncodedBytes .NET Property — The largest total encoded size, in bytes: GemFormattedProgramStoreInfo.MaxEntries times SecsLimits.MessageBytes of the equipment's item limits.
• GemFormattedProgramStoreInfo.MaxEntries .NET Property — The largest number of stored programs, GemFormattedProgramQueryOptions.MaxCatalogEntries.
• GemFormattedProgramStoreInfo.MaxIdentifierBytes .NET Property — The largest total PPID length, in bytes, GemFormattedProgramQueryOptions.MaxCatalogIdentifierBytes.
• GemFormattedProgramStoreInfo.Revision .NET Property — The store revision; it increases when the stored programs change.
• GemFormattedProgramTransferInfo.Acknowledgement .NET Property — The ACKC7 code (0 to 7) that was received or sent; meaningful when GemFormattedProgramTransferInfo.AcknowledgementPresent is 1.
• GemFormattedProgramTransferInfo.AcknowledgementPresent .NET Property — Whether GemFormattedProgramTransferInfo.Acknowledgement holds a received or sent ACKC7 code.
• GemFormattedProgramTransferInfo.CommandCount .NET Property — The number of commands in the received program; 0 on an acknowledgement result.
• GemFormattedProgramTransferInfo.IdFormat .NET Property — The SECS-II format code of the received PPID: 16 (SecsFormat.Ascii) or 8 (SecsFormat.Binary). 0 on an acknowledgement result.
• GemFormattedProgramTransferInfo.IsRequest .NET Property — Whether the result is a received S7F23 that this equipment answers.
• GemFormattedProgramTransferInfo.ReplyReady .NET Property — Whether a received S7F23 still waits for GemFormattedPrograms.RespondTransfer or GemFormattedPrograms.RespondTransferAndStore.
• GemFormattedProgramTransferInfo.RequestKind .NET Property — The request kind 36 (GemRequestKind.FormattedTransfer).
• GemFormattedProgramTransferInfo.Responded .NET Property — Whether the S7F24 was sent by this equipment or received by this host.
• GemFormattedProgramTransferOptions.MaxCommands .NET Property — The largest number of commands in one process program that is sent or received in S7F23.
• GemFormattedProgramTransferOptions.MaxHistory .NET Property — The number of completed transaction identities the endpoint remembers to reject a replayed reply or a repeated response; the oldest is forgotten when full. Must be nonzero.
• GemFormattedProgramTransferOptions.MaxParametersPerCommand .NET Property — The largest number of parameters (PPARM) in one command.
• GemFormattedProgramTransferOptions.MaxPending .NET Property — The largest number of primaries this endpoint sent that still wait for their reply; a further send fails with PdcommStatus.LimitExceeded. Must be nonzero.
• GemFormattedProgramTransferOptions.MaxReceived .NET Property — The largest number of received primaries that wait for this endpoint's response; a further primary is reported as an GemResultKind.Unhandled result. Must be nonzero.
• GemFormattedProgramTransferOptions.MaxResults .NET Property — The number of completed transactions the endpoint retains; the oldest is discarded when full. Must be nonzero.
• GemFormattedProgramTransferOptions.MaxTotalParameterBytes .NET Property — The largest total encoded size, in bytes, of all parameters of one process program.
• GemFormattedProgramTransferOptions.MaxTotalParameters .NET Property — The largest number of parameters across all commands of one process program.
• GemFormattedProgramVerificationNegotiationInfo.Correlation .NET Property — The sequence number of the negotiation within its connection generation; every result of one negotiation carries the same value.
• GemFormattedProgramVerificationNegotiationInfo.Length .NET Property — The LENGTH value of the S7F29: the encoded size, in bytes, of the S7F27 report body.
• GemFormattedProgramVerificationNegotiationInfo.NegotiationTerminal .NET Property — How the inquire ended: 0 not yet or ended by a malformed S7F30, 1 granted, 2 denied, 3 timed out, 4 disconnected.
• GemFormattedProgramVerificationNegotiationInfo.PpGnt .NET Property — The PPGNT code (0 to 63, where 0 grants); meaningful when GemFormattedProgramVerificationNegotiationInfo.PpGntPresent is 1.
• GemFormattedProgramVerificationNegotiationInfo.PpGntPresent .NET Property — Whether GemFormattedProgramVerificationNegotiationInfo.PpGnt holds a received or sent grant code.
• GemFormattedProgramVerificationNegotiationInfo.Prepared .NET Property — Whether the result describes this equipment's own negotiation rather than a received S7F29.
• GemFormattedProgramVerificationNegotiationInfo.ReplyReady .NET Property — Whether a received S7F29 still waits for GemFormattedPrograms.RespondVerification.
• GemFormattedProgramVerificationNegotiationInfo.RequestKind .NET Property — The request kind: 40 (GemRequestKind.FormattedVerificationNegotiation) for the inquire and grant, or 35 (GemRequestKind.FormattedVerificationReport) for the S7F28 acknowledgement of the S7F27 sent after the grant.
• GemFormattedProgramVerificationNegotiationInfo.Responded .NET Property — Whether this host sent its S7F30 answer.
• GemFormattedProgramVerificationNegotiationInfo.State .NET Property — The negotiation state: 1 prepared by this equipment, 2 received by this host, 3 answered by this host.
• GemFormattedProgramVerificationNegotiationInfo.Submitted .NET Property — Whether the equipment sent the S7F29 inquire.
• GemFormattedProgramVerificationNegotiationInfo.VerificationTerminal .NET Property — How the S7F27 send after a grant ended: 0 not yet or ended by a malformed S7F28, 1 acknowledged with S7F28, 3 timed out, 4 disconnected.
• GemFormattedProgramVerificationNegotiationOptions.MaxHistory .NET Property — The number of completed transaction identities the endpoint remembers to reject a replayed reply or a repeated response; the oldest is forgotten when full. Must be nonzero.
• GemFormattedProgramVerificationNegotiationOptions.MaxIssueTextBytes .NET Property — The longest issue text (ERRW7), in bytes.
• GemFormattedProgramVerificationNegotiationOptions.MaxIssues .NET Property — The largest number of issues in the S7F27 report of one prepared negotiation.
• GemFormattedProgramVerificationNegotiationOptions.MaxPending .NET Property — The largest number of submitted negotiations that wait for their S7F30 grant or S7F28 acknowledgement; a further submit fails with PdcommStatus.LimitExceeded. Must be nonzero.
• GemFormattedProgramVerificationNegotiationOptions.MaxPrepared .NET Property — The largest number of negotiations the equipment holds after GemFormattedPrograms.PrepareVerification until they end by acknowledgement, denial, timeout, disconnection or a malformed reply; a further prepare fails with PdcommStatus.LimitExceeded. Must be nonzero.
• GemFormattedProgramVerificationNegotiationOptions.MaxReceived .NET Property — The largest number of received primaries that wait for this endpoint's response; a further primary is reported as an GemResultKind.Unhandled result. Must be nonzero.
• GemFormattedProgramVerificationNegotiationOptions.MaxResults .NET Property — The number of completed negotiations the endpoint retains; the oldest is discarded when full. Must be nonzero.
• GemFormattedProgramVerificationNegotiationOptions.MaxTotalIssueTextBytes .NET Property — The largest total length, in bytes, of all issue texts of one report.
• GemFormattedProgramVerificationRequestInfo.Acknowledgement .NET Property — The ACKC7 code (0 to 7) that was received or sent; meaningful when GemFormattedProgramVerificationRequestInfo.AcknowledgementPresent is 1.
• GemFormattedProgramVerificationRequestInfo.AcknowledgementPresent .NET Property — Whether GemFormattedProgramVerificationRequestInfo.Acknowledgement holds a received or sent ACKC7 code.
• GemFormattedProgramVerificationRequestInfo.CommandCount .NET Property — The number of commands in the received program; 0 on an acknowledgement result.
• GemFormattedProgramVerificationRequestInfo.IdFormat .NET Property — The SECS-II format code of the received PPID: 16 (SecsFormat.Ascii) or 8 (SecsFormat.Binary). 0 on an acknowledgement result.
• GemFormattedProgramVerificationRequestInfo.IsRequest .NET Property — Whether the result is a received S7F31 that this equipment answers.
• GemFormattedProgramVerificationRequestInfo.ReplyReady .NET Property — Whether a received S7F31 still waits for GemFormattedPrograms.RespondVerificationRequest.
• GemFormattedProgramVerificationRequestInfo.RequestKind .NET Property — The request kind 38 (GemRequestKind.FormattedVerificationRequest).
• GemFormattedProgramVerificationRequestInfo.Responded .NET Property — Whether the S7F32 was sent by this equipment or received by this host.
• GemFormattedProgramVerificationRequestOptions.MaxCommands .NET Property — The largest number of commands in one process program that is sent or received in S7F31.
• GemFormattedProgramVerificationRequestOptions.MaxHistory .NET Property — The number of completed transaction identities the endpoint remembers to reject a replayed reply or a repeated response; the oldest is forgotten when full. Must be nonzero.
• GemFormattedProgramVerificationRequestOptions.MaxParametersPerCommand .NET Property — The largest number of parameters (PPARM) in one command.
• GemFormattedProgramVerificationRequestOptions.MaxPending .NET Property — The largest number of primaries this endpoint sent that still wait for their reply; a further send fails with PdcommStatus.LimitExceeded. Must be nonzero.
• GemFormattedProgramVerificationRequestOptions.MaxReceived .NET Property — The largest number of received primaries that wait for this endpoint's response; a further primary is reported as an GemResultKind.Unhandled result. Must be nonzero.
• GemFormattedProgramVerificationRequestOptions.MaxResults .NET Property — The number of completed transactions the endpoint retains; the oldest is discarded when full. Must be nonzero.
• GemFormattedProgramVerificationRequestOptions.MaxTotalParameterBytes .NET Property — The largest total encoded size, in bytes, of all parameters of one process program.
• GemFormattedProgramVerificationRequestOptions.MaxTotalParameters .NET Property — The largest number of parameters across all commands of one process program.
• GemHostOptions.ItemLimits .NET Property — Gets the SECS-II limits applied to GEM messages and to the data kept in each GemResult.
• GemHostOptions.MaxPendingIds .NET Property — Gets the maximum number of requested IDs that pending host requests can hold at once.
• GemLinkSpec.EventId .NET Property — The collection event ID (CEID).
• GemLinkSpec.ReportIds .NET Property — The report IDs (RPTIDs) to link to the event. An empty list asks the equipment to unlink all reports from the event.
• GemProgramConfiguration.InitialPrograms .NET Property — The programs to store in order with GemEquipment.PutProgram after the store is opened. With a storage file that already holds a PPID, GemProgramPutMode.Create fails and stops the startup.
• GemProgramConfiguration.Options .NET Property — The store limits and grant policy.
• GemProgramConfiguration.Path .NET Property — The storage file path, or null or empty to keep the store in memory; see GemEquipment.ConfigurePrograms.
• GemProgramDefinition.Body .NET Property — The process program body (PPBODY): an ASCII, binary, I1 to I8 or U1 to U8 item, which may be empty. Its format and raw bytes are preserved.
• GemProgramDefinition.Id .NET Property — The process program ID (PPID): a nonempty ASCII or binary item of at most GemProgramOptions.MaxIdentifierBytes and 120 bytes. The format is part of the identity.
• GemProgramDefinition.Mode .NET Property — How the program is stored when its PPID already exists.
• GemProgramEntry.Body .NET Property — Gets the process program body (PPBODY).
• GemProgramEntry.Id .NET Property — Gets the process program ID (PPID).
• GemProgramInfo.Acknowledgement .NET Property — PPGNT for S7F1/S7F2 or ACKC7 for S7F3/S7F4 and S7F17/S7F18: the code received in a reply, or the code prepared for a received request; null when there is none.
• GemProgramInfo.Applied .NET Property — Whether a received S7F3 or S7F17 request changed the local store.
• GemProgramInfo.ConfirmationRequired .NET Property — Whether the installation is unconfirmed and the reply is held until GemEquipment.ConfirmProgramReply accepts the uncertainty.
• GemProgramInfo.DeclaredLength .NET Property — The body length (LENGTH) declared by a received S7F1 request; otherwise 0.
• GemProgramInfo.Durability .NET Property — How durably a received S7F3 or S7F17 request was installed by GemEquipment.RespondProgram; GemProgramDurability.None for replies and before a change is installed.
• GemProgramInfo.GrantActivated .NET Property — Whether the reply to a received S7F1 activated a grant. It reports the original activation, not whether the grant is still outstanding.
• GemProgramInfo.IdCount .NET Property — The number of PPIDs: 1 for S7F1, S7F3 and S7F5 requests, the selection size of an S7F17 request (0 means all), 0 for S7F19; 1 for an S7F6 reply with a program and 0 for an unknown program; the directory length of an S7F20 reply; 0 for acknowledgement replies.
• GemProgramInfo.IsRequest .NET Property — true for a received primary; false for a reply.
• GemProgramInfo.PersistenceStatus .NET Property — The numeric PdcommStatus of the persistence failure that left the installation unconfirmed; otherwise 0.
• GemProgramInfo.ReplyReady .NET Property — Whether a prepared reply is waiting to be sent; call GemEquipment.RespondProgram again with the same mode and decision to send it without writing again.
• GemProgramInfo.RequestKind .NET Property — The transaction, from GemRequestKind.ProgramGrant to GemRequestKind.ProgramDirectory.
• GemProgramInfo.Responded .NET Property — Whether the reply to a received primary was sent.
• GemProgramOptions.GrantPolicy .NET Property — Gets whether a received S7F3 needs an earlier S7F1 grant.
• GemProgramOptions.MaxBodyBytes .NET Property — Gets the maximum payload length in bytes of one process program body (PPBODY).
• GemProgramOptions.MaxGrants .NET Property — Gets the maximum number of S7F1 grants that can be outstanding at once; further S7F1 requests are answered with PPGNT 4 (busy).
• GemProgramOptions.MaxIdentifierBytes .NET Property — Gets the maximum length in bytes of one PPID; the effective limit is never more than 120 bytes.
• GemProgramOptions.MaxPendingIdentifierBytes .NET Property — Gets the maximum total PPID bytes that pending outgoing program requests can hold at once.
• GemProgramOptions.MaxPendingIds .NET Property — Gets the maximum number of PPIDs that pending outgoing S7F1, S7F3, S7F5 and S7F17 requests can hold at once.
• GemProgramOptions.MaxPrograms .NET Property — Gets the maximum number of process programs in the store.
• GemProgramOptions.MaxRequestIds .NET Property — Gets the maximum number of PPIDs in one delete selection: a local delete or an S7F17 request.
• GemProgramOptions.MaxReservedBodyBytes .NET Property — Gets the maximum total body length (LENGTH) that outstanding grants can reserve; a request beyond it is answered with PPGNT 4 (busy).
• GemProgramOptions.MaxSerializedBytes .NET Property — Gets the maximum size in bytes of the storage file; used only when the store has a storage path.
• GemProgramOptions.MaxTotalBodyBytes .NET Property — Gets the maximum total payload bytes of all process program bodies in the store.
• GemProgramOptions.MaxTotalIdentifierBytes .NET Property — Gets the maximum total bytes of all PPIDs in the store.
• GemProgramState.BodyBytes .NET Property — The total payload bytes of all stored bodies.
• GemProgramState.GrantCount .NET Property — The number of outstanding S7F1 grants.
• GemProgramState.IdentifierBytes .NET Property — The total bytes of all stored PPIDs.
• GemProgramState.Persistent .NET Property — Whether the store is backed by a storage file.
• GemProgramState.ProgramCount .NET Property — The number of stored programs.
• GemProgramState.ReservedBodyBytes .NET Property — The total body length reserved by outstanding grants.
• GemProgramWriteInfo.Applied .NET Property — Whether the create, replace or delete was installed in the store.
• GemProgramWriteInfo.Durability .NET Property — How durably the change was installed: GemProgramDurability.Volatile, GemProgramDurability.Synced or GemProgramDurability.Unconfirmed.
• GemProgramWriteInfo.PersistenceStatus .NET Property — The numeric PdcommStatus of the persistence failure when Durability is GemProgramDurability.Unconfirmed; otherwise 0.
• GemQueryInfo.DataId .NET Property — The data ID (DATAID) of an S6F16 reply; zero otherwise.
• GemQueryInfo.DataIdPresent .NET Property — true when DataId came from an S6F16 reply.
• GemQueryInfo.Id .NET Property — The requested ID: the CEID for GemReportQueryKind.Event, otherwise the RPTID.
• GemQueryInfo.IsRequest .NET Property — true when the result is a query request received by equipment.
• GemQueryInfo.Kind .NET Property — The query transaction.
• GemQueryInfo.ReportCount .NET Property — The number of reports in an S6F16 reply; zero otherwise.
• GemQueryInfo.Responded .NET Property — true when the received request has been answered successfully.
• GemQueryInfo.ValueCount .NET Property — The number of values: the total across all reports for S6F16, the value count for S6F20 and S6F22, and zero for a received request.
• GemQueryReportInfo.Id .NET Property — The report ID (RPTID).
• GemQueryReportInfo.ValueCount .NET Property — The number of values in the report.
• GemQueryValue.Value .NET Property — Gets the variable value (V).
• GemQueryValue.VariableId .NET Property — Gets the variable ID (VID) of an S6F22 annotated value, or null for S6F16 and S6F20 values, which carry no VID.
• GemReportBinding.ConstantId .NET Property — For GemDataSourceKind.Constant, the equipment constant ID (ECID) as an ASCII item or a single-element integer item; otherwise null. The configuring call copies the item; the caller keeps ownership.
• GemReportBinding.SourceId .NET Property — The status variable ID or data variable ID; must be 0 for GemDataSourceKind.Constant.
• GemReportBinding.SourceKind .NET Property — The kind of value source.
• GemReportBinding.Vid .NET Property — The variable ID (VID) used in report definitions.
• GemReportBindingEntry.ConstantId .NET Property — Gets a copy of the equipment constant ID for GemDataSourceKind.Constant, or null for other sources. Integer IDs can come back as I8 or U8 items. The entry owns the item.
• GemReportBindingEntry.SourceId .NET Property — Gets the status variable ID or data variable ID; 0 for GemDataSourceKind.Constant.
• GemReportBindingEntry.SourceKind .NET Property — Gets the kind of value source.
• GemReportBindingEntry.Vid .NET Property — Gets the variable ID (VID).
• GemReportConfiguration.EventIds .NET Property — The collection event IDs (CEIDs) to register. The worker copies them when it is started.
• GemReportConfiguration.Options .NET Property — The capacity limits of the report store.
• GemReportDefinition.Id .NET Property — The report ID (RPTID).
• GemReportDefinition.VariableIds .NET Property — The variable IDs (VIDs) of the report in report order.
• GemReportOptions.MaxEvents .NET Property — Gets the maximum number of collection events (CEIDs) that the store can register.
• GemReportOptions.MaxReports .NET Property — Gets the maximum number of defined reports (RPTIDs).
• GemReportOptions.MaxReportsPerEvent .NET Property — Gets the maximum number of reports linked to one collection event.
• GemReportOptions.MaxTotalLinks .NET Property — Gets the maximum number of event-to-report links across all collection events.
• GemReportOptions.MaxTotalVariables .NET Property — Gets the maximum number of variable IDs across all defined reports.
• GemReportOptions.MaxVariablesPerReport .NET Property — Gets the maximum number of variable IDs (VIDs) in one report.
• GemReportSpec.Id .NET Property — The report ID (RPTID).
• GemReportSpec.VariableIds .NET Property — The variable IDs (VIDs) of the report in report order. An empty list asks the equipment to delete the report.
• GemReportState.EventCount .NET Property — The number of registered collection events.
• GemReportState.ReportCount .NET Property — The number of defined reports.
• GemReportState.TotalLinks .NET Property — The number of event-to-report links across all collection events.
• GemReportState.TotalVariables .NET Property — The number of variable IDs across all defined reports.
• GemResultInfo.Acknowledgement .NET Property — The SEMI acknowledgement code carried or sent with the message (for example COMMACK, ONLACK or ACKC5), or null when the outcome has none.
• GemResultInfo.Code .NET Property — The failure detail: an HsmsFailureReason value or GemError.Aborted for GemResultKind.Failed, a GemError value for GemResultKind.InvalidResponse and GemResultKind.Unhandled, and zero otherwise.
• GemResultInfo.EntryCount .NET Property — The number of entries in the result, such as status values or names, report query reports or values, alarms, command parameters or program IDs; zero when the result has no entries.
• GemResultInfo.Kind .NET Property — How the transport event was processed.
• GemResultInfo.Outcome .NET Property — What GEM processing concluded.
• GemResultInfo.ReplySent .NET Property — true when GEM processing sent a reply to the received primary.
• GemResultInfo.RequestKind .NET Property — The GEM transaction the result belongs to; zero when the result is not tied to a known transaction.
• GemResultInfo.State .NET Property — The GEM state of the endpoint after the event was processed.
• GemResultInfo.Token .NET Property — The HSMS token of the request or of the received primary.
• GemSpoolEntry.Body .NET Property — Gets a copy of the message body, or null for a header-only message.
• GemSpoolEntry.Info .NET Property — Gets the entry header.
• GemSpoolEntryInfo.BodyPresent .NET Property — true when the message has a body; false for a header-only message.
• GemSpoolEntryInfo.EntryId .NET Property — The entry ID, unique within the spool.
• GemSpoolEntryInfo.Function .NET Property — The function of the stored primary message.
• GemSpoolEntryInfo.ReplyExpected .NET Property — true when the message is delivered with the W-bit set.
• GemSpoolEntryInfo.Stream .NET Property — The stream of the stored primary message.
• GemSpoolHostOptions.MaxFunctionsPerStream .NET Property — Gets the maximum number of functions for one stream in a request or reply.
• GemSpoolHostOptions.MaxPendingItems .NET Property — Gets the maximum number of streams plus functions in one S2F43 request, which also bounds the total number of functions in a received S2F44 or S2F60.
• GemSpoolHostOptions.MaxStreams .NET Property — Gets the maximum number of streams in an S2F43 request and in a received S2F44 or S2F60.
• GemSpoolInfo.Acknowledgement .NET Property — The acknowledgement code: RSPACK of a received S2F44, RSDA of a received S6F24, ACKC5 or ACKC6 of the reply to a delivered S5F1 or S6F11, or the code of the reply that the equipment prepared; null when there is none.
• GemSpoolInfo.Applied .NET Property — true when the last operation on this result installed a spool change.
• GemSpoolInfo.Command .NET Property — The RSDC of the S6F23 request for GemRequestKind.SpoolControl; GemSpoolCommand.Transmit (0) for other kinds.
• GemSpoolInfo.ConfirmationRequired .NET Property — true when the request was applied with unconfirmed persistence and its reply is held until GemEquipment.ConfirmSpoolReply.
• GemSpoolInfo.DeliveryAttempt .NET Property — The attempt number of the delivery for a delivery result; otherwise 0.
• GemSpoolInfo.DeliveryCompleted .NET Property — true when GemEquipment.CompleteSpoolDelivery accepted this delivery result.
• GemSpoolInfo.DeliveryProof .NET Property — The delivery evidence of a delivery result.
• GemSpoolInfo.DequeuePending .NET Property — true when success was accepted but removing the entry failed; call GemEquipment.RetrySpoolDequeue.
• GemSpoolInfo.Durability .NET Property — How durably the change applied through this result was stored.
• GemSpoolInfo.EntryId .NET Property — The ID of the delivered entry for a delivery result; otherwise 0.
• GemSpoolInfo.ErrorCount .NET Property — The number of stream errors in an S2F44 received by the host.
• GemSpoolInfo.IsRequest .NET Property — true for an S2F43, S2F59 or S6F23 request received by the equipment.
• GemSpoolInfo.PersistenceStatus .NET Property — The PdcommStatus value of the last persistence failure on this result, which stays visible after GemEquipment.ConfirmSpoolReply; otherwise 0.
• GemSpoolInfo.ReplyReady .NET Property — true when a prepared reply is retained and GemEquipment.RespondSpool sends it without applying the request again.
• GemSpoolInfo.RequestKind .NET Property — GemRequestKind.SpoolConfigure, GemRequestKind.SpoolQuery, GemRequestKind.SpoolControl or GemRequestKind.SpoolDelivery.
• GemSpoolInfo.Responded .NET Property — true when the reply to the request has been sent.
• GemSpoolInfo.SelectionCount .NET Property — The number of stream selections in an S2F43 received by the equipment or in an S2F60 received by the host.
• GemSpoolInfo.SuccessAccepted .NET Property — true when success was accepted for this delivery result.
• GemSpoolMessageKey.Function .NET Property — The function of a primary message, an odd number.
• GemSpoolMessageKey.Stream .NET Property — The stream, 2 to 127; stream 1 cannot be spooled.
• GemSpoolOptions.MaxBodyBytes .NET Property — Gets the maximum encoded body size, in bytes, of one stored message.
• GemSpoolOptions.MaxCatalogEntries .NET Property — Gets the maximum number of catalog entries, which also bounds the total number of functions in a received S2F43.
• GemSpoolOptions.MaxFunctionsPerStream .NET Property — Gets the maximum number of functions in one stream selection.
• GemSpoolOptions.MaxMessages .NET Property — Gets the maximum number of stored entries.
• GemSpoolOptions.MaxSerializedBytes .NET Property — Gets the maximum size, in bytes, of the snapshot file of a file-backed spool; at least 144. An in-memory spool ignores it.
• GemSpoolOptions.MaxStreams .NET Property — Gets the maximum number of stream selections in the local configuration or in a received S2F43.
• GemSpoolOptions.MaxTotalBodyBytes .NET Property — Gets the maximum total encoded body size, in bytes, of all stored messages.
• GemSpoolPolicy.Enabled .NET Property — Gets a value that indicates whether spooling may activate; it is independent of the stream selection.
• GemSpoolPolicy.MaxTransmit .NET Property — Gets the maximum number of entries delivered in one transmission run, or 0 for no limit; the run ends when it is reached.
• GemSpoolPolicy.Overflow .NET Property — Gets what happens to a new message when the spool is full.
• GemSpoolResultError.Acknowledgement .NET Property — Gets the stream acknowledgement (STRACK), 1 to 4: 1 spooling is not allowed for the stream, 2 the stream is unknown, 3 a function is unknown for the stream, 4 a secondary function was specified.
• GemSpoolResultError.Functions .NET Property — Gets the functions reported with the error as a SecsFormat.U1 array.
• GemSpoolResultError.Stream .NET Property — Gets the rejected stream.
• GemSpoolResultSelection.Functions .NET Property — Gets the selected functions as a SecsFormat.U1 array; an empty array selects every function of the stream.
• GemSpoolResultSelection.Stream .NET Property — Gets the stream.
• GemSpoolSelection.Functions .NET Property — The selected primary functions, without repetition; empty to select every function of the stream. Values that PDComm returns own a new array.
• GemSpoolSelection.Stream .NET Property — The stream.
• GemSpoolState.Active .NET Property — true while spooling is active. It ends when the spool is emptied by delivery or purge, or when spooling is disabled while the spool is empty.
• GemSpoolState.BodyBytes .NET Property — The total encoded body size, in bytes, of the stored entries.
• GemSpoolState.CatalogCount .NET Property — The number of catalog entries.
• GemSpoolState.Connected .NET Property — true when the last synchronization saw the transport selected and GEM communicating.
• GemSpoolState.DeliveryPending .NET Property — true while an entry is in flight or its successful delivery awaits removal.
• GemSpoolState.DequeuePending .NET Property — true when a delivery succeeded but removing the entry failed; call GemEquipment.RetrySpoolDequeue.
• GemSpoolState.Discarded .NET Property — The number of messages discarded because the spool was full, including old entries overwritten by GemSpoolOverflow.OverwriteOldest.
• GemSpoolState.Enabled .NET Property — true when the local policy enables spooling.
• GemSpoolState.FullTime .NET Property — The time the spool first became full during the current activation; valid when FullTimePresent is true.
• GemSpoolState.FullTimePresent .NET Property — true when FullTime is set.
• GemSpoolState.MaxTransmit .NET Property — The maximum number of entries per transmission run, or 0 for no limit.
• GemSpoolState.MessageCount .NET Property — The number of stored entries.
• GemSpoolState.NextId .NET Property — The entry ID that the next stored message receives.
• GemSpoolState.Overflow .NET Property — The overflow policy.
• GemSpoolState.Persistent .NET Property — true when the spool is backed by a snapshot file.
• GemSpoolState.Received .NET Property — The number of selected messages offered to the spool, stored or discarded.
• GemSpoolState.SelectionCount .NET Property — The number of stream selections.
• GemSpoolState.StartTime .NET Property — The time spooling activated or stored its first entry; valid when StartTimePresent is true.
• GemSpoolState.StartTimePresent .NET Property — true when StartTime is set.
• GemSpoolState.Stored .NET Property — The number of messages stored.
• GemSpoolState.Synchronized .NET Property — true when the last GemEquipment.SyncSpool still matches the current communication and selection state, so captures, replies and deliveries are allowed.
• GemSpoolState.Transmitted .NET Property — The number of entries removed after a successful delivery.
• GemSpoolState.TransmittedInRun .NET Property — The number of entries removed during the current transmission run.
• GemSpoolState.Transmitting .NET Property — true while a transmission run accepted with S6F23 is in progress.
• GemSpoolWriteResult.AffectedCount .NET Property — The number of entries overwritten by a capture, removed by a purge, or 1 for a dequeue; otherwise 0.
• GemSpoolWriteResult.Applied .NET Property — true when a change was installed.
• GemSpoolWriteResult.Durability .NET Property — How durably the change was stored.
• GemSpoolWriteResult.EntryId .NET Property — The ID of the captured or removed entry; otherwise 0.
• GemSpoolWriteResult.Mutation .NET Property — The change that was installed.
• GemSpoolWriteResult.PersistenceStatus .NET Property — The PdcommStatus value of the persistence failure when Durability is GemSpoolDurability.Unconfirmed; otherwise 0.
• GemSpoolWriteResult.Selected .NET Property — true when a change was installed; false when a captured message was not selected for spooling.
• GemSpoolWriteResult.Status .NET Property — PdcommStatus.Ok, or PdcommStatus.SpoolUnconfirmed when the change was installed but its persistence could not be confirmed. Other statuses are thrown as PdcommException.
• GemState.Communication .NET Property — The GEM communication state.
• GemState.Control .NET Property — The equipment control state, or null for a host.
• GemState.EndpointId .NET Property — The process-unique ID of the underlying HSMS endpoint.
• GemState.Generation .NET Property — The connection generation of the underlying HSMS endpoint.
• GemState.OnlineMode .NET Property — The equipment on-line mode, or null for a host.
• GemState.PendingCount .NET Property — The number of GEM requests waiting for a reply (at most 32).
• GemState.PendingIds .NET Property — The number of requested IDs held by the pending requests.
• GemState.Role .NET Property — The role of the endpoint.
• GemState.VariableCount .NET Property — The number of registered status variables; zero for a host.
• GemStatusName.Id .NET Property — The status variable ID (SVID).
• GemStatusName.Name .NET Property — The status variable name (SVNAME); a GemEquipment reports an empty name for an unknown ID.
• GemStatusName.Units .NET Property — The units (UNITS); a GemEquipment reports empty units for an unknown ID.
• GemStatusValue.Id .NET Property — Gets the requested status variable ID (SVID), or null when all values were requested, because an all-values reply carries no IDs.
• GemStatusValue.Value .NET Property — Gets the status variable value. A GemEquipment answers an unknown ID with an empty list, but an empty list alone does not prove that the ID is unknown.
• GemStatusVariable.Id .NET Property — The status variable ID (SVID).
• GemStatusVariable.Name .NET Property — The status variable name (SVNAME); ASCII only.
• GemStatusVariable.Units .NET Property — The units (UNITS); ASCII only, may be empty.
• GemStatusVariable.Value .NET Property — The initial value. The worker encodes it while the start method runs, so the caller keeps ownership and may dispose it after the start method returns.
• GemWorker.Completion .NET Property — Gets a task that completes when the worker thread exits.
• GemWorker.FormattedPrograms .NET Property — Gets the asynchronous formatted process program operations of this worker.
• GemWorker.LocalAddress .NET Property — Gets the numeric local socket address while the transport is listening or connected, or null otherwise.
• HsmsEventInfo.Aborted .NET Property — Whether a received reply is an abort (function 0) instead of a normal reply.
• HsmsEventInfo.BodyLength .NET Property — The size of the received message body, in bytes; zero when there is none.
• HsmsEventInfo.Code .NET Property — The failure reason, protocol error or failed socket operation, depending on Kind.
• HsmsEventInfo.Detail .NET Property — The frame error of an invalid frame, or the I/O error kind of a transport error.
• HsmsEventInfo.FromState .NET Property — For HsmsEventKind.StateChanged, the previous connection state.
• HsmsEventInfo.Header .NET Property — The message header, or null when the event has none.
• HsmsEventInfo.IsReply .NET Property — Whether a received message is the reply to one of this endpoint's requests.
• HsmsEventInfo.Kind .NET Property — The event kind.
• HsmsEventInfo.ToState .NET Property — For HsmsEventKind.StateChanged, the new connection state.
• HsmsEventInfo.Token .NET Property — The transaction the event belongs to: the request for a reply or failure, or the received primary's system bytes. Zero for state changes.
• HsmsEventInfo.Value1 .NET Property — The first kind-specific value, for example a required size or a rejected message type.
• HsmsEventInfo.Value2 .NET Property — The second kind-specific value, for example a limit or a reject reason.
• HsmsHeader.Function .NET Property — The SECS-II function number.
• HsmsHeader.PType .NET Property — The presentation type; 0 for SECS-II.
• HsmsHeader.ReplyExpected .NET Property — Whether the W bit is set, meaning the sender expects a reply.
• HsmsHeader.SType .NET Property — The session type; 0 for a data message.
• HsmsHeader.SessionId .NET Property — The session ID (device ID).
• HsmsHeader.Stream .NET Property — The SECS-II stream number, without the W bit.
• HsmsOptions.ConnectTimeoutMilliseconds .NET Property — Gets the TCP connect timeout of an active endpoint, in milliseconds. HsmsEndpoint.Poll can block for up to this long during a connection attempt.
• HsmsOptions.InitialSystemBytes .NET Property — Gets the first system bytes value this endpoint uses for its own requests.
• HsmsOptions.ItemLimits .NET Property — Gets the limits applied to SECS-II message bodies.
• HsmsOptions.MaxApplicationBytes .NET Property — Gets the largest total body size, in bytes, of events waiting for HsmsEndpoint.NextEvent.
• HsmsOptions.MaxApplicationEvents .NET Property — Gets the capacity of the queue of events waiting for HsmsEndpoint.NextEvent.
• HsmsOptions.MaxEvents .NET Property — Gets the capacity of the session's internal event queue; at least 72.
• HsmsOptions.MaxFrameBytes .NET Property — Gets the largest frame, in bytes, that the endpoint sends or accepts, including the 14 framing bytes.
• HsmsOptions.MaxIoChunk .NET Property — Gets the largest number of bytes read or written by one socket call.
• HsmsOptions.MaxQueuedBytes .NET Property — Gets the largest total body size, in bytes, held in the session's internal event queue.
• HsmsOptions.MaxWriteBytes .NET Property — Gets the largest total size, in bytes, of frames waiting to be written.
• HsmsOptions.MaxWriteFrames .NET Property — Gets the largest number of frames waiting to be written.
• HsmsOptions.Mode .NET Property — Gets whether the endpoint connects (HsmsMode.Active) or listens (HsmsMode.Passive).
• HsmsOptions.PollBudget .NET Property — Gets the largest number of internal actions one HsmsEndpoint.Poll performs.
• HsmsOptions.SessionId .NET Property — Gets the HSMS session ID (device ID) carried in data message headers.
• HsmsOptions.ShutdownTimeoutMilliseconds .NET Property — Gets how long a stop may take to close the connection gracefully, in milliseconds.
• HsmsOptions.T3Milliseconds .NET Property — Gets the T3 reply timeout, in milliseconds: how long a request waits for its reply.
• HsmsOptions.T5Milliseconds .NET Property — Gets the T5 connect separation timeout, in milliseconds: the wait before an active endpoint reconnects.
• HsmsOptions.T6Milliseconds .NET Property — Gets the T6 control transaction timeout, in milliseconds: how long Select, Deselect or Linktest waits.
• HsmsOptions.T7Milliseconds .NET Property — Gets the T7 not-selected timeout, in milliseconds: how long a connection may stay not selected.
• HsmsOptions.T8Milliseconds .NET Property — Gets the T8 network intercharacter timeout, in milliseconds, between bytes of one frame.
• HsmsOptions.WriteTimeoutMilliseconds .NET Property — Gets how long a frame write may stall before the connection is treated as failed, in milliseconds.
• HsmsState.Closed .NET Property — Whether the endpoint has fully closed after a stop. Closed does not mean that every event has been read.
• HsmsState.EndpointId .NET Property — The process-local identity of the endpoint.
• HsmsState.Generation .NET Property — The current connection generation.
• HsmsState.State .NET Property — The connection state.
• HsmsToken.EndpointId .NET Property — The process-local identity of the endpoint.
• HsmsToken.Generation .NET Property — The connection generation in which the transaction was started.
• HsmsToken.SystemBytes .NET Property — The system bytes (transaction ID) in the message header.
• HsmsWorker.Completion .NET Property — Gets a task that completes when the worker thread has exited and released the endpoint.
• HsmsWorker.LocalAddress .NET Property — Gets the endpoint's local socket address while it is listening or connected, or null otherwise.
• HsmsWorkerOptions.CommandCapacity .NET Property — Gets the largest number of commands waiting to run on the worker thread; also the most commands run per loop.
• HsmsWorkerOptions.EventCapacity .NET Property — Gets the largest number of events buffered for ReadEventsAsync; also the most native events read per loop.
• HsmsWorkerOptions.MaxCommandBytes .NET Property — Gets the largest total size, in bytes, of the inputs (message bodies and captured values) of waiting commands.
• HsmsWorkerOptions.MaxEventBytes .NET Property — Gets the largest total size, in bytes, of the events buffered for ReadEventsAsync.
• HsmsWorkerOptions.PollIntervalMilliseconds .NET Property — Gets the longest time, in milliseconds, the worker sleeps between polls; it wakes earlier when work arrives.
• HsmsWorkerOptions.ShutdownTimeoutMilliseconds .NET Property — Gets how long, in milliseconds, the worker may take to close the connection and drain after a stop or disposal before it fails with TimeoutException.
• Secs1Event.DiscardedPartial .NET Property — For a fault, whether a partially received message was discarded.
• Secs1Event.FaultDetail .NET Property — For an I/O fault, the Secs1IoStatus value of the failure; zero otherwise.
• Secs1Event.FaultKind .NET Property — For a fault, its kind: 1 I/O error, 3 stream closed, 4 line protocol error, 5 invalid block, 6 reassembly error (2, an unknown control character, is no longer produced). Zero otherwise.
• Secs1Event.Kind .NET Property — The event kind.
• Secs1Event.Message .NET Property — For Secs1EventKind.Inbound, the received message with its body copied into managed memory. For other kinds, a placeholder with zero fields and an empty body.
• Secs1Event.Token .NET Property — The submitted message that the event settles, for Secs1EventKind.OutboundComplete, Secs1EventKind.OutboundFailed, and a Secs1EventKind.Fault that aborted a send; zero otherwise.
• Secs1IoResult.Count .NET Property — For Secs1IoStatus.Ok, the number of bytes read or written; it must not exceed the buffer length. Ignored for other statuses.
• Secs1IoResult.Status .NET Property — The outcome of the operation.
• Secs1Message.Body .NET Property — The message text, normally one encoded SECS-II item; split into blocks of up to 244 bytes on the wire. May be empty.
• Secs1Message.DeviceId .NET Property — The device ID (0 to 32767).
• Secs1Message.Direction .NET Property — The direction bit of the message.
• Secs1Message.Function .NET Property — The SECS-II function number.
• Secs1Message.ReplyExpected .NET Property — Whether the W bit is set, meaning the sender expects a reply.
• Secs1Message.Stream .NET Property — The SECS-II stream number (0 to 127).
• Secs1Message.SystemBytes .NET Property — The system bytes (transaction ID); the application chooses them for its own messages.
• Secs1Options.AckWaitTicks .NET Property — The T2 protocol timeout for a reply to this endpoint: the ACK or NAK after a sent block and the length character after a sent EOT, in ticks.
• Secs1Options.GrantWaitTicks .NET Property — The T2 protocol timeout for the EOT that answers this endpoint's ENQ, in ticks.
• Secs1Options.InboundProgressTicks .NET Property — The T1 inter-character timeout while a block is being received, in ticks.
• Secs1Options.InterBlockTicks .NET Property — The T4 inter-block timeout between the blocks of a multi-block message being received, in ticks.
• Secs1Options.MaxBlocks .NET Property — The largest number of blocks in one message that the endpoint sends or reassembles.
• Secs1Options.MaxBodyBytes .NET Property — The largest message body, in bytes, that the endpoint sends or reassembles.
• Secs1Options.MaxEventBodyBytes .NET Property — The largest total body size, in bytes, of the queued events.
• Secs1Options.MaxEvents .NET Property — The largest number of events the endpoint queues before it applies backpressure.
• Secs1Options.MaxIoChunk .NET Property — The largest number of bytes passed to one read or write callback.
• Secs1Options.MaxOutboundBlocks .NET Property — The largest number of blocks accepted for one submitted message.
• Secs1Options.MaxOutboundBodyBytes .NET Property — The largest body, in bytes, accepted for one submitted message.
• Secs1Options.PollBudget .NET Property — The largest number of I/O attempts one native poll makes.
• Secs1Options.Priority .NET Property — The line contention priority: 0 (Secs1Priority.Master) keeps sending when both sides bid for the line, 1 (Secs1Priority.Slave) yields. Other values are rejected.
• Secs1Options.RetryLimit .NET Property — The retry limit (RTY): how many times the endpoint restarts the ENQ handshake for a block that was not acknowledged before it reports the send as failed.
• Secs1State.EndpointId .NET Property — The process-local identity of the endpoint.
• Secs1State.Faulted .NET Property — Whether the line has faulted; the endpoint stops polling until Secs1Worker.ResetAsync clears the fault.
• Secs1State.Generation .NET Property — The endpoint generation; every restart after a stop starts a new generation.
• Secs1State.Poisoned .NET Property — Whether an internal failure poisoned the endpoint; it then only accepts destruction.
• Secs1State.Started .NET Property — Whether the endpoint has been started and not stopped since.
• Secs1State.Stopped .NET Property — Whether the endpoint has been stopped; a stop discards the runtime state.
• Secs1Token.EndpointId .NET Property — The process-local identity of the endpoint that accepted the message.
• Secs1Token.Generation .NET Property — The endpoint generation; every restart after a stop starts a new generation.
• Secs1Token.Value .NET Property — The sequence number of the message within the generation; zero when no message is involved.
• Secs1Worker.CallbackException .NET Property — Gets the most recent exception thrown by a read or write callback, or null if none was thrown.
• Secs1Worker.Completion .NET Property — Gets a task that completes when the worker thread has exited, or faults with the error that ended it.
• Secs1WorkerOptions.CommandCapacity .NET Property — The largest number of commands waiting to run; must be positive.
• Secs1WorkerOptions.EventCapacity .NET Property — The largest number of events buffered for reading; must be positive.
• Secs1WorkerOptions.MaxCommandBytes .NET Property — The largest total body size, in bytes, of waiting submissions; must not be negative.
• Secs1WorkerOptions.MaxEventBytes .NET Property — The largest total body size, in bytes, of buffered events; must be at least Secs1Options.MaxBodyBytes.
• Secs1WorkerOptions.PollIntervalMilliseconds .NET Property — How long, in milliseconds, the worker sleeps after each loop; each loop runs at most one queued command. Must be positive.
• Secs1WorkerOptions.ShutdownTimeoutMilliseconds .NET Property — How long, in milliseconds, Secs1Worker.DisposeAsync waits for the worker thread; must be positive.
• SecsInfo.Count .NET Property — Gets the number of children of a list, or the number of values in a primitive (payload bytes divided by the format's element width).
• SecsInfo.Depth .NET Property — Gets the nesting depth of the tree; a primitive or an empty list has depth 1.
• SecsInfo.EncodedLength .NET Property — Gets the size of the complete encoded item, in bytes.
• SecsInfo.Format .NET Property — Gets the item's format.
• SecsInfo.NodeCount .NET Property — Gets the number of items in the tree, including this item.
• SecsLimits.ItemBytes .NET Property — Gets the largest payload of one primitive item, in bytes.
• SecsLimits.ItemCount .NET Property — Gets the largest number of items in the tree, counting every list and primitive.
• SecsLimits.MessageBytes .NET Property — Gets the largest complete encoded item, in bytes, including every header.
• SecsLimits.NestingDepth .NET Property — Gets the largest nesting depth; a single item has depth 1.
• Gem300Axis .NET Enum — The GEM300 object area that a capability belongs to.
• Gem300Capability .NET Class — One capability of a GEM300 capability profile.
• Gem300CapabilityCatalog .NET Class — A local, revisioned catalog of GEM300 capability profiles.
• Gem300CapabilityCatalogInfo .NET Class — Describes the contents of a GEM300 capability catalog or of a snapshot of it.
• Gem300CapabilityInfo .NET Class — Describes one capability of a GEM300 capability profile.
• Gem300CapabilityOptions .NET Class — Limits that bound the contents of a Gem300CapabilityCatalog.
• Gem300CapabilityProfile .NET Class — A named set of GEM300 capabilities, at most one per axis.
• Gem300CapabilityProfileInfo .NET Class — Describes one profile of a GEM300 capability snapshot.
• Gem300CapabilitySnapshot .NET Class — An immutable copy of a Gem300CapabilityCatalog at one revision.
• Gem300CatalogChange .NET Class — The outcome of a change to a Gem300CapabilityCatalog.
• Gem300Status .NET Enum — The status label that the application declares for one of its GEM300 capabilities.
• Gem300Verification .NET Enum — The verification label stored for a GEM300 capability.
• GemAlarmChange .NET Struct — Represents the result of GemEquipment.ObserveAlarm.
• GemAlarmConfiguration .NET Class — Represents the alarm store that GemEquipmentWorker installs on its equipment endpoint at startup.
• GemAlarmDefinition .NET Struct — Defines one equipment alarm for GemEquipment.ConfigureAlarms.
• GemAlarmEntry .NET Struct — Represents one configured equipment alarm together with its text.
• GemAlarmInfo .NET Struct — Represents the local state and metadata of one configured equipment alarm.
• GemAlarmOptions .NET Class — Represents the capacity limits of the equipment alarm store installed by GemEquipment.ConfigureAlarms.
• GemAlarmResultInfo .NET Struct — Describes an alarm report or alarm list carried by a host-side GemResult.
• GemAlarmState .NET Struct — Represents a snapshot of the counters of the configured equipment alarm store.
• GemAlarmValue .NET Struct — Represents one alarm entry received from the equipment together with its text.
• GemAlarmValueInfo .NET Struct — Represents the fields of one alarm entry received from the equipment.
• GemBindingOptions .NET Class — Represents the capacity limits of an equipment's report variable bindings.
• GemBindingState .NET Struct — Represents the current state of an equipment's report variable bindings.
• GemCommandArgument .NET Class — Represents one parameter name and value read from a received remote command request.
• GemCommandConfiguration .NET Class — Represents the remote command store that GemEquipmentWorker installs on its equipment endpoint at startup.
• GemCommandDecision .NET Enum — Specifies the application decision for a received remote command. The values mirror the host command acknowledge codes (HCACK).
• GemCommandDefinition .NET Class — Defines one remote command that the equipment validates on receipt.
• GemCommandEntry .NET Class — Represents one configured remote command and its name item.
• GemCommandError .NET Class — Represents one parameter acknowledgement of a remote command result.
• GemCommandInfo .NET Struct — Represents the metadata of one configured remote command.
• GemCommandIssue .NET Class — Represents one parameter acknowledgement that the equipment returns in an S2F42 reply.
• GemCommandOptions .NET Class — Represents the capacity limits of the equipment remote command store installed by GemEquipment.ConfigureCommands.
• GemCommandParameter .NET Class — Represents one parameter that the host sends with a remote command.
• GemCommandParameterDefinition .NET Class — Defines one parameter of a remote command definition.
• GemCommandParameterEntry .NET Class — Represents one configured remote command parameter and its name item.
• GemCommandParameterInfo .NET Struct — Represents the validation rules of one configured remote command parameter.
• GemCommandReply .NET Struct — Represents the S2F42 reply that the equipment sent for a remote command.
• GemCommandResultInfo .NET Struct — Describes a remote command request received by the equipment (S2F41) or a remote command reply received by the host (S2F42).
• GemCommandState .NET Struct — Represents a snapshot of the counters of the configured remote command store.
• GemCommunicationState .NET Enum — Represents the GEM communication state of an endpoint, driven by the S1F13/S1F14 Establish Communications transaction.
• GemConstantChange .NET Class — Represents one new value for an equipment constant in an S2F15 (New Equipment Constant Send) request.
• GemConstantChangeEntry .NET Class — Represents one ECID/ECV pair of a received S2F15 request and the value it would replace.
• GemConstantChangeInfo .NET Struct — Represents the processing state of an S2F15 request result or an S2F16 reply result.
• GemConstantConfiguration .NET Class — Represents the equipment constant store that GemEquipmentWorker installs on its equipment endpoint at startup.
• GemConstantDecision .NET Enum — The application decision for a received S2F15 request; the value is the EAC (equipment acknowledge code) sent in S2F16.
• GemConstantDefinition .NET Class — Represents one equipment constant to register with GemEquipment.ConfigureConstants.
• GemConstantEntry .NET Class — Represents one registered equipment constant returned by GemEquipment.GetConstantAt.
• GemConstantField .NET Enum — Selects one field of an equipment constant.
• GemConstantInfo .NET Struct — Represents the declared shape of one registered equipment constant.
• GemConstantOptions .NET Class — Configures the equipment constant store of a GemEquipment.
• GemConstantReply .NET Struct — Represents the S2F16 reply sent by GemEquipment.RespondConstants.
• GemConstantState .NET Struct — Represents the counters of the equipment constant store.
• GemConstantValue .NET Class — Represents one entry of an S2F14 (Equipment Constant Data) reply.
• GemControlState .NET Enum — Represents the GEM control state of an equipment endpoint.
• GemDataConfiguration .NET Class — Represents the data variables and optional report bindings that a GemEquipmentWorker configures when it starts.
• GemDataDefinition .NET Class — Represents the definition of one data variable in an equipment's data variable store.
• GemDataField .NET Enum — Specifies which field of a data variable GemEquipment.GetData returns.
• GemDataInfo .NET Struct — Represents the shape and cache state of one data variable.
• GemDataOptions .NET Class — Represents the capacity limits of an equipment's data variable store.
• GemDataSample .NET Class — Represents a data variable value supplied for one event report.
• GemDataSourceKind .NET Enum — Specifies where a bound report variable gets its value.
• GemDataState .NET Struct — Represents the current counters of an equipment's data variable store.
• GemDirectoryConfiguration .NET Class — Represents the collection event directory that a GemEquipmentWorker configures when it starts.
• GemDirectoryEntryInfo .NET Struct — Represents the ID and variable count of one directory entry.
• GemDirectoryField .NET Enum — Specifies which field of a directory entry to read.
• GemDirectoryKind .NET Enum — Specifies which namelist directory a host requests.
• GemDirectoryOptions .NET Class — Represents the capacity limits of an equipment's collection event directory, which answers S1F23 (Collection Event Namelist Request).
• GemDirectoryState .NET Struct — Represents the current counters of an equipment's event directory.
• GemEndpoint .NET Class — Provides the members shared by GemHost and GemEquipment: a synchronous SEMI E30 (GEM) endpoint layered on one HSMS (SEMI E37) TCP connection.
• GemEnhancedCommandConfiguration .NET Class — Represents the enhanced remote command store that GemEquipmentWorker installs on its equipment endpoint at startup.
• GemEnhancedCommandOptions .NET Class — Represents the capacity limits of the equipment enhanced remote command store installed by GemEquipment.ConfigureEnhancedCommands.
• GemEnhancedCommandResultInfo .NET Struct — Describes an enhanced remote command request received by the equipment (S2F49) or an enhanced remote command reply received by the host (S2F50).
• GemEnhancedCommandState .NET Struct — Represents a snapshot of the counters of the configured enhanced remote command store.
• GemEnhancedObjectDefinition .NET Class — Defines one object (OBJSPEC) and the enhanced remote commands it accepts.
• GemEnhancedObjectEntry .NET Class — Represents one configured enhanced command object and its name item.
• GemEnhancedObjectInfo .NET Struct — Represents the metadata of one configured enhanced command object.
• GemEquipment .NET Class — A synchronous GEM (SEMI E30) equipment endpoint over one HSMS TCP connection.
• GemEquipmentOptions .NET Class — Configures the GEM equipment layer of a GemEquipment.
• GemEquipmentSpoolConfiguration .NET Class — Represents the spool that GemEquipmentWorker.StartWithSpoolingAsync attaches to the equipment.
• GemEquipmentWorker .NET Class — A GEM equipment endpoint that runs on a dedicated polling thread and exposes asynchronous commands.
• GemError .NET Enum — Describes why GEM rejected a message; reported in GemResultInfo.Code for GemResultKind.InvalidResponse and GemResultKind.Unhandled results.
• GemEvent .NET Class — Represents one transport event delivered by GemWorker.ReadEventsAsync together with its GEM processing result.
• GemEventDefinition .NET Struct — Represents a collection event stored by the equipment, with its enable state and linked reports.
• GemEventDirectoryDefinition .NET Class — Represents one collection event entry of an equipment's event directory.
• GemEventInfo .NET Struct — Represents the header fields of an event report (S6F11) that a host received.
• GemEventReport .NET Struct — Represents one report inside a received event report (S6F11).
• GemFixedEventDefinition .NET Class — One collection event of a fixed report catalog: its ID, its linked reports and its initial enable state.
• GemFormattedProgramActionResult .NET Enum — The result an application reports for a start, step or cancel action with GemFormattedPrograms.SubmitActionResult.
• GemFormattedProgramCapabilityCommand .NET Class — One command entry of the equipment's process capabilities catalog, sent in S7F22.
• GemFormattedProgramCapabilityCommandInfo .NET Class — Describes one command of S7F22 process capabilities data.
• GemFormattedProgramCapabilityInfo .NET Class — Describes an S7F21/S7F22 process capabilities transaction held by a GemResult.
• GemFormattedProgramCapabilityOptions .NET Class — Limits for the S7F21/S7F22 process capabilities exchange and the equipment's capability catalog.
• GemFormattedProgramCommand .NET Class — One command of a formatted process program: a command code and its parameters.
• GemFormattedProgramCommandInfo .NET Class — Describes one command of a received, stored, selected or executed formatted process program.
• GemFormattedProgramConfiguration .NET Class — The set of formatted process program services to enable on a GEM endpoint; a null option skips its service.
• GemFormattedProgramDependency .NET Enum — Selects one dependency list of a command in an S7F22 process capabilities reply, for GemResult.GetFormattedProgramCapabilityDependencyAt.
• GemFormattedProgramDryRunInfo .NET Class — Summarizes a formatted process program dry run report.
• GemFormattedProgramDryRunIssueInfo .NET Class — Describes one issue of a formatted process program dry run report.
• GemFormattedProgramDryRunOptions .NET Class — The policy version and limits of one formatted process program dry run.
• GemFormattedProgramDryRunOutcome .NET Enum — The outcome of a formatted program dry run, in increasing order of severity.
• GemFormattedProgramDryRunReport .NET Class — The result of a read-only structural check of the selected formatted process program.
• GemFormattedProgramExecutionAction .NET Class — An action that a formatted process program execution asks the application to perform.
• GemFormattedProgramExecutionActionInfo .NET Class — Describes an action that a formatted process program execution asks the application to perform.
• GemFormattedProgramExecutionActionToken .NET Class — Identifies one action that a formatted process program execution asks the application to perform.
• GemFormattedProgramExecutionInfo .NET Class — Summarizes the equipment's formatted process program execution at the time of a snapshot.
• GemFormattedProgramExecutionSnapshot .NET Class — A read-only copy of the equipment's formatted process program execution state.
• GemFormattedProgramExecutionStart .NET Class — The result of GemFormattedPrograms.StartExecution: the token of the new execution and its start action.
• GemFormattedProgramExecutionState .NET Enum — The state of the equipment's formatted program execution tracker.
• GemFormattedProgramExecutionToken .NET Class — Identifies one formatted process program execution of an equipment endpoint.
• GemFormattedProgramInfo .NET Class — Describes an S7F27/S7F28 process program verification send held by a GemResult.
• GemFormattedProgramIssue .NET Class — One issue of an S7F27 process program verification report.
• GemFormattedProgramOptions .NET Class — Limits for S7F27/S7F28 process program verification sends.
• GemFormattedProgramPayload .NET Class — A complete formatted process program: its identifier, model, software revision and commands.
• GemFormattedProgramQueryInfo .NET Class — Describes an S7F25/S7F26 formatted process program request held by a GemResult.
• GemFormattedProgramQueryOptions .NET Class — Limits for S7F25/S7F26 formatted process program requests and the equipment's program store.
• GemFormattedProgramSelectionInfo .NET Class — Describes the equipment's formatted process program selection at the time of a snapshot.
• GemFormattedProgramSelectionSnapshot .NET Class — A read-only copy of the equipment's formatted process program selection.
• GemFormattedProgramSelectionToken .NET Class — Identifies the equipment's current formatted process program selection.
• GemFormattedProgramStoreAction .NET Enum — Specifies how a formatted process program is written to the equipment's local store.
• GemFormattedProgramStoreEntryInfo .NET Class — Describes one process program of a formatted process program store snapshot.
• GemFormattedProgramStoreInfo .NET Class — Describes the equipment's formatted process program store.
• GemFormattedProgramStoreSnapshot .NET Class — A read-only copy of the equipment's formatted process program store.
• GemFormattedProgramTerminalOutcome .NET Enum — The final outcome an application reports with GemFormattedPrograms.CompleteExecution.
• GemFormattedProgramTransferInfo .NET Class — Describes an S7F23/S7F24 formatted process program send held by a GemResult.
• GemFormattedProgramTransferOptions .NET Class — Limits for S7F23/S7F24 formatted process program sends.
• GemFormattedProgramVerificationNegotiationInfo .NET Class — Describes an S7F29/S7F30 process program verification negotiation held by a GemResult.
• GemFormattedProgramVerificationNegotiationOptions .NET Class — Limits for the S7F29/S7F30 process program verification inquire and grant that precedes an S7F27 verification send.
• GemFormattedProgramVerificationRequestInfo .NET Class — Describes an S7F31/S7F32 verification request held by a GemResult.
• GemFormattedProgramVerificationRequestOptions .NET Class — Limits for S7F31/S7F32 verification requests.
• GemFormattedPrograms .NET Class — Provides the formatted process program services of a GEM endpoint: the S7F21 to S7F32 transactions, the equipment's local formatted program store and capability catalog, program selection, dry runs and execution tracking.
• GemFormattedProgramsWorker .NET Class — Runs formatted process program operations on a GEM worker's polling thread.
• GemHost .NET Class — A synchronous GEM (SEMI E30) host endpoint over one HSMS TCP connection.
• GemHostOptions .NET Class — Configures the GEM host layer of a GemHost.
• GemHostWorker .NET Class — A GEM host endpoint that runs on a dedicated polling thread and exposes asynchronous commands.
• GemLinkSpec .NET Struct — Represents one event link that a host sends in S2F35 (Link Event Report).
• GemOnlineMode .NET Enum — Selects whether equipment enters GemControlState.OnlineLocal or GemControlState.OnlineRemote when it goes on-line.
• GemOutcome .NET Enum — Describes what GEM processing concluded for a GemResult.
• GemOwnedSnapshot .NET Class — The base class of formatted process program snapshots, reports and actions that own native memory.
• GemProgramConfiguration .NET Class — Represents the process program store that a worker installs at startup.
• GemProgramDefinition .NET Class — Represents a process program that a worker stores at startup.
• GemProgramDurability .NET Enum — Describes how durably a local process program change was installed.
• GemProgramEntry .NET Class — Represents a copy of one stored process program.
• GemProgramField .NET Enum — Selects a field of a process program result for GemResult.GetProgramItem.
• GemProgramGrantPolicy .NET Enum — Selects whether a received S7F3 (Process Program Send) needs an earlier S7F1/S7F2 grant.
• GemProgramInfo .NET Struct — Represents the state of a received stream 7 process program request or reply.
• GemProgramOptions .NET Class — Configures the process program store and the stream 7 transactions of a GEM endpoint.
• GemProgramPutMode .NET Enum — Selects how a process program is stored when its PPID may already exist.
• GemProgramState .NET Struct — Represents the counters of a process program store.
• GemProgramWriteInfo .NET Struct — Represents the outcome of a local process program change.
• GemQueryInfo .NET Struct — Represents the report query details of a GemResult.
• GemQueryReportInfo .NET Struct — Represents one report of an S6F16 event report reply.
• GemQueryValue .NET Class — Represents one value of a report query reply.
• GemReportBinding .NET Class — Represents a binding from a report variable ID (VID) to the source of its value.
• GemReportBindingEntry .NET Class — Represents a report variable binding read back from the equipment.
• GemReportConfiguration .NET Class — Represents the event report store that a GemEquipmentWorker configures when it starts.
• GemReportDefinition .NET Struct — Represents a report definition: a report ID and its ordered variable IDs.
• GemReportOptions .NET Class — Represents the capacity limits of an equipment's event report store: collection events, reports and the links between them.
• GemReportQueryKind .NET Enum — Identifies the S6 report query transaction; the values equal the matching GemRequestKind members.
• GemReportSpec .NET Struct — Represents one report definition that a host sends in S2F33 (Define Report).
• GemReportState .NET Struct — Represents the current counters of an equipment's event report store.
• GemRequestKind .NET Enum — Identifies the GEM transaction that a GemResult belongs to.
• GemResult .NET Class — Represents the outcome of processing one transport event with the GEM layer.
• GemResultInfo .NET Struct — Represents the summary of a GemResult.
• GemResultKind .NET Enum — Classifies how GemEndpoint.HandleEvent processed a transport event.
• GemRole .NET Enum — Identifies which side of a SEMI E30 (GEM) conversation an endpoint plays.
• GemSpoolCommand .NET Enum — Specifies the request spooled data code (RSDC) of an S6F23 (Request Spooled Data) message.
• GemSpoolDeliveryProof .NET Enum — Specifies the evidence that a delivery result carries for a delivered spool entry.
• GemSpoolDurability .NET Enum — Specifies how durably a spool change was stored.
• GemSpoolEntry .NET Class — Represents a copy of one stored spool entry.
• GemSpoolEntryInfo .NET Struct — Represents the header of one stored spool entry.
• GemSpoolHostOptions .NET Class — Represents the limits of the spooling requests that a host sends and of the replies it accepts.
• GemSpoolInfo .NET Struct — Represents the spooling details of a GemResult.
• GemSpoolMessageKey .NET Struct — Represents a primary message (stream and function) in the equipment spool catalog.
• GemSpoolMutation .NET Enum — Specifies which change a spool operation installed.
• GemSpoolOptions .NET Class — Represents the limits of an equipment spool.
• GemSpoolOverflow .NET Enum — Specifies what the equipment spool does with a new message when it is full.
• GemSpoolPolicy .NET Class — Represents the local spooling policy of the equipment.
• GemSpoolResultError .NET Class — Represents one stream error of an S2F44 reply that rejected an S2F43 request.
• GemSpoolResultSelection .NET Class — Represents one stream selection read from a spooling result.
• GemSpoolSelection .NET Struct — Represents the functions of one stream that are selected for spooling.
• GemSpoolState .NET Struct — Represents the counters, policy and flags of the equipment spool.
• GemSpoolWriteResult .NET Struct — Represents the outcome of an equipment spool operation that can change the spool.
• GemState .NET Struct — Represents a snapshot of the GEM state of an endpoint.
• GemStatusName .NET Struct — Represents the name and units of a status variable.
• GemStatusValue .NET Class — Represents one status variable value from an S1F4 reply.
• GemStatusVariable .NET Struct — Represents a status variable that GemEquipmentWorker registers on its endpoint at startup.
• GemWorker .NET Class — Provides the members shared by GemHostWorker and GemEquipmentWorker: a GEM endpoint owned by a dedicated polling thread.
• HsmsConnectionState .NET Enum — The connection state of an HSMS endpoint.
• HsmsEndpoint .NET Class — A synchronous HSMS (SEMI E37) endpoint that exchanges SECS-II messages over TCP/IP.
• HsmsEvent .NET Class — One event taken from an HSMS endpoint: a state change, a received message, a failure or an error.
• HsmsEventInfo .NET Struct — Describes one HsmsEvent.
• HsmsEventKind .NET Enum — The kind of an HsmsEvent.
• HsmsFailureReason .NET Enum — Why a request or control transaction failed, reported in HsmsEventInfo.Code of a HsmsEventKind.Failed event.
• HsmsFrameError .NET Enum — The frame-level error reported in HsmsEventInfo.Detail when the protocol error is HsmsProtocolError.InvalidFrame.
• HsmsHeader .NET Struct — The 10-byte HSMS message header of a received message.
• HsmsIoErrorKind .NET Enum — The portable kind of a socket error, reported in HsmsEventInfo.Detail of a HsmsEventKind.TransportError event.
• HsmsIoOperation .NET Enum — The socket operation that failed, reported in HsmsEventInfo.Code of a HsmsEventKind.TransportError event.
• HsmsMode .NET Enum — The HSMS (SEMI E37) connection mode of an endpoint.
• HsmsOptions .NET Class — Options for an HSMS (SEMI E37) endpoint: role, session, timers and resource limits.
• HsmsProtocolError .NET Enum — The HSMS protocol violation reported in HsmsEventInfo.Code of a HsmsEventKind.ProtocolError event.
• HsmsState .NET Struct — A snapshot of an HSMS endpoint's state.
• HsmsToken .NET Struct — Identifies one transaction of an HSMS endpoint.
• HsmsWorker .NET Class — Runs an HsmsEndpoint on a dedicated background thread and exposes it through asynchronous methods.
• HsmsWorkerOptions .NET Class — Queue capacities and timing for HsmsWorker, GemEquipmentWorker and GemHostWorker.
• Secs1Direction .NET Enum — The message direction that a SECS-I block header carries in its R-bit.
• Secs1Event .NET Class — An event produced by a Secs1Worker.
• Secs1EventKind .NET Enum — The kind of a Secs1Event.
• Secs1IoResult .NET Struct — The result of a Secs1Read or Secs1Write callback.
• Secs1IoStatus .NET Enum — The result status that a Secs1Read or Secs1Write callback reports to the endpoint.
• Secs1Message .NET Class — A SECS-I message: block header identity plus the message body.
• Secs1Options .NET Class — Line timing, retry and capacity options for a SECS-I (SEMI E4) endpoint.
• Secs1Priority .NET Enum — The line contention priority of a SECS-I (SEMI E4) endpoint, used in Secs1Options.Priority.
• Secs1Read .NET Delegate — Reads bytes from the serial line for a Secs1Worker.
• Secs1State .NET Class — A snapshot of a SECS-I endpoint's lifecycle flags.
• Secs1Token .NET Class — Identifies one message submitted to a SECS-I endpoint.
• Secs1Worker .NET Class — Runs a SECS-I (SEMI E4) serial line protocol endpoint on a dedicated background thread.
• Secs1WorkerOptions .NET Class — Queue capacities and timing for a Secs1Worker.
• Secs1Write .NET Delegate — Writes bytes to the serial line for a Secs1Worker.
• SecsFormat .NET Enum — SECS-II item format codes (SEMI E5), as carried in the format byte of an encoded item.
• SecsInfo .NET Struct — Describes the shape of a SECS-II item.
• SecsItem .NET Class — An immutable SECS-II (SEMI E5) data item held in native memory: a list or a typed primitive value array.
• SecsLimits .NET Struct — Resource limits that bound how SECS-II items are created, decoded and encoded.