SECS/GEM C++ API

The public C++ API of SECS/GEM.

All kindsClassConstructorEnumEnumeratorFieldFunctionMethodStructTypedef1376 symbols

• Gem300Capability Struct — One capability declaration inside a profile, used as input to Gem300CapabilityCatalog::replace().
• Gem300Capability::axis Field — Capability area; each axis may appear at most once per profile.
• Gem300Capability::id Field — Capability identifier: 1 or more printable ASCII bytes (0x21 to 0x7E, no spaces), unique within its profile.
• Gem300Capability::status Field — Declared maturity of the capability.
• Gem300CapabilityAxis Enum — GEM300 capability area that a declared capability belongs to.
• Gem300CapabilityAxis::Carrier Enumerator — Carrier management (the SEMI E87 area).
• Gem300CapabilityAxis::ControlJob Enumerator — Control job management (the SEMI E94 area).
• Gem300CapabilityAxis::ProcessJob Enumerator — Process job management (the SEMI E40 area).
• Gem300CapabilityAxis::Substrate Enumerator — Substrate tracking (the SEMI E90 area).
• Gem300CapabilityCatalog Class — Bounded, revisioned catalog of GEM300 capability declarations.
• Gem300CapabilityCatalog::Gem300CapabilityCatalog Constructor — Takes ownership of the native handle owned by other.
• Gem300CapabilityCatalog::Gem300CapabilityCatalog Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• Gem300CapabilityCatalog::Gem300CapabilityCatalog Constructor — Creates an empty catalog with the given limits.
• Gem300CapabilityCatalog::clear Method — Removes all profiles.
• Gem300CapabilityCatalog::info Method — Returns the current revision and totals.
• Gem300CapabilityCatalog::nativeHandle Method — Returns the owned native handle for direct C API calls.
• Gem300CapabilityCatalog::nativeHandle Method — Returns the owned native handle for read-only C API calls.
• Gem300CapabilityCatalog::operator= Method — Releases the current handle, then takes ownership of the handle owned by other.
• Gem300CapabilityCatalog::operator= Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• Gem300CapabilityCatalog::replace Method — Replaces the whole catalog with profiles.
• Gem300CapabilityCatalog::snapshot Method — Copies the current contents into an independent snapshot.
• Gem300CapabilityCatalog::~Gem300CapabilityCatalog Method — Releases the native handle with pdcomm_gem300_capability_catalog_destroy().
• Gem300CapabilityCatalogInfo Struct — Summary of a catalog or snapshot.
• Gem300CapabilityCatalogInfo::capabilityCount Field — Total number of capabilities across all profiles.
• Gem300CapabilityCatalogInfo::identifierBytes Field — Total bytes of all profile and capability identifiers.
• Gem300CapabilityCatalogInfo::profileCount Field — Number of profiles.
• Gem300CapabilityCatalogInfo::revision Field — Revision counter. It starts at 0 and increases by one on every change.
• Gem300CapabilityInfo Struct — Description of one capability in a snapshot.
• Gem300CapabilityInfo::axis Field — Capability area.
• Gem300CapabilityInfo::idLength Field — Length of the capability identifier in bytes.
• Gem300CapabilityInfo::status Field — Declared status label.
• Gem300CapabilityInfo::verification Field — Verification label; Gem300VerificationStatus::Unverified, the only defined value.
• Gem300CapabilityMutation Struct — Result of Gem300CapabilityCatalog::replace() or Gem300CapabilityCatalog::clear().
• Gem300CapabilityMutation::changed Field — true when the contents changed and the revision increased; false when the request matched the current contents.
• Gem300CapabilityMutation::revision Field — Catalog revision after the call.
• Gem300CapabilityProfile Struct — Named group of capability declarations, used as input to Gem300CapabilityCatalog::replace().
• Gem300CapabilityProfile::capabilities Field — Capabilities in declaration order. Must contain 1 to max_capabilities_per_profile entries (at most 4) with distinct identifiers and axes.
• Gem300CapabilityProfile::id Field — Profile identifier: 1 or more printable ASCII bytes (0x21 to 0x7E), unique in the catalog.
• Gem300CapabilityProfileInfo Struct — Size information for one profile in a snapshot.
• Gem300CapabilityProfileInfo::capabilityCount Field — Number of capabilities in the profile.
• Gem300CapabilityProfileInfo::idLength Field — Length of the profile identifier in bytes.
• Gem300CapabilitySnapshot Class — Immutable copy of a Gem300CapabilityCatalog at one revision.
• Gem300CapabilitySnapshot::Gem300CapabilitySnapshot Constructor — Creates an empty snapshot that owns no native handle.
• Gem300CapabilitySnapshot::Gem300CapabilitySnapshot Constructor — Takes ownership of the native handle owned by other.
• Gem300CapabilitySnapshot::Gem300CapabilitySnapshot Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• Gem300CapabilitySnapshot::capabilityId Method — Copies the identifier of one capability.
• Gem300CapabilitySnapshot::capabilityInfo Method — Describes one capability of one profile.
• Gem300CapabilitySnapshot::info Method — Returns the revision and totals captured in this snapshot.
• Gem300CapabilitySnapshot::nativeHandle Method — Returns the owned native handle for read-only C API calls.
• Gem300CapabilitySnapshot::operator bool Method — Reports whether the wrapper owns a native snapshot.
• Gem300CapabilitySnapshot::operator= Method — Releases the current handle, then takes ownership of the handle owned by other.
• Gem300CapabilitySnapshot::operator= Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• Gem300CapabilitySnapshot::profileId Method — Copies the identifier of one profile.
• Gem300CapabilitySnapshot::profileInfo Method — Returns size information for one profile.
• Gem300CapabilitySnapshot::~Gem300CapabilitySnapshot Method — Releases the native handle with pdcomm_gem300_capability_snapshot_destroy().
• Gem300CapabilityStatus Enum — Status label that an application declares for one of its capabilities.
• Gem300CapabilityStatus::Experimental Enumerator — Label value 3 (experimental): the application runs this capability on trial.
• Gem300CapabilityStatus::ModelOnly Enumerator — Label value 2 (model only): the application has a data model of this capability.
• Gem300CapabilityStatus::Planned Enumerator — Label value 1 (planned): the application plans this capability.
• Gem300VerificationStatus Enum — Verification label that the catalog stores for a capability.
• Gem300VerificationStatus::Unverified Enumerator — Verification label value 1, currently the only defined value.
• GemAlarmChange Struct — Effect of GemEquipment::observeAlarm().
• GemAlarmChange::active Field — Active state after the call.
• GemAlarmChange::changed Field — true when the active state changed.
• GemAlarmChange::eventId Field — CEID for the transition; publish it separately if needed.
• GemAlarmChange::eventPresent Field — true when the transition has a configured CEID in #eventId.
• GemAlarmChange::id Field — Alarm ID (ALID).
• GemAlarmChange::reportingEnabled Field — Whether the host has enabled reporting of this alarm, at the time of the call.
• GemAlarmDefinition Struct — One alarm definition for GemEquipment::configureAlarms().
• GemAlarmDefinition::category Field — Alarm category, 1 to 63; sent in the low bits of ALCD.
• GemAlarmDefinition::clearEvent Field — CEID returned when the alarm becomes clear; it must exist in the report catalog.
• GemAlarmDefinition::clearEventPresent Field — true when #clearEvent is used.
• GemAlarmDefinition::id Field — Alarm ID (ALID).
• GemAlarmDefinition::setEvent Field — CEID returned when the alarm becomes set; it must exist in the report catalog.
• GemAlarmDefinition::setEventPresent Field — true when #setEvent is used.
• GemAlarmDefinition::text Field — Alarm text (ALTX): ASCII, at most min(max_text_bytes, 120) bytes.
• GemAlarmInfo Struct — One alarm of the equipment's alarm store, returned by GemEquipment::alarmAt().
• GemAlarmInfo::active Field — true while the alarm is set.
• GemAlarmInfo::category Field — Alarm category, 1 to 63.
• GemAlarmInfo::clearEvent Field — CEID for the clear transition.
• GemAlarmInfo::clearEventPresent Field — true when #clearEvent is configured.
• GemAlarmInfo::enabled Field — true when the host enabled reporting of this alarm.
• GemAlarmInfo::id Field — Alarm ID (ALID).
• GemAlarmInfo::setEvent Field — CEID for the set transition.
• GemAlarmInfo::setEventPresent Field — true when #setEvent is configured.
• GemAlarmInfo::text Field — Alarm text (ALTX).
• GemAlarmResultInfo Struct — Summary of a received S5F1 report or S5F6/S5F8 list, returned by GemResult::alarmInfo().
• GemAlarmResultInfo::acknowledged Field — true after GemHost::acknowledgeAlarm() sent S5F2.
• GemAlarmResultInfo::count Field — Number of alarms; 1 for an S5F1 report.
• GemAlarmResultInfo::isReport Field — true for an S5F1 alarm report, false for a list reply.
• GemAlarmResultInfo::replyExpected Field — W-bit of an S5F1 report; false for lists.
• GemAlarmState Struct — Counters of the equipment's alarm store.
• GemAlarmState::activeCount Field — Alarms currently set.
• GemAlarmState::alarmCount Field — Defined alarms.
• GemAlarmState::enabledCount Field — Alarms whose reporting the host enabled (S5F3).
• GemAlarmState::textBytes Field — Total alarm text bytes.
• GemAlarmValue Struct — One alarm from an S5F1 report or S5F6/S5F8 list, returned by GemResult::alarmAt().
• GemAlarmValue::active Field — true when the ALCD set bit (bit 8) is on.
• GemAlarmValue::category Field — Alarm category from ALCD, without the set bit.
• GemAlarmValue::id Field — Alarm ID (ALID).
• GemAlarmValue::text Field — Alarm text (ALTX).
• GemBindingInfo Struct — One installed binding, returned by GemEquipment::bindingAt().
• GemBindingInfo::constantId Field — ECID for a Constant source; an empty item otherwise.
• GemBindingInfo::constantIdPresent Field — true when #constantId holds an item.
• GemBindingInfo::source Field — Source store.
• GemBindingInfo::sourceId Field — SVID or DVID; 0 for a Constant source.
• GemBindingInfo::variableId Field — VID.
• GemBindingState Struct — Counters of the report binding store.
• GemBindingState::bindingCount Field — Installed bindings.
• GemBindingState::explicitMode Field — true when explicit bindings are installed (even an empty set); false means VIDs resolve to status variables with the same ID.
• GemBindingState::identifierBytes Field — Bytes used by constant IDs.
• GemCommandAcknowledgement Enum — Host command acknowledgement (HCACK) for S2F42 and S2F50.
• GemCommandAcknowledgement::AcceptedForLater Enumerator — HCACK 4: acknowledged; the command will be performed and completion signalled by an event.
• GemCommandAcknowledgement::AlreadyInCondition Enumerator — HCACK 5: rejected, already in the desired condition.
• GemCommandAcknowledgement::CannotPerform Enumerator — HCACK 2: cannot perform now.
• GemCommandAcknowledgement::Completed Enumerator — HCACK 0: acknowledged, command performed.
• GemCommandAcknowledgement::NoSuchObject Enumerator — HCACK 6: no such object exists.
• GemCommandAcknowledgement::ParameterErrors Enumerator — HCACK 3: at least one parameter is invalid; the reply lists the issues.
• GemCommandAcknowledgement::Unknown Enumerator — HCACK 1: command does not exist.
• GemCommandDefinition Struct — One remote command (RCMD) definition for S2F41 or for an enhanced command object.
• GemCommandDefinition::completionEvent Field — CEID reported back for HCACK 0 or 4; it must exist in the report catalog.
• GemCommandDefinition::completionEventPresent Field — true when #completionEvent is used.
• GemCommandDefinition::name Field — Command name: non-empty ASCII, or an integer scalar from -128 to 255. Borrowed.
• GemCommandDefinition::parameters Field — Accepted parameters.
• GemCommandDefinition::requireOnlineRemote Field — true when the command is only valid in GemControl::OnlineRemote.
• GemCommandInfo Struct — One command definition, returned by GemEquipment::commandAt() and GemEquipment::enhancedCommandAt().
• GemCommandInfo::completionEvent Field — Completion CEID.
• GemCommandInfo::completionEventPresent Field — true when #completionEvent is configured.
• GemCommandInfo::name Field — Command name; numeric names may be normalized to I8 or U8.
• GemCommandInfo::parameterCount Field — Number of parameter definitions.
• GemCommandInfo::requireOnlineRemote Field — true when the command needs GemControl::OnlineRemote.
• GemCommandIssue Struct — One parameter error (CPNAME, CPACK) for an HCACK 3 reply. The name is borrowed.
• GemCommandIssue::code Field — CPACK: 1 (unknown name), 2 (illegal value) or 3 (illegal format).
• GemCommandIssue::name Field — Name of the faulty parameter.
• GemCommandIssueValue Struct — One issue of a command result, returned by GemResult::commandIssue().
• GemCommandIssueValue::code Field — CPACK code.
• GemCommandIssueValue::name Field — Parameter name.
• GemCommandParameter Struct — One parameter (CPNAME, CPVAL) for a host command request. Both items are borrowed.
• GemCommandParameter::name Field — Parameter name item.
• GemCommandParameter::value Field — Parameter value item. Enhanced commands also allow lists and floats.
• GemCommandParameterDefinition Struct — One parameter (CPNAME) accepted by a remote command definition.
• GemCommandParameterDefinition::format Field — Required SECS-II format code (PDCOMM_SECS_*). Numeric bounds need an integer format.
• GemCommandParameterDefinition::formatPresent Field — true when #format restricts the value format.
• GemCommandParameterDefinition::maxCount Field — Maximum element count of the value.
• GemCommandParameterDefinition::maximum Field — Highest accepted numeric value; used when #maximumPresent is true.
• GemCommandParameterDefinition::maximumPresent Field — true when #maximum applies.
• GemCommandParameterDefinition::minCount Field — Minimum element count of the value.
• GemCommandParameterDefinition::minimum Field — Lowest accepted numeric value; used when #minimumPresent is true.
• GemCommandParameterDefinition::minimumPresent Field — true when #minimum applies.
• GemCommandParameterDefinition::name Field — Parameter name: an ASCII item or an integer scalar item (any I or U format).
• GemCommandParameterDefinition::required Field — true when the host must send this parameter.
• GemCommandParameterInfo Struct — One parameter definition, returned by GemEquipment::commandParameterAt() and GemEquipment::enhancedCommandParameterAt().
• GemCommandParameterInfo::format Field — Required SECS-II format code.
• GemCommandParameterInfo::formatPresent Field — true when #format applies.
• GemCommandParameterInfo::maxCount Field — Maximum element count.
• GemCommandParameterInfo::maximum Field — Highest accepted value; valid when #maximumPresent is true.
• GemCommandParameterInfo::maximumPresent Field — true when #maximum applies.
• GemCommandParameterInfo::minCount Field — Minimum element count.
• GemCommandParameterInfo::minimum Field — Lowest accepted value; valid when #minimumPresent is true.
• GemCommandParameterInfo::minimumPresent Field — true when #minimum applies.
• GemCommandParameterInfo::name Field — Parameter name; numeric names may be normalized to I8 or U8.
• GemCommandParameterInfo::required Field — true when the parameter is mandatory.
• GemCommandParameterValue Struct — One parameter of a received command request, returned by GemResult::commandParameter().
• GemCommandParameterValue::name Field — Parameter name in its wire format.
• GemCommandParameterValue::value Field — Parameter value in its wire format.
• GemCommandReply Struct — What GemEquipment::respondCommand() or GemEquipment::respondEnhancedCommand() sent.
• GemCommandReply::acknowledgement Field — HCACK actually sent; validation failures override the requested decision.
• GemCommandReply::completionEvent Field — Completion CEID; publish the S6F11 event separately.
• GemCommandReply::completionEventPresent Field — true when the sent HCACK (0 or 4) has a completion CEID to publish.
• GemCommandResultInfo Struct — Summary of a received S2F41 request or S2F42 reply, returned by GemResult::commandInfo().
• GemCommandResultInfo::completionEvent Field — Completion CEID of the command.
• GemCommandResultInfo::completionEventPresent Field — true when the accepted command has a completion CEID.
• GemCommandResultInfo::isRequest Field — true for an S2F41 request at the equipment, false for an S2F42 reply at the host.
• GemCommandResultInfo::issueCount Field — Validation issues of a request, or CPACK entries of a reply.
• GemCommandResultInfo::parameterCount Field — Request parameters; 0 for a reply.
• GemCommandResultInfo::responded Field — true after GemEquipment::respondCommand() sent S2F42.
• GemCommandResultInfo::validationAccepted Field — true when the library's validation at receipt accepted the request.
• GemCommandResultInfo::validationAcknowledgement Field — HCACK chosen by validation at receipt; it overrides the application's decision when validation failed.
• GemCommandState Struct — Counters of the equipment's remote command store.
• GemCommandState::commandCount Field — Defined commands.
• GemCommandState::identifierBytes Field — Total bytes of command and parameter names.
• GemCommandState::totalParameters Field — Parameter definitions across all commands.
• GemCommunication Enum — State of the SEMI E30 communication state model.
• GemCommunication::Communicating Enumerator — Communication is established; GEM messages may flow.
• GemCommunication::Disconnected Enumerator — No selected HSMS session exists.
• GemCommunication::NotCommunicating Enumerator — An HSMS session is selected, but S1F13/F14 Establish Communications has not succeeded.
• GemCommunication::WaitingAck Enumerator — S1F13 was sent and the S1F14 acknowledgement is pending.
• GemConstantChange Struct — One (ECID, ECV) pair for S2F15, sent by GemHost::changeConstants(). Both items are borrowed.
• GemConstantChange::id Field — Equipment constant ID.
• GemConstantChange::value Field — New value.
• GemConstantChangeInfo Struct — Summary of a received S2F15 request or S2F16 reply, returned by GemResult::constantChangeInfo().
• GemConstantChangeInfo::applied Field — true when an EAC 0 reply swapped in the new values.
• GemConstantChangeInfo::changeCount Field — Number of (ECID, ECV) pairs in the request; 0 for a reply.
• GemConstantChangeInfo::isRequest Field — true for an S2F15 request at the equipment; false for an S2F16 reply.
• GemConstantChangeInfo::responded Field — true after GemEquipment::respondConstants() sent S2F16.
• GemConstantChangeInfo::validationAccepted Field — true when validation at receipt accepted the request.
• GemConstantChangeInfo::validationAcknowledgement Field — EAC chosen by validation at receipt.
• GemConstantChangeValue Struct — One proposed change of a received S2F15, returned by GemResult::constantChange().
• GemConstantChangeValue::id Field — ECID as received.
• GemConstantChangeValue::original Field — Value at receipt; an empty item when #originalPresent is false.
• GemConstantChangeValue::originalPresent Field — false when the ECID is unknown.
• GemConstantChangeValue::value Field — Proposed value as received.
• GemConstantDecision Enum — Equipment acknowledgement (EAC) chosen for a received S2F15.
• GemConstantDecision::Apply Enumerator — EAC 0: accept and apply the changes to the SDK store.
• GemConstantDecision::CannotPerform Enumerator — EAC 2: busy, cannot perform now.
• GemConstantDecision::OutOfRange Enumerator — EAC 3: at least one value is out of range.
• GemConstantDefinition Struct — One equipment constant definition for GemEquipment::configureConstants().
• GemConstantDefinition::current Field — Current value (ECV); its format and count are kept as declared.
• GemConstantDefinition::defaultValue Field — Default value (ECDEF), or nullptr when absent.
• GemConstantDefinition::id Field — ECID: case-sensitive ASCII (empty allowed) or a scalar integer item.
• GemConstantDefinition::maxCount Field — Maximum element count accepted for new values.
• GemConstantDefinition::maximum Field — Maximum (ECMAX), or nullptr when absent.
• GemConstantDefinition::minCount Field — Minimum element count accepted for new values.
• GemConstantDefinition::minimum Field — Minimum (ECMIN), or nullptr when absent. Lists cannot have bounds.
• GemConstantDefinition::name Field — ECNAME, ASCII.
• GemConstantDefinition::units Field — Units, ASCII.
• GemConstantField Enum — Field of an equipment constant definition or namelist row.
• GemConstantField::Current Enumerator — Current value (ECV). Valid only for local equipment reads, not for S2F30 rows.
• GemConstantField::Default Enumerator — Default value (ECDEF).
• GemConstantField::Id Enumerator — Equipment constant ID (ECID).
• GemConstantField::Maximum Enumerator — Maximum value (ECMAX).
• GemConstantField::Minimum Enumerator — Minimum value (ECMIN).
• GemConstantField::Name Enumerator — Name (ECNAME), an ASCII item.
• GemConstantField::Units Enumerator — Units, an ASCII item.
• GemConstantInfo Struct — One constant definition, returned by GemEquipment::constantAt().
• GemConstantInfo::defaultPresent Field — true when a default value is defined.
• GemConstantInfo::format Field — Declared SECS-II format code of the value.
• GemConstantInfo::id Field — ECID item; numeric IDs may be normalized to I8 or U8.
• GemConstantInfo::maxCount Field — Maximum element count.
• GemConstantInfo::maximumPresent Field — true when a maximum is defined.
• GemConstantInfo::minCount Field — Minimum element count.
• GemConstantInfo::minimumPresent Field — true when a minimum is defined.
• GemConstantReply Struct — What GemEquipment::respondConstants() sent.
• GemConstantReply::acknowledgement Field — EAC actually sent; a failed validation keeps its original EAC.
• GemConstantReply::applied Field — true when the SDK store now holds the new values.
• GemConstantRequest Enum — Kind of equipment constant query sent by GemHost::constantRequest().
• GemConstantRequest::Metadata Enumerator — S2F29 Equipment Constant Namelist Request (names, limits, defaults and units).
• GemConstantRequest::Values Enumerator — S2F13 Equipment Constant Request (current values).
• GemConstantState Struct — Counters of the equipment constant store.
• GemConstantState::constantCount Field — Defined constants.
• GemConstantState::metadataBytes Field — Bytes used by IDs, names and units.
• GemConstantState::valueBytes Field — Bytes used by values and bounds.
• GemConstantValue Struct — One value from an S2F14 reply, returned by GemResult::constantValue().
• GemConstantValue::id Field — Requested ECID; an empty item when #idPresent is false.
• GemConstantValue::idPresent Field — true for replies to an explicit ID list; a request for all values has no IDs on the wire.
• GemConstantValue::value Field — Value item. An empty list alone does not prove the ECID is unknown.
• GemControl Enum — State of the SEMI E30 control state model of the equipment.
• GemControl::AttemptOnline Enumerator — The equipment sent S1F1 after an operator online request and waits for S1F2.
• GemControl::EquipmentOffline Enumerator — Offline, chosen at the equipment.
• GemControl::HostOffline 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 Enumerator — Online in the local substate; the host has limited control.
• GemControl::OnlineRemote Enumerator — Online in the remote substate; the host may control the equipment.
• GemControl::Unavailable Enumerator — No control state exists, which is the case for the host role.
• GemDataDefinition Struct — One data variable definition for GemEquipment::configureDataVariables().
• GemDataDefinition::cached Field — Initial cached value, or nullptr for no cache. Borrowed during the call.
• GemDataDefinition::format Field — Declared top-level SECS-II format code; every format is allowed.
• GemDataDefinition::id Field — Data variable ID (DVID).
• GemDataDefinition::maxCount Field — Maximum element count of values.
• GemDataDefinition::minCount Field — Minimum element count of values.
• GemDataDefinition::name Field — Name, ASCII.
• GemDataDefinition::units Field — Units, ASCII.
• GemDataField Enum — Field of a data variable read by GemEquipment::data().
• GemDataField::Cached Enumerator — Cached value; an empty item when no value is cached.
• GemDataField::Name Enumerator — Variable name, an ASCII item.
• GemDataField::Units Enumerator — Units, an ASCII item.
• GemDataInfo Struct — One data variable, returned by GemEquipment::dataAt().
• GemDataInfo::cachedPresent Field — true when a cached value is available.
• GemDataInfo::format Field — Declared SECS-II format code.
• GemDataInfo::id Field — Data variable ID.
• GemDataInfo::maxCount Field — Maximum element count.
• GemDataInfo::minCount Field — Minimum element count.
• GemDataSample Struct — A value sampled for one data variable, used when building a report. Borrowed.
• GemDataSample::id Field — Data variable ID (DVID).
• GemDataSample::value Field — Sampled value. Samples never change the cached value.
• GemDataState Struct — Counters of the data variable store.
• GemDataState::metadataBytes Field — Bytes used by names and units.
• GemDataState::valueBytes Field — Bytes used by cached values.
• GemDataState::variableCount Field — Defined data variables.
• GemDirectoryDefinition Struct — One collection event of the equipment's event directory (S1F24 row).
• GemDirectoryDefinition::id Field — Collection event ID (CEID); must exist in the report catalog.
• GemDirectoryDefinition::name Field — Event name, ASCII; may be empty.
• GemDirectoryDefinition::variableIds Field — VIDs associated with the event; each must be bound to a data variable.
• GemDirectoryEntryInfo Struct — One namelist row, returned by GemResult::directoryAt() and GemEquipment::directoryAt().
• GemDirectoryEntryInfo::id Field — DVID or CEID of the row.
• GemDirectoryEntryInfo::variableCount Field — VIDs of an event row; 0 for data rows.
• GemDirectoryField Enum — Field of a namelist row.
• GemDirectoryField::Name Enumerator — Name of the variable or event, an ASCII item.
• GemDirectoryField::Units Enumerator — Units of a data variable, an ASCII item. Not valid for event rows.
• GemDirectoryField::VariableIds Enumerator — VIDs linked to a collection event, a U4 array item. Not valid for data rows.
• GemDirectoryKind Enum — Kind of namelist requested by GemHost::directoryRequest().
• GemDirectoryKind::Data Enumerator — S1F21 Data Variable Namelist Request.
• GemDirectoryKind::Event Enumerator — S1F23 Collection Event Namelist Request.
• GemDirectoryState Struct — State of the event directory, returned by GemEquipment::directoryState().
• GemDirectoryState::configured Field — true once a directory was configured; an empty configured directory differs from none.
• GemDirectoryState::eventCount Field — Directory rows.
• GemDirectoryState::metadataBytes Field — Bytes used by names.
• GemDirectoryState::totalVariables Field — VIDs across all rows.
• GemEndpoint Class — Common base of GemHost and GemEquipment: one HSMS endpoint with a GEM role.
• GemEndpoint::GemEndpoint Constructor — Moves the endpoint; the source no longer owns a native endpoint.
• GemEndpoint::GemEndpoint Constructor — Copying is disabled; the endpoint exclusively owns its native handle.
• GemEndpoint::cancelProgramGrant Method — Cancels the S7F1 grant activated by result.
• GemEndpoint::completeSpoolDelivery Method — Finishes a spooled delivery attempt and, on success, removes the head entry.
• GemEndpoint::configurePrograms Method — Attaches the process program store and enables stream 7 program transfers.
• GemEndpoint::confirmProgramReply Method — Accepts an unconfirmed installation so that its retained reply can be sent.
• GemEndpoint::confirmSpoolReply Method — Accepts an unconfirmed spool installation so that its retained reply can be sent.
• GemEndpoint::handle Method — Alias of handleEvent().
• GemEndpoint::handleEvent Method — Processes one TCP event with the GEM layer.
• GemEndpoint::nextEvent Method — Takes the next queued TCP event; forwards to TcpEndpoint::nextEvent().
• GemEndpoint::operator= Method — Destroys the current native endpoint, then takes over the one owned by the source.
• GemEndpoint::operator= Method — Copy assignment is disabled; the endpoint exclusively owns its native handle.
• GemEndpoint::poll Method — Drives the HSMS endpoint; forwards to TcpEndpoint::poll().
• GemEndpoint::program Method — Returns a copy of the body stored under id.
• GemEndpoint::programAt Method — Returns a copy of one stored program in store order.
• GemEndpoint::programDeleteLocal Method — Deletes programs from the local store.
• GemEndpoint::programGrant Method — Sends S7F1 Process Program Load Inquire.
• GemEndpoint::programPut Method — Writes one program to the local store.
• GemEndpoint::programRequest Method — Sends S7F5 Process Program Request.
• GemEndpoint::programSend Method — Sends S7F3 Process Program Send.
• GemEndpoint::programState Method — Returns counters of the process program store.
• GemEndpoint::respondProgram Method — Replies to a received process program request and returns the native status.
• GemEndpoint::respondSpool Method — Replies to a received spool request and returns the native status.
• GemEndpoint::resyncPrograms Method — Retries synchronization of the program file's parent directory.
• GemEndpoint::resyncSpool Method — Retries synchronization of the spool file's parent directory.
• GemEndpoint::retrySpoolDequeue Method — Retries removing an entry whose delivery was accepted but whose dequeue failed.
• GemEndpoint::sendNextSpool Method — Sends the message at the head of the spool during an accepted transmit run.
• GemEndpoint::spoolCatalogAt Method — Returns one registered spoolable stream and function pair.
• GemEndpoint::spoolEntryAt Method — Returns a copy of one stored spool entry in queue order, including its capture time.
• GemEndpoint::spoolSelectionAt Method — Returns one selected stream of the current spooling selection.
• GemEndpoint::spoolState Method — Returns the state of the equipment spool.
• GemEndpoint::start Method — Starts the HSMS endpoint; forwards to TcpEndpoint::start().
• GemEndpoint::state Method — Returns the current GEM state.
• GemEndpoint::stop Method — Stops the HSMS endpoint; forwards to TcpEndpoint::stop().
• GemEndpoint::stopSpoolTransmit Method — Ends the current transmit run.
• GemEndpoint::tcp Method — Returns the underlying HSMS endpoint.
• GemEndpoint::tcp Method — Returns the underlying HSMS endpoint for read-only calls.
• GemEnhancedCommandResultInfo Struct — Summary of a received S2F49 request or S2F50 reply, returned by GemResult::enhancedCommandInfo().
• GemEnhancedCommandResultInfo::completionEvent Field — Completion CEID of the command.
• GemEnhancedCommandResultInfo::completionEventPresent Field — true when the accepted command has a completion CEID.
• GemEnhancedCommandResultInfo::dataId Field — DATAID of the request; 0 for a reply.
• GemEnhancedCommandResultInfo::isRequest Field — true for an S2F49 request at the equipment, false for an S2F50 reply.
• GemEnhancedCommandResultInfo::issueCount Field — Validation issues of a request, or outer acknowledgement entries of a reply.
• GemEnhancedCommandResultInfo::parameterCount Field — Request parameters; 0 for a reply.
• GemEnhancedCommandResultInfo::responded Field — true after GemEquipment::respondEnhancedCommand() sent S2F50.
• GemEnhancedCommandResultInfo::validationAccepted Field — true when admission and validation at receipt accepted the request.
• GemEnhancedCommandResultInfo::validationAcknowledgement Field — HCACK chosen at receipt; it overrides the application's decision when validation failed.
• GemEnhancedCommandState Struct — Counters of the equipment's enhanced remote command store.
• GemEnhancedCommandState::commandCount Field — Commands across all objects.
• GemEnhancedCommandState::identifierBytes Field — Total bytes of command and parameter names.
• GemEnhancedCommandState::objectCount Field — Defined objects.
• GemEnhancedCommandState::totalObjectBytes Field — Total bytes of object specifiers.
• GemEnhancedCommandState::totalParameters Field — Parameter definitions across all commands.
• GemEnhancedObjectDefinition Struct — One object (OBJSPEC) with its enhanced remote commands, for GemEquipment::configureEnhancedCommands().
• GemEnhancedObjectDefinition::commands Field — Commands accepted for this object.
• GemEnhancedObjectDefinition::name Field — Object specifier: an exact, case-sensitive ASCII item (may be empty). Borrowed.
• GemEnhancedObjectInfo Struct — One object, returned by GemEquipment::enhancedObjectAt().
• GemEnhancedObjectInfo::commandCount Field — Commands defined for the object.
• GemEnhancedObjectInfo::name Field — Object specifier item.
• GemEquipment Class — GEM equipment role (SEMI E30) on one HSMS endpoint (SEMI E37).
• GemEquipment::GemEquipment Constructor — Takes ownership of endpoint and configures it as GEM equipment from an options struct.
• GemEquipment::GemEquipment Constructor — Takes ownership of endpoint and configures it as GEM equipment.
• GemEquipment::alarmAt Method — Returns one alarm in registration order.
• GemEquipment::alarmState Method — Returns counters of the alarm store.
• GemEquipment::bindingAt Method — Returns one binding in stored order.
• GemEquipment::bindingState Method — Returns the state of the binding store.
• GemEquipment::captureSpool Method — Offers a generic primary message to the spool.
• GemEquipment::captureSpoolAlarm Method — Builds the S5F1 report for an alarm's current state and offers it to the spool.
• GemEquipment::captureSpoolEvent Method — Builds the S6F11 report for a collection event and offers it to the spool.
• GemEquipment::clearDataVariable Method — Removes the cached value of a data variable.
• GemEquipment::clearReportBindings Method — Removes all bindings and restores the default VID-equals-SVID resolution.
• GemEquipment::commandAt Method — Returns one command definition in stored order.
• GemEquipment::commandParameterAt Method — Returns one parameter definition of one command.
• GemEquipment::commandState Method — Returns counters of the remote command store.
• GemEquipment::configureAlarms Method — Creates the alarm store.
• GemEquipment::configureCommands Method — Creates the remote command (S2F41) store.
• GemEquipment::configureConstants Method — Creates the equipment constant (ECID) store.
• GemEquipment::configureDataVariables Method — Installs or replaces the complete data variable (DVID) store.
• GemEquipment::configureEnhancedCommands Method — Creates the enhanced remote command (S2F49) store.
• GemEquipment::configureEventDirectory Method — Installs or replaces the collection event namelist answered for S1F23.
• GemEquipment::configureFixedCatalog Method — Atomically installs a fixed report graph and its STATUS or DATA bindings.
• GemEquipment::configureLocalSpooling Method — Sets the local spooling policy and stream selection.
• GemEquipment::configureReportBindings Method — Installs or replaces the VID-to-source bindings used to build reports.
• GemEquipment::configureReports Method — Creates the report store and declares the collection events (CEIDs).
• GemEquipment::configureSpooling Method — Attaches the equipment spool.
• GemEquipment::constant Method — Returns one field of a local constant definition.
• GemEquipment::constantAt Method — Returns one constant definition in stored order.
• GemEquipment::constantState Method — Returns counters of the constant store.
• GemEquipment::data Method — Returns the name, units or cached value of a data variable.
• GemEquipment::dataAt Method — Returns one data variable definition in stored order.
• GemEquipment::dataState Method — Returns counters of the data variable store.
• GemEquipment::directory Method — Alias of directoryGet().
• GemEquipment::directoryAt Method — Returns one event directory row in stored order.
• GemEquipment::directoryGet Method — Returns the name or VID list of one event directory row.
• GemEquipment::directoryState Method — Returns the state of the event directory.
• GemEquipment::enhancedCommandAt Method — Returns one command of one enhanced object.
• GemEquipment::enhancedCommandParameterAt Method — Returns one parameter definition of one enhanced command.
• GemEquipment::enhancedCommandState Method — Returns counters of the enhanced remote command store.
• GemEquipment::enhancedObjectAt Method — Returns one object of the enhanced command store.
• GemEquipment::eventAt Method — Returns one collection event in stored order.
• GemEquipment::observeAlarm Method — Records the current set or clear state of an alarm without sending anything.
• GemEquipment::operatorOffline Method — Moves the equipment offline at the operator's request (the OFF-LINE switch).
• GemEquipment::operatorOnline Method — Starts an operator-initiated transition to online by sending S1F1.
• GemEquipment::publishAlarm Method — Sends S5F1 Alarm Report Send with the alarm's current state.
• GemEquipment::publishEvent Method — Sends S6F11 Event Report Send for an enabled collection event.
• GemEquipment::publishEventWithData Method — Sends S6F11 using supplied samples first, then caches, for an enabled event.
• GemEquipment::purgeSpool Method — Deletes all stored spool entries locally.
• GemEquipment::registerStatus Method — Registers a status variable (SVID) with its name, units and initial value.
• GemEquipment::reportAt Method — Returns one defined report in stored order.
• GemEquipment::reportState Method — Returns counters of the report store.
• GemEquipment::reportValue Method — Resolves the current report value of a VID from its source.
• GemEquipment::respondCommand Method — Sends S2F42 for a received S2F41.
• GemEquipment::respondConstants Method — Sends S2F16 for a received S2F15 using a named decision.
• GemEquipment::respondConstants Method — Sends S2F16 for a received S2F15.
• GemEquipment::respondEnhancedCommand Method — Sends S2F50 for a received S2F49.
• GemEquipment::respondReportQuery Method — Answers a received S6F15, S6F19 or S6F21 with S6F16, S6F20 or S6F22.
• GemEquipment::setOnlineMode Method — Sets the operator's REMOTE/LOCAL switch.
• GemEquipment::status Method — Returns a copy of the current value of a status variable.
• GemEquipment::statusIdAt Method — Returns the SVID at a position in registration order.
• GemEquipment::statusMetadata Method — Returns the registered name and units of a status variable.
• GemEquipment::syncSpool Method — Synchronizes the spool with the current communication state.
• GemEquipment::updateDataVariable Method — Replaces the cached value of a data variable.
• GemEquipment::updateStatus Method — Replaces the current value of a registered status variable.
• GemEventDefinition Struct — One collection event, returned by GemEquipment::eventAt().
• GemEventDefinition::enabled Field — true when the host enabled the event report (S2F37).
• GemEventDefinition::id Field — Collection event ID (CEID).
• GemEventDefinition::reportIds Field — Linked report IDs in link order.
• GemEventDirectoryDefinition Typedef — Alias of GemDirectoryDefinition.
• GemEventInfo Struct — Header of a received S6F11 event report, returned by GemResult::eventInfo().
• GemEventInfo::acknowledged Field — true after GemHost::acknowledgeEvent() sent S6F12.
• GemEventInfo::dataId Field — Data ID (DATAID).
• GemEventInfo::eventId Field — Collection event ID (CEID).
• GemEventInfo::reportCount Field — Number of reports in the message.
• GemEventReport Struct — One report inside a received S6F11, returned by GemResult::eventReport().
• GemEventReport::id Field — Report ID (RPTID).
• GemEventReport::valueCount Field — Number of values. Values carry no VIDs; map positions using the report definition.
• GemFixedEventSpec Struct — One collection event of a fixed report catalog, for GemEquipment::configureFixedCatalog().
• GemFixedEventSpec::enabled Field — Initial enabled state of the event report.
• GemFixedEventSpec::id Field — Collection event ID (CEID).
• GemFixedEventSpec::reportIds Field — Linked report IDs, in order.
• GemFormattedProgramCapabilityCommand Struct — One command description of the equipment's S7F22 Process Capability Data.
• GemFormattedProgramCapabilityCommand::after Field — ACDS: the command this command must come after.
• GemFormattedProgramCapabilityCommand::before Field — BCDS: commands this command must come before.
• GemFormattedProgramCapabilityCommand::blockDefinition Field — BLKDEF: -1 (ends a block), 0 (not a block) or 1 (starts a block).
• GemFormattedProgramCapabilityCommand::code Field — Command code (CCODE), ASCII, at most maxCommandCodeBytes bytes.
• GemFormattedProgramCapabilityCommand::immediateAfter Field — IACDS: commands this command must come immediately after.
• GemFormattedProgramCapabilityCommand::immediateBefore Field — IBCDS: commands this command must come immediately before.
• GemFormattedProgramCapabilityCommand::name Field — Command name (CNAME), ASCII, at most 16 bytes.
• GemFormattedProgramCapabilityCommand::nonAfter Field — NACDS: commands this command must not come after.
• GemFormattedProgramCapabilityCommand::nonBefore Field — NBCDS: commands this command must not come before.
• GemFormattedProgramCapabilityCommand::parameters Field — Parameter descriptions; each is a list item with 4, 5 or 9 elements. Borrowed during the replace call.
• GemFormattedProgramCapabilityCommand::required Field — RQCMD: true when every process program must contain this command.
• GemFormattedProgramCapabilityCommandInfo Struct — Shape of one command description of an S7F22 reply, returned by formattedProgramCapabilityCommandInfo().
• GemFormattedProgramCapabilityCommandInfo::after Field — ACDS value.
• GemFormattedProgramCapabilityCommandInfo::beforeCount Field — Entries in BCDS.
• GemFormattedProgramCapabilityCommandInfo::blockDefinition Field — BLKDEF of the command (-1, 0 or 1).
• GemFormattedProgramCapabilityCommandInfo::immediateAfterCount Field — Entries in IACDS.
• GemFormattedProgramCapabilityCommandInfo::immediateBeforeCount Field — Entries in IBCDS.
• GemFormattedProgramCapabilityCommandInfo::nonAfterCount Field — Entries in NACDS.
• GemFormattedProgramCapabilityCommandInfo::nonBeforeCount Field — Entries in NBCDS.
• GemFormattedProgramCapabilityCommandInfo::parameterCount Field — Parameter descriptions of the command.
• GemFormattedProgramCapabilityCommandInfo::required Field — RQCMD of the command.
• GemFormattedProgramCapabilityInfo Struct — Summary of an S7F21 request or S7F22 reply, returned by formattedProgramCapabilityInfo().
• GemFormattedProgramCapabilityInfo::byteMaximum Field — BYTMAX of an S7F22 reply: maximum bytes of one process program.
• GemFormattedProgramCapabilityInfo::commandCount Field — Command descriptions in an S7F22 reply; 0 for a request.
• GemFormattedProgramCapabilityInfo::commandMaximum Field — CMDMAX of an S7F22 reply: maximum commands in one process program.
• GemFormattedProgramCapabilityInfo::isRequest Field — true for an S7F21 received by the equipment.
• GemFormattedProgramCapabilityInfo::replyReady Field — true while a received S7F21 still waits for a response.
• GemFormattedProgramCapabilityInfo::request Field — Always GemRequest::FormattedProgramCapabilitySend.
• GemFormattedProgramCapabilityInfo::responded Field — true after respondFormattedProgramCapability() sent S7F22.
• GemFormattedProgramDryRunInfo Struct — Summary of a dry-run report, returned by GemFormattedProgramDryRunReport::info().
• GemFormattedProgramDryRunInfo::capabilityPresent Field — true when an S7F22 capability catalog was available for the comparison.
• GemFormattedProgramDryRunInfo::capabilityRevision Field — Revision of the capability catalog used for the comparison.
• GemFormattedProgramDryRunInfo::commandCount Field — Commands of the analysed program.
• GemFormattedProgramDryRunInfo::encodedBytes Field — Encoded size of the analysed program.
• GemFormattedProgramDryRunInfo::endpointId Field — Endpoint that produced the report.
• GemFormattedProgramDryRunInfo::entryGeneration Field — Entry generation of that selection.
• GemFormattedProgramDryRunInfo::idFormat Field — SECS-II format code of the PPID.
• GemFormattedProgramDryRunInfo::issueCount Field — Issues in the report.
• GemFormattedProgramDryRunInfo::outcome Field — Overall result, the most severe issue outcome: PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_PASS, ..._INDETERMINATE or ..._REJECT.
• GemFormattedProgramDryRunInfo::policyVersion Field — Policy used, for example PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_POLICY_V1.
• GemFormattedProgramDryRunInfo::selectionGeneration Field — Selection revision of that selection.
• GemFormattedProgramDryRunInfo::sessionGeneration Field — Connection generation of the selection that was analysed.
• GemFormattedProgramDryRunInfo::storeRevision Field — Store revision of that selection.
• GemFormattedProgramDryRunIssueInfo Struct — One finding of a dry-run report, returned by GemFormattedProgramDryRunReport::issue().
• GemFormattedProgramDryRunIssueInfo::code 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 Field — Program command the finding refers to; valid when its presence bit is set.
• GemFormattedProgramDryRunIssueInfo::expected Field — Expected limit or value; valid when its presence bit is set.
• GemFormattedProgramDryRunIssueInfo::fieldIndex Field — Field or parameter position the finding refers to; valid when its presence bit is set.
• GemFormattedProgramDryRunIssueInfo::observed Field — Observed value, such as a command count or byte count; valid when its presence bit is set.
• GemFormattedProgramDryRunIssueInfo::outcome Field — Severity of this finding: ..._PASS, ..._INDETERMINATE or ..._REJECT.
• GemFormattedProgramDryRunIssueInfo::presenceMask 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 Class — Read-only structural analysis of the selected formatted program.
• GemFormattedProgramDryRunReport::GemFormattedProgramDryRunReport Constructor — Creates an empty report that owns no native handle.
• GemFormattedProgramDryRunReport::GemFormattedProgramDryRunReport Constructor — Takes ownership of the native handle owned by other.
• GemFormattedProgramDryRunReport::GemFormattedProgramDryRunReport Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramDryRunReport::info Method — Returns the summary of the report.
• GemFormattedProgramDryRunReport::issue Method — Returns one finding of the report.
• GemFormattedProgramDryRunReport::model Method — Copies the MDLN of the analysed program.
• GemFormattedProgramDryRunReport::nativeHandle Method — Returns the owned native handle for read-only C API calls.
• GemFormattedProgramDryRunReport::operator bool Method — Reports whether the wrapper owns a native report.
• GemFormattedProgramDryRunReport::operator= Method — Releases the current handle, then takes ownership of the handle owned by other.
• GemFormattedProgramDryRunReport::operator= Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramDryRunReport::programId Method — Returns the PPID of the analysed program as an item.
• GemFormattedProgramDryRunReport::programIdBytes Method — Copies the raw PPID bytes of the analysed program.
• GemFormattedProgramDryRunReport::softwareRevision Method — Copies the SOFTREV of the analysed program.
• GemFormattedProgramDryRunReport::~GemFormattedProgramDryRunReport Method — Releases the native handle with pdcomm_gem_formatted_program_dry_run_destroy().
• GemFormattedProgramExecutionAction Class — One action that the library asks the application to perform for an execution.
• GemFormattedProgramExecutionAction::GemFormattedProgramExecutionAction Constructor — Creates an empty action that owns no native handle.
• GemFormattedProgramExecutionAction::GemFormattedProgramExecutionAction Constructor — Takes ownership of the native handle owned by other.
• GemFormattedProgramExecutionAction::GemFormattedProgramExecutionAction Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramExecutionAction::commandCode Method — Returns the CCODE of the command a step action asks to apply.
• GemFormattedProgramExecutionAction::info Method — Describes the action.
• GemFormattedProgramExecutionAction::model Method — Copies the MDLN carried by a start action.
• GemFormattedProgramExecutionAction::operator bool Method — Reports whether the wrapper owns a native action.
• GemFormattedProgramExecutionAction::operator= Method — Releases the current handle, then takes ownership of the handle owned by other.
• GemFormattedProgramExecutionAction::operator= Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramExecutionAction::parameter Method — Returns one PPARM of the command a step action asks to apply.
• GemFormattedProgramExecutionAction::programId Method — Returns the PPID carried by a start action.
• GemFormattedProgramExecutionAction::softwareRevision Method — Copies the SOFTREV carried by a start action.
• GemFormattedProgramExecutionAction::token Method — Returns the token to report this action's result with.
• GemFormattedProgramExecutionAction::~GemFormattedProgramExecutionAction Method — Releases the native handle with pdcomm_gem_formatted_program_execution_action_destroy().
• GemFormattedProgramExecutionActionInfo Struct — Description of one requested action, returned by GemFormattedProgramExecutionAction::info().
• GemFormattedProgramExecutionActionInfo::actionSequence Field — Sequence number of this action.
• GemFormattedProgramExecutionActionInfo::cancelNextCommandIndex Field — For a cancel action, the index of the first command that was not applied.
• GemFormattedProgramExecutionActionInfo::capabilityRevision Field — Capability catalog revision of the dry run.
• GemFormattedProgramExecutionActionInfo::codeFormat Field — SECS-II format code of the CCODE, for a step action.
• GemFormattedProgramExecutionActionInfo::commandCount Field — Commands of the executed program.
• GemFormattedProgramExecutionActionInfo::commandIndex Field — Program command a step action asks to apply.
• GemFormattedProgramExecutionActionInfo::dryRunOutcome Field — Dry-run outcome of the execution.
• GemFormattedProgramExecutionActionInfo::endpointId Field — Endpoint that runs the execution.
• GemFormattedProgramExecutionActionInfo::executionGeneration Field — Execution number.
• GemFormattedProgramExecutionActionInfo::idFormat Field — SECS-II format code of the PPID, for a start action.
• GemFormattedProgramExecutionActionInfo::kind Field — Action kind (PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_START, ..._STEP or ..._CANCEL).
• GemFormattedProgramExecutionActionInfo::parameterCount Field — PPARM items of the command of a step action.
• GemFormattedProgramExecutionActionInfo::policyVersion Field — Dry-run policy version of the execution.
• GemFormattedProgramExecutionActionInfo::presenceMask 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 Field — Connection generation of the execution.
• GemFormattedProgramExecutionActionToken Struct — Identifies one action that the library asks the application to perform.
• GemFormattedProgramExecutionActionToken::actionSequence Field — Sequence number of the action within the execution; the start action is 1.
• GemFormattedProgramExecutionActionToken::endpointId Field — Identity of the endpoint that runs the execution.
• GemFormattedProgramExecutionActionToken::executionGeneration Field — Execution number the action belongs to.
• GemFormattedProgramExecutionActionToken::kind Field — Action kind: PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_ACTION_START, ..._ACTION_STEP or ..._ACTION_CANCEL.
• GemFormattedProgramExecutionActionToken::sessionGeneration Field — HSMS connection generation of the execution.
• GemFormattedProgramExecutionCommandInfo Struct — Shape of one command of the executed program, returned by GemFormattedProgramExecutionSnapshot::commandInfo().
• GemFormattedProgramExecutionCommandInfo::codeFormat Field — SECS-II format code of the CCODE item.
• GemFormattedProgramExecutionCommandInfo::parameterCount Field — Number of PPARM items of the command.
• GemFormattedProgramExecutionInfo Struct — State of the equipment's formatted program execution, returned by GemFormattedProgramExecutionSnapshot::info().
• GemFormattedProgramExecutionInfo::applicationDetailLength Field — Length of the application detail bytes.
• GemFormattedProgramExecutionInfo::applicationReportId Field — Report ID passed to completeFormattedProgramExecution(); valid when its presence bit is set.
• GemFormattedProgramExecutionInfo::applicationReportKind Field — Final report submitted by the application: 0 (none), PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_TERMINAL_COMPLETE, ..._TERMINAL_FAIL or ..._TERMINAL_OUTCOME_UNKNOWN.
• GemFormattedProgramExecutionInfo::capabilityPresent Field — true when the dry run used a capability catalog.
• GemFormattedProgramExecutionInfo::capabilityRevision Field — Capability catalog revision of the dry run.
• GemFormattedProgramExecutionInfo::commandCount Field — Commands of the executed program.
• GemFormattedProgramExecutionInfo::dryRunOutcome Field — Outcome of the dry run the execution was started with (PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_*).
• GemFormattedProgramExecutionInfo::endpointId Field — Endpoint that runs the execution.
• GemFormattedProgramExecutionInfo::entryGeneration Field — Entry generation of the selection that was executed.
• GemFormattedProgramExecutionInfo::executionGeneration Field — Execution number.
• GemFormattedProgramExecutionInfo::idFormat Field — SECS-II format code of the executed PPID.
• GemFormattedProgramExecutionInfo::nextCommandIndex Field — Index of the next command a step would request; equals #commandCount when all commands were applied.
• GemFormattedProgramExecutionInfo::pendingActionSequence Field — Sequence number of the pending action; valid when its presence bit is set.
• GemFormattedProgramExecutionInfo::pendingKind Field — Kind of the action waiting for a result (..._ACTION_*), or ..._ACTION_NONE.
• GemFormattedProgramExecutionInfo::policyVersion Field — Dry-run policy version of that report.
• GemFormattedProgramExecutionInfo::presenceMask Field — Which optional data is present: PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_PENDING_ACTION_PRESENT, ..._APPLICATION_REPORT_PRESENT and ..._APPLICATION_DETAIL_PRESENT bits.
• GemFormattedProgramExecutionInfo::selectionGeneration Field — Selection revision that was executed.
• GemFormattedProgramExecutionInfo::sessionGeneration Field — Connection generation of the execution.
• GemFormattedProgramExecutionInfo::state 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 Field — Store revision of the selection that was executed.
• GemFormattedProgramExecutionSnapshot Class — Immutable copy of the equipment's formatted program execution state.
• GemFormattedProgramExecutionSnapshot::GemFormattedProgramExecutionSnapshot Constructor — Creates an empty snapshot that owns no native handle.
• GemFormattedProgramExecutionSnapshot::GemFormattedProgramExecutionSnapshot Constructor — Takes ownership of the native handle owned by other.
• GemFormattedProgramExecutionSnapshot::GemFormattedProgramExecutionSnapshot Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramExecutionSnapshot::applicationDetail Method — Copies the detail bytes passed to completeFormattedProgramExecution().
• GemFormattedProgramExecutionSnapshot::commandCode Method — Returns the CCODE of one command of the executed program.
• GemFormattedProgramExecutionSnapshot::commandInfo Method — Describes one command of the executed program.
• GemFormattedProgramExecutionSnapshot::info Method — Returns the execution state captured in the snapshot.
• GemFormattedProgramExecutionSnapshot::model Method — Copies the MDLN of the executed program.
• GemFormattedProgramExecutionSnapshot::nativeHandle Method — Returns the owned native handle for read-only C API calls.
• GemFormattedProgramExecutionSnapshot::operator bool Method — Reports whether the wrapper owns a native snapshot.
• GemFormattedProgramExecutionSnapshot::operator= Method — Releases the current handle, then takes ownership of the handle owned by other.
• GemFormattedProgramExecutionSnapshot::operator= Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramExecutionSnapshot::parameter Method — Returns one PPARM of one command of the executed program.
• GemFormattedProgramExecutionSnapshot::programId Method — Returns the PPID of the executed program.
• GemFormattedProgramExecutionSnapshot::softwareRevision Method — Copies the SOFTREV of the executed program.
• GemFormattedProgramExecutionSnapshot::~GemFormattedProgramExecutionSnapshot Method — Releases the native handle with pdcomm_gem_formatted_program_execution_snapshot_destroy().
• GemFormattedProgramExecutionStart Struct — Result of startFormattedProgramExecution(): the execution token and its start action.
• GemFormattedProgramExecutionStart::action Field — Start action to perform and resolve.
• GemFormattedProgramExecutionStart::token Field — Token of the new execution.
• GemFormattedProgramExecutionToken Struct — Identifies one execution of a selected formatted program.
• GemFormattedProgramExecutionToken::endpointId Field — Identity of the endpoint that runs the execution.
• GemFormattedProgramExecutionToken::executionGeneration Field — Execution number; it increases with every new execution.
• GemFormattedProgramExecutionToken::sessionGeneration Field — HSMS connection generation when the execution started.
• GemFormattedProgramInfo Struct — Summary of an S7F27 request or S7F28 reply, returned by formattedProgramInfo().
• GemFormattedProgramInfo::idFormat Field — SECS-II format code of the PPID (PDCOMM_SECS_ASCII or PDCOMM_SECS_BINARY); 0 when the result has no report.
• GemFormattedProgramInfo::isRequest Field — true for an S7F27 received by a host.
• GemFormattedProgramInfo::issueCount Field — Number of verification entries in the report; 0 for a reply.
• GemFormattedProgramInfo::replyReady Field — true while a received S7F27 still waits for respondFormattedProgram().
• GemFormattedProgramInfo::request Field — Always GemRequest::FormattedProgramSend.
• GemFormattedProgramInfo::responded Field — true after respondFormattedProgram() sent S7F28.
• GemFormattedProgramIssue Struct — One verification result entry of S7F27 Process Program Verification Send.
• GemFormattedProgramIssue::code Field — ACKC7A result code, 0 to 5 (0 means the command is accepted).
• GemFormattedProgramIssue::sequence Field — SEQNUM: number of the process program command the entry refers to.
• GemFormattedProgramIssue::text Field — ERRW7 error text, ASCII; may be empty.
• GemFormattedProgramQueryCommand Struct — One process program command (CCODE with its PPARM list) of a program that the equipment can return in S7F26.
• GemFormattedProgramQueryCommand::code Field — Command code (CCODE): an ASCII item or an unsigned integer scalar (U1, U2, U4 or U8).
• GemFormattedProgramQueryCommand::parameters Field — Command parameters (PPARM) in order; any item format.
• GemFormattedProgramQueryCommandInfo Struct — Shape of one command of a returned program, returned by formattedProgramQueryCommandInfo().
• GemFormattedProgramQueryCommandInfo::codeFormat Field — SECS-II format code of the CCODE item.
• GemFormattedProgramQueryCommandInfo::parameterCount Field — Number of PPARM items of the command.
• GemFormattedProgramQueryInfo Struct — Summary of an S7F25 request or S7F26 reply, returned by formattedProgramQueryInfo().
• GemFormattedProgramQueryInfo::commandCount Field — Commands of the returned program; 0 when no program is known or present.
• GemFormattedProgramQueryInfo::idFormat Field — SECS-II format code of the requested PPID.
• GemFormattedProgramQueryInfo::isRequest Field — true for an S7F25 received by the equipment.
• GemFormattedProgramQueryInfo::present Field — true when the answer contains the program; false for an empty S7F26 (program absent). Meaningful only when #presentKnown is true.
• GemFormattedProgramQueryInfo::presentKnown Field — true once the answer is known: for a received S7F26, or for a request after its response was prepared.
• GemFormattedProgramQueryInfo::replyReady Field — true while a received S7F25 still waits for a response.
• GemFormattedProgramQueryInfo::request Field — Always GemRequest::FormattedProgramQuerySend.
• GemFormattedProgramQueryInfo::responded Field — true after respondFormattedProgramQuery() sent S7F26.
• GemFormattedProgramSelectionCommandInfo Struct — Shape of one command of the selected program, returned by GemFormattedProgramSelectionSnapshot::commandInfo().
• GemFormattedProgramSelectionCommandInfo::codeFormat Field — SECS-II format code of the CCODE item.
• GemFormattedProgramSelectionCommandInfo::parameterCount Field — Number of PPARM items of the command.
• GemFormattedProgramSelectionInfo Struct — State of the equipment's formatted program selection, returned by GemFormattedProgramSelectionSnapshot::info().
• GemFormattedProgramSelectionInfo::commandCount Field — Commands of the selected program.
• GemFormattedProgramSelectionInfo::entryGeneration Field — Entry generation captured by the selection.
• GemFormattedProgramSelectionInfo::idFormat Field — SECS-II format code of the selected PPID; 0 when empty.
• GemFormattedProgramSelectionInfo::selectionGeneration Field — Selection revision; for an empty selection the current revision.
• GemFormattedProgramSelectionInfo::sessionGeneration Field — Connection generation captured by the selection.
• GemFormattedProgramSelectionInfo::staleReason 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 Field — PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_EMPTY, ..._READY or ..._STALE.
• GemFormattedProgramSelectionInfo::storeRevision Field — Store revision captured by the selection.
• GemFormattedProgramSelectionInfo::validForExecution Field — true only in the ready state.
• GemFormattedProgramSelectionSnapshot Class — Immutable copy of the equipment's formatted program selection.
• GemFormattedProgramSelectionSnapshot::GemFormattedProgramSelectionSnapshot Constructor — Creates an empty snapshot that owns no native handle.
• GemFormattedProgramSelectionSnapshot::GemFormattedProgramSelectionSnapshot Constructor — Takes ownership of the native handle owned by other.
• GemFormattedProgramSelectionSnapshot::GemFormattedProgramSelectionSnapshot Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramSelectionSnapshot::commandCode Method — Returns the CCODE of one command of the selected program.
• GemFormattedProgramSelectionSnapshot::commandInfo Method — Describes one command of the selected program.
• GemFormattedProgramSelectionSnapshot::id Method — Returns the PPID of the selected program.
• GemFormattedProgramSelectionSnapshot::info Method — Returns the selection state captured in the snapshot.
• GemFormattedProgramSelectionSnapshot::model Method — Copies the MDLN of the selected program.
• GemFormattedProgramSelectionSnapshot::operator bool Method — Reports whether the wrapper owns a native snapshot.
• GemFormattedProgramSelectionSnapshot::operator= Method — Releases the current handle, then takes ownership of the handle owned by other.
• GemFormattedProgramSelectionSnapshot::operator= Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramSelectionSnapshot::parameter Method — Returns one PPARM of one command of the selected program.
• GemFormattedProgramSelectionSnapshot::softwareRevision Method — Copies the SOFTREV of the selected program.
• GemFormattedProgramSelectionSnapshot::~GemFormattedProgramSelectionSnapshot Method — Releases the native handle with pdcomm_gem_formatted_program_selection_snapshot_destroy().
• GemFormattedProgramSelectionToken Struct — Identifies one selection of a formatted program on one equipment endpoint.
• GemFormattedProgramSelectionToken::endpointId Field — Identity of the endpoint that made the selection.
• GemFormattedProgramSelectionToken::entryGeneration Field — Generation of the selected store entry when it was selected.
• GemFormattedProgramSelectionToken::selectionGeneration Field — Selection revision; it increases whenever a different selection is made or cleared.
• GemFormattedProgramSelectionToken::sessionGeneration Field — HSMS connection generation when the program was selected.
• GemFormattedProgramSelectionToken::storeRevision Field — Formatted program store revision when the program was selected.
• GemFormattedProgramStoreAction Enum — How a write treats an existing program in the equipment's formatted program store.
• GemFormattedProgramStoreAction::CreateOnly Enumerator — Store only when the PPID is not stored yet.
• GemFormattedProgramStoreAction::ReplaceOnly Enumerator — Store only when the PPID is already stored.
• GemFormattedProgramStoreAction::RespondOnly Enumerator — Store nothing; only acknowledge. Valid only for respondFormattedProgramTransferAndStore().
• GemFormattedProgramStoreAction::Upsert Enumerator — Create or replace.
• GemFormattedProgramStoreCommand Struct — One process program command (CCODE with its PPARM list) for putFormattedProgramStore().
• GemFormattedProgramStoreCommand::code Field — Command code (CCODE): an ASCII item or an unsigned integer scalar (U1, U2, U4 or U8).
• GemFormattedProgramStoreCommand::parameters Field — Command parameters (PPARM) in order; any item format.
• GemFormattedProgramStoreCommandInfo Struct — Shape of one command of a stored program, returned by GemFormattedProgramStoreSnapshot::commandInfo().
• GemFormattedProgramStoreCommandInfo::codeFormat Field — SECS-II format code of the CCODE item.
• GemFormattedProgramStoreCommandInfo::parameterCount Field — Number of PPARM items of the command.
• GemFormattedProgramStoreEntryInfo Struct — Shape of one stored program, returned by GemFormattedProgramStoreSnapshot::entryInfo().
• GemFormattedProgramStoreEntryInfo::commandCount Field — Commands of the program.
• GemFormattedProgramStoreEntryInfo::idFormat Field — SECS-II format code of the PPID (PDCOMM_SECS_ASCII or PDCOMM_SECS_BINARY).
• GemFormattedProgramStoreInfo Struct — Counters and limits of the equipment's formatted program store.
• GemFormattedProgramStoreInfo::encodedBytes Field — Total encoded bytes of the stored programs.
• GemFormattedProgramStoreInfo::entryCount Field — Stored programs.
• GemFormattedProgramStoreInfo::identifierBytes Field — Total PPID bytes of the stored programs.
• GemFormattedProgramStoreInfo::maxEncodedBytes Field — Configured maximum total encoded bytes.
• GemFormattedProgramStoreInfo::maxEntries Field — Configured maximum number of programs.
• GemFormattedProgramStoreInfo::maxIdentifierBytes Field — Configured maximum total PPID bytes.
• GemFormattedProgramStoreInfo::revision Field — Store revision; it increases on every change.
• GemFormattedProgramStoreSnapshot Class — Immutable copy of the equipment's formatted program store.
• GemFormattedProgramStoreSnapshot::GemFormattedProgramStoreSnapshot Constructor — Creates an empty snapshot that owns no native handle.
• GemFormattedProgramStoreSnapshot::GemFormattedProgramStoreSnapshot Constructor — Takes ownership of the native handle owned by other.
• GemFormattedProgramStoreSnapshot::GemFormattedProgramStoreSnapshot Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramStoreSnapshot::commandCode Method — Returns the CCODE of one command of one stored program.
• GemFormattedProgramStoreSnapshot::commandInfo Method — Describes one command of one stored program.
• GemFormattedProgramStoreSnapshot::entryInfo Method — Describes one stored program.
• GemFormattedProgramStoreSnapshot::id Method — Returns the PPID of one stored program.
• GemFormattedProgramStoreSnapshot::info Method — Returns the counters and limits captured in the snapshot.
• GemFormattedProgramStoreSnapshot::model Method — Copies the MDLN of one stored program.
• GemFormattedProgramStoreSnapshot::operator bool Method — Reports whether the wrapper owns a native snapshot.
• GemFormattedProgramStoreSnapshot::operator= Method — Releases the current handle, then takes ownership of the handle owned by other.
• GemFormattedProgramStoreSnapshot::operator= Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• GemFormattedProgramStoreSnapshot::parameter Method — Returns one PPARM of one command of one stored program.
• GemFormattedProgramStoreSnapshot::softwareRevision Method — Copies the SOFTREV of one stored program.
• GemFormattedProgramStoreSnapshot::~GemFormattedProgramStoreSnapshot Method — Releases the native handle with pdcomm_gem_formatted_program_store_snapshot_destroy().
• GemFormattedProgramTransferCommand Struct — One process program command (CCODE with its PPARM list) for S7F23.
• GemFormattedProgramTransferCommand::code Field — Command code (CCODE): an ASCII item or an unsigned integer scalar (U1, U2, U4 or U8).
• GemFormattedProgramTransferCommand::parameters Field — Command parameters (PPARM) in order; any item format.
• GemFormattedProgramTransferCommandInfo Struct — Shape of one command of a received S7F23, returned by formattedProgramTransferCommandInfo().
• GemFormattedProgramTransferCommandInfo::codeFormat Field — SECS-II format code of the CCODE item.
• GemFormattedProgramTransferCommandInfo::parameterCount Field — Number of PPARM items of the command.
• GemFormattedProgramTransferInfo Struct — Summary of an S7F23 request or S7F24 reply, returned by formattedProgramTransferInfo().
• GemFormattedProgramTransferInfo::acknowledgement Field — ACKC7 of the S7F24 reply, 0 to 7 (0 means accepted).
• GemFormattedProgramTransferInfo::acknowledgementPresent Field — true when #acknowledgement holds the sent or received ACKC7.
• GemFormattedProgramTransferInfo::commandCount Field — Number of commands in the received program; 0 for a reply.
• GemFormattedProgramTransferInfo::idFormat Field — SECS-II format code of the PPID (PDCOMM_SECS_ASCII or PDCOMM_SECS_BINARY).
• GemFormattedProgramTransferInfo::isRequest Field — true for an S7F23 received by the equipment.
• GemFormattedProgramTransferInfo::replyReady Field — true while a received S7F23 still waits for a response.
• GemFormattedProgramTransferInfo::request Field — Always GemRequest::FormattedProgramTransferSend.
• GemFormattedProgramTransferInfo::responded Field — true after the equipment sent S7F24.
• GemFormattedProgramVerificationNegotiationInfo Struct — State of one verification negotiation, returned by formattedProgramVerificationNegotiationInfo().
• GemFormattedProgramVerificationNegotiationInfo::correlation Field — Sequence number that identifies the negotiation; the prepared result and all later results of the same negotiation share it.
• GemFormattedProgramVerificationNegotiationInfo::length Field — LENGTH sent in S7F29: the byte length of the prepared S7F27 body.
• GemFormattedProgramVerificationNegotiationInfo::negotiationTerminal Field — Outcome of the S7F29/F30 stage: PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_TERMINAL_NONE, ..._GRANTED, ..._DENIED, ..._TIMED_OUT or ..._DISCONNECTED.
• GemFormattedProgramVerificationNegotiationInfo::ppGnt Field — PPGNT from S7F30; valid when #ppGntPresent is true (0 means granted).
• GemFormattedProgramVerificationNegotiationInfo::ppGntPresent Field — true once a grant or denial was received or sent.
• GemFormattedProgramVerificationNegotiationInfo::prepared Field — true for equipment-side results of a prepared negotiation.
• GemFormattedProgramVerificationNegotiationInfo::replyReady Field — true while a received S7F29 still waits for a response.
• GemFormattedProgramVerificationNegotiationInfo::request Field — Always GemRequest::FormattedProgramVerificationNegotiationSend.
• GemFormattedProgramVerificationNegotiationInfo::responded Field — true after the host sent S7F30.
• GemFormattedProgramVerificationNegotiationInfo::state Field — Negotiation state: PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_STATE_PREPARED, ..._STATE_RECEIVED or ..._STATE_RESPONDED.
• GemFormattedProgramVerificationNegotiationInfo::submitted Field — true after S7F29 was sent.
• GemFormattedProgramVerificationNegotiationInfo::verificationTerminal 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 Struct — One verification result entry (ACKC7A, SEQNUM, ERRW7) of the S7F27 report that a negotiation sends after the host's grant.
• GemFormattedProgramVerificationNegotiationIssue::code Field — ACKC7A result code, 0 to 5 (0 means the command is accepted).
• GemFormattedProgramVerificationNegotiationIssue::sequence Field — SEQNUM: number of the process program command the entry refers to.
• GemFormattedProgramVerificationNegotiationIssue::text Field — ERRW7 error text, ASCII; may be empty.
• GemFormattedProgramVerificationRequestCommand Struct — One process program command (CCODE with its PPARM list) for S7F31.
• GemFormattedProgramVerificationRequestCommand::code Field — Command code (CCODE): an ASCII item or an unsigned integer scalar (U1, U2, U4 or U8).
• GemFormattedProgramVerificationRequestCommand::parameters Field — Command parameters (PPARM) in order; any item format.
• GemFormattedProgramVerificationRequestCommandInfo Struct — Shape of one command of a received S7F31, returned by formattedProgramVerificationRequestCommandInfo().
• GemFormattedProgramVerificationRequestCommandInfo::codeFormat Field — SECS-II format code of the CCODE item.
• GemFormattedProgramVerificationRequestCommandInfo::parameterCount Field — Number of PPARM items of the command.
• GemFormattedProgramVerificationRequestInfo Struct — Summary of an S7F31 request or S7F32 reply, returned by formattedProgramVerificationRequestInfo().
• GemFormattedProgramVerificationRequestInfo::acknowledgement Field — ACKC7 of the S7F32 reply, 0 to 7 (0 means accepted).
• GemFormattedProgramVerificationRequestInfo::acknowledgementPresent Field — true when #acknowledgement holds the sent or received ACKC7.
• GemFormattedProgramVerificationRequestInfo::commandCount Field — Number of commands in the received request; 0 for a reply.
• GemFormattedProgramVerificationRequestInfo::idFormat Field — SECS-II format code of the PPID (PDCOMM_SECS_ASCII or PDCOMM_SECS_BINARY).
• GemFormattedProgramVerificationRequestInfo::isRequest Field — true for an S7F31 received by the equipment.
• GemFormattedProgramVerificationRequestInfo::replyReady Field — true while a received S7F31 still waits for a response.
• GemFormattedProgramVerificationRequestInfo::request Field — Always GemRequest::FormattedProgramVerificationRequestSend.
• GemFormattedProgramVerificationRequestInfo::responded Field — true after the equipment sent S7F32.
• GemHost Class — GEM host role (SEMI E30) on one HSMS endpoint (SEMI E37).
• GemHost::GemHost Constructor — Takes ownership of endpoint and configures it as a GEM host.
• GemHost::acknowledgeAlarm Method — Sends S5F2 for a received S5F1 alarm report that expects a reply.
• GemHost::acknowledgeEvent Method — Sends S6F12 for a received S6F11 event report.
• GemHost::annotatedQuery Method — Sends S6F21 Annotated Individual Report Request.
• GemHost::beginCommunication Method — Sends S1F13 Establish Communications Request.
• GemHost::changeConstants Method — Sends S2F15 New Equipment Constant Send.
• GemHost::configureRemoteSpooling Method — Sends S2F43 Reset Spooling Streams and Functions.
• GemHost::configureSpoolHost Method — Enables the host spool requests (S2F43, S2F59, S6F23) with the given limits.
• GemHost::constantMetadata Method — Sends S2F29 Equipment Constant Namelist Request.
• GemHost::constantRequest Method — Sends S2F13 (values) or S2F29 (namelist) for equipment constants.
• GemHost::constantValues Method — Sends S2F13 Equipment Constant Request.
• GemHost::dataDirectory Method — Sends S1F21 Data Variable Namelist Request.
• GemHost::defineReports Method — Sends S2F33 Define Report.
• GemHost::directoryRequest Method — Sends S1F21 (data variables) or S1F23 (collection events) namelist request.
• GemHost::enableAlarm Method — Sends S5F3 Enable/Disable Alarm Send.
• GemHost::enableEvents Method — Sends S2F37 Enable/Disable Event Report.
• GemHost::enhancedRemoteCommand Method — Sends S2F49 Enhanced Remote Command.
• GemHost::eventDirectory Method — Sends S1F23 Collection Event Namelist Request.
• GemHost::eventQuery Method — Sends S6F15 Event Report Request.
• GemHost::individualQuery Method — Sends S6F19 Individual Report Request.
• GemHost::linkReports Method — Sends S2F35 Link Event Report.
• GemHost::programDelete Method — Sends S7F17 Delete Process Program Send.
• GemHost::programDirectory Method — Sends S7F19 Current Process Program Directory Request (header only).
• GemHost::queryRemoteSpooling Method — Sends S2F59 to query the equipment's current spooling selection.
• GemHost::remoteCommand Method — Sends S2F41 Host Command Send.
• GemHost::reportQuery Method — Sends one report query: S6F15, S6F19 or S6F21.
• GemHost::request Method — Sends a basic stream 1 request.
• GemHost::requestAlarmList Method — Sends S5F5 List Alarms Request.
• GemHost::requestEnabledAlarmList Method — Sends S5F7 List Enabled Alarm Request.
• GemHost::requestSpooledData Method — Sends S6F23 Request Spooled Data.
• GemInt128 Struct — Signed 128-bit integer stored as two's complement: high * 2^64 + low.
• GemInt128::fromSigned Method — Converts a signed 64-bit value with sign extension.
• GemInt128::fromUnsigned Method — Converts an unsigned 64-bit value.
• GemInt128::high Field — High 64 bits, including the sign.
• GemInt128::low Field — Low 64 bits.
• GemInt128::native Method — Converts to the C representation.
• GemLinkSpec Struct — One event-to-report link for S2F35.
• GemLinkSpec::eventId Field — Collection event ID (CEID).
• GemLinkSpec::reportIds Field — Report IDs to link, in order. An empty list unlinks the event.
• GemOnlineMode Enum — Online substate the equipment enters when it goes online.
• GemOnlineMode::Local Enumerator — Enter GemControl::OnlineLocal.
• GemOnlineMode::Remote Enumerator — Enter GemControl::OnlineRemote.
• GemOnlineMode::Unavailable Enumerator — No online mode exists, which is the case for the host role.
• GemOutcome Enum — What a GemResult means, beyond its GemResultKind.
• GemOutcome::AlarmAck Enumerator — Equipment received S5F2; ACKC5 is in GemResultInfo::acknowledgement.
• GemOutcome::AlarmEnableAck Enumerator — S5F4 ACKC5 was received (host) or sent (equipment).
• GemOutcome::AlarmListReceived Enumerator — Host received S5F6; read alarms with GemResult::alarmAt().
• GemOutcome::AlarmListReplied Enumerator — Equipment answered S5F5 with S5F6.
• GemOutcome::AlarmReceived Enumerator — Host received S5F1. A W-bit report needs GemHost::acknowledgeAlarm().
• GemOutcome::AlreadyOnline Enumerator — Equipment replied S1F18 with ONLACK 2 because it is already online.
• GemOutcome::AnnotatedQueryReceived Enumerator — Host received S6F22.
• GemOutcome::CommandAck Enumerator — Host received S2F42; HCACK is in GemResultInfo::acknowledgement.
• GemOutcome::CommandReceived Enumerator — Equipment received S2F41. Nothing was executed or acknowledged; call GemEquipment::respondCommand().
• GemOutcome::CommunicationEstablished Enumerator — S1F13/F14 succeeded with COMMACK 0; the communication state is Communicating.
• GemOutcome::CommunicationRejected Enumerator — S1F14 carried a nonzero COMMACK, available in GemResultInfo::acknowledgement.
• GemOutcome::ConstantChangeAck Enumerator — Host received S2F16; EAC is in GemResultInfo::acknowledgement.
• GemOutcome::ConstantChangesReceived Enumerator — Equipment received S2F15; nothing is applied until GemEquipment::respondConstants().
• GemOutcome::ConstantMetadataReceived Enumerator — Host received S2F30; read rows with GemResult::constantMetadata().
• GemOutcome::ConstantMetadataReplied Enumerator — Equipment answered S2F29 with S2F30.
• GemOutcome::ConstantValuesReceived Enumerator — Host received S2F14; read values with GemResult::constantValue().
• GemOutcome::ConstantValuesReplied Enumerator — Equipment answered S2F13 with S2F14.
• GemOutcome::DataDirectoryReceived Enumerator — Host received S1F22; read rows with GemResult::directoryAt() and GemResult::directoryGet().
• GemOutcome::DataDirectoryReplied Enumerator — Equipment answered S1F21 with S1F22.
• GemOutcome::DefineReportsAck Enumerator — S2F34 DRACK was received (host) or sent (equipment); the code is in GemResultInfo::acknowledgement.
• GemOutcome::EnableEventsAck Enumerator — S2F38 ERACK was received (host) or sent (equipment).
• GemOutcome::EnabledAlarmListReceived Enumerator — Host received S5F8; read alarms with GemResult::alarmAt().
• GemOutcome::EnabledAlarmListReplied Enumerator — Equipment answered S5F7 with S5F8.
• GemOutcome::EnhancedCommandAck Enumerator — Host received S2F50; HCACK is in GemResultInfo::acknowledgement.
• GemOutcome::EnhancedCommandReceived Enumerator — Equipment received S2F49; call GemEquipment::respondEnhancedCommand().
• GemOutcome::EquipmentIdentity Enumerator — Host received S1F2 with the equipment model (MDLN) and software revision (SOFTREV).
• GemOutcome::EventAck Enumerator — Equipment received S6F12; ACKC6 is in GemResultInfo::acknowledgement.
• GemOutcome::EventDirectoryReceived Enumerator — Host received S1F24; read rows with GemResult::directoryAt() and GemResult::directoryGet().
• GemOutcome::EventDirectoryReplied Enumerator — Equipment answered S1F23 with S1F24.
• GemOutcome::EventQueryReceived Enumerator — Host received S6F16.
• GemOutcome::EventReceived Enumerator — Host received S6F11. No acknowledgement was sent; call GemHost::acknowledgeEvent().
• GemOutcome::FormattedProgramAcknowledgement Enumerator — Equipment received S7F28.
• GemOutcome::FormattedProgramCapabilityReceived Enumerator — Equipment received S7F21 Process Capability Request.
• GemOutcome::FormattedProgramCapabilityResult Enumerator — Host received S7F22.
• GemOutcome::FormattedProgramQueryReceived Enumerator — Equipment received S7F25 Formatted Process Program Request.
• GemOutcome::FormattedProgramQueryResult Enumerator — Host received S7F26.
• GemOutcome::FormattedProgramReceived Enumerator — Host received S7F27 Process Program Verification Send.
• GemOutcome::FormattedProgramTransferAcknowledgement Enumerator — Host received S7F24; ACKC7 is in GemResultInfo::acknowledgement.
• GemOutcome::FormattedProgramTransferReceived Enumerator — Equipment received S7F23 Formatted Process Program Send.
• GemOutcome::FormattedProgramVerificationNegotiationAcknowledgement Enumerator — Equipment received S7F28 for the S7F27 sent after a grant.
• GemOutcome::FormattedProgramVerificationNegotiationGrant Enumerator — Equipment received S7F30 with the host's PPGNT.
• GemOutcome::FormattedProgramVerificationNegotiationReceived Enumerator — Host received S7F29 Process Program Verification Inquire.
• GemOutcome::FormattedProgramVerificationRequestAcknowledgement Enumerator — Host received S7F32.
• GemOutcome::FormattedProgramVerificationRequestReceived Enumerator — Equipment received S7F31 Verification Request Send.
• GemOutcome::IndividualQueryReceived Enumerator — Host received S6F20.
• GemOutcome::LinkReportsAck Enumerator — S2F36 LRACK was received (host) or sent (equipment).
• GemOutcome::NamesReceived Enumerator — Host received S1F12 status names; read them with GemResult::statusName().
• GemOutcome::None Enumerator — No specific outcome, for example on Ignored, Failed or Unhandled results.
• GemOutcome::OfflineAccepted Enumerator — Equipment accepted S1F15 and replied S1F16 with OFLACK 0.
• GemOutcome::OfflineAck Enumerator — Host received S1F16; OFLACK is in GemResultInfo::acknowledgement.
• GemOutcome::OnlineAccepted Enumerator — Equipment went online: it accepted S1F17 (ONLACK 0), or the host answered the operator-initiated S1F1.
• GemOutcome::OnlineAck Enumerator — Host received S1F18; ONLACK is in GemResultInfo::acknowledgement.
• GemOutcome::OnlineRejected Enumerator — Equipment refused to go online; the ONLACK is in GemResultInfo::acknowledgement.
• GemOutcome::ProgramAckReceived Enumerator — S7F4 or S7F18 arrived; ACKC7 is in GemResultInfo::acknowledgement.
• GemOutcome::ProgramDataReceived Enumerator — S7F6 arrived; read it with GemResult::programItem().
• GemOutcome::ProgramDirectoryReceived Enumerator — S7F20 arrived; read IDs with GemResult::programItem().
• GemOutcome::ProgramGrantReceived Enumerator — S7F2 arrived; PPGNT is in GemResultInfo::acknowledgement.
• GemOutcome::ProgramReceived Enumerator — A process program request (S7F1, S7F3 or S7F5, or S7F17/S7F19 at the equipment) arrived; call GemEndpoint::respondProgram().
• GemOutcome::Replied 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 Enumerator — Equipment received S6F15, S6F19 or S6F21; call GemEquipment::respondReportQuery().
• GemOutcome::SpoolConfigurationAck Enumerator — Host received S2F44; read rejected streams with GemResult::spoolError().
• GemOutcome::SpoolConfigurationData Enumerator — Host received S2F60; read selections with GemResult::spoolSelection().
• GemOutcome::SpoolControlAck Enumerator — Host received S6F24; RSDA is in GemResultInfo::acknowledgement.
• GemOutcome::SpoolDeliveryFailed Enumerator — A spooled delivery attempt failed; the entry stays at the head of the spool.
• GemOutcome::SpoolDeliveryResponse Enumerator — Equipment received the reply to a spooled W-bit message. Inspect the body, then call GemEndpoint::completeSpoolDelivery().
• GemOutcome::SpoolDeliveryWritten Enumerator — A spooled message without W-bit was fully written to the socket.
• GemOutcome::SpoolReceived Enumerator — Equipment received S2F43, S2F59 or S6F23; call GemEndpoint::respondSpool().
• GemOutcome::StatusReplied Enumerator — Equipment answered a status request (S1F3 or S1F11) from its registered status variables.
• GemOutcome::ValuesReceived Enumerator — Host received S1F4 status values; read them with GemResult::statusValue().
• GemProgramDurability Enum — Durability reached by a process program store mutation.
• GemProgramDurability::Confirmed Enumerator — The application accepted an unconfirmed installation with GemEndpoint::confirmProgramReply(). This is not a synchronization.
• GemProgramDurability::None Enumerator — Nothing was installed.
• GemProgramDurability::Synced Enumerator — Written to the file and the parent directory was synchronized.
• GemProgramDurability::Unconfirmed Enumerator — Installed, but synchronizing the parent directory failed; the call reported PDCOMM_PROGRAM_UNCONFIRMED.
• GemProgramDurability::Volatile Enumerator — Installed in memory only (no file was configured).
• GemProgramEntry Struct — One stored process program, returned by GemEndpoint::programAt().
• GemProgramEntry::body Field — Program body (PPBODY).
• GemProgramEntry::id Field — Program ID (PPID): non-empty ASCII or Binary.
• GemProgramField Enum — Field selector for GemResult::programItem().
• GemProgramField::Body Enumerator — Process program body (PPBODY).
• GemProgramField::Id Enumerator — Process program ID (PPID).
• GemProgramGrantPolicy Enum — Whether an incoming S7F3 needs a preceding S7F1/F2 grant.
• GemProgramGrantPolicy::Optional Enumerator — S7F3 is accepted with or without a grant.
• GemProgramGrantPolicy::Required Enumerator — S7F3 must follow a granted S7F1 for the same ID and length.
• GemProgramInfo Struct — Summary of a process program request or reply, returned by GemResult::programInfo().
• GemProgramInfo::acknowledgement Field — Reply code (PPGNT or ACKC7); valid when #acknowledgementPresent is true.
• GemProgramInfo::acknowledgementPresent Field — true when #acknowledgement is set.
• GemProgramInfo::applied Field — true when processing the request changed the local store.
• GemProgramInfo::confirmationRequired Field — true when the reply waits for GemEndpoint::confirmProgramReply() after an unconfirmed installation.
• GemProgramInfo::declaredLength Field — LENGTH from an S7F1 request; 0 for other messages.
• GemProgramInfo::durability Field — Durability reached while processing a request.
• GemProgramInfo::grantActivated Field — true when an S7F2 grant was activated for this request; not a liveness indicator.
• GemProgramInfo::idCount 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 Field — true for an incoming request.
• GemProgramInfo::persistenceStatus Field — Status of the persistence step while processing a request.
• GemProgramInfo::replyReady Field — true when a prepared reply is retained for retry.
• GemProgramInfo::request Field — Program transaction kind.
• GemProgramInfo::responded Field — true after GemEndpoint::respondProgram() sent the reply.
• GemProgramMode Enum — How a process program write treats an existing program with the same ID.
• GemProgramMode::Create Enumerator — Write only when the ID does not exist yet.
• GemProgramMode::Replace Enumerator — Write only when the ID already exists.
• GemProgramMode::Upsert Enumerator — Create or replace.
• GemProgramOptions Typedef — Process program store limits; build them with gemProgramOptions().
• GemProgramState Struct — State of the process program store, returned by GemEndpoint::programState().
• GemProgramState::bodyBytes Field — Total bytes of stored program bodies.
• GemProgramState::grantCount Field — Active S7F1/F2 grants.
• GemProgramState::identifierBytes Field — Total bytes of stored program IDs.
• GemProgramState::persistent Field — true when the store is backed by a file.
• GemProgramState::programCount Field — Stored programs.
• GemProgramState::reservedBodyBytes Field — Body bytes reserved by active grants.
• GemProgramWriteInfo Struct — Outcome of a local process program store mutation.
• GemProgramWriteInfo::applied Field — true when the change was installed.
• GemProgramWriteInfo::durability Field — Durability reached.
• GemProgramWriteInfo::persistenceStatus Field — Status of the persistence step, for example PDCOMM_IO_ERROR when synchronization failed.
• GemProgramWriteResult Struct — Status and details of GemEndpoint::programPut() or GemEndpoint::programDeleteLocal().
• GemProgramWriteResult::info Field — Details of the mutation.
• GemProgramWriteResult::status Field — PDCOMM_OK, or PDCOMM_PROGRAM_UNCONFIRMED when the change was installed but its durability is unconfirmed. Do not repeat an unconfirmed mutation.
• GemQueryInfo Struct — Summary of a report query request or reply, returned by GemResult::queryInfo().
• GemQueryInfo::dataId Field — DATAID of an S6F16 reply; valid when #dataIdPresent is true.
• GemQueryInfo::dataIdPresent Field — true for S6F16 replies.
• GemQueryInfo::id Field — Requested CEID (event query) or RPTID (individual and annotated queries).
• GemQueryInfo::isRequest Field — true for a request received by the equipment.
• GemQueryInfo::kind Field — GemRequest::EventQuery, GemRequest::IndividualQuery or GemRequest::AnnotatedQuery.
• GemQueryInfo::reportCount Field — Reports in an S6F16 reply; 0 otherwise.
• GemQueryInfo::responded Field — true after GemEquipment::respondReportQuery() sent the reply.
• GemQueryInfo::valueCount Field — Values in the reply; for S6F16 the total across reports.
• GemQueryReportInfo Struct — One report of an S6F16 reply, returned by GemResult::queryReport().
• GemQueryReportInfo::id Field — Report ID (RPTID).
• GemQueryReportInfo::valueCount Field — Values in the report.
• GemQueryValue Struct — One value of a report query reply, returned by GemResult::queryValue().
• GemQueryValue::value Field — Value item.
• GemQueryValue::variableId Field — VID; valid only when #variableIdPresent is true.
• GemQueryValue::variableIdPresent Field — true only for S6F22 annotated replies.
• GemReportBinding Struct — Maps a report variable ID (VID) to the store that supplies its value.
• GemReportBinding::constantId Field — ECID item (scalar ASCII or integer) for a Constant source; nullptr otherwise. Borrowed.
• GemReportBinding::source Field — Store that supplies the value.
• GemReportBinding::sourceId Field — SVID or DVID for Status and Data sources; must be 0 for Constant.
• GemReportBinding::variableId Field — VID used in report definitions; must be unique among bindings.
• GemReportDefinition Struct — One defined report, returned by GemEquipment::reportAt().
• GemReportDefinition::id Field — Report ID (RPTID).
• GemReportDefinition::variableIds Field — Variable IDs in report order.
• GemReportSource Enum — Store that supplies the value of a report variable.
• GemReportSource::Constant Enumerator — An equipment constant (ECID).
• GemReportSource::Data Enumerator — A data variable (DVID) from the data variable store.
• GemReportSource::Status Enumerator — A registered status variable (SVID).
• GemReportSpec Struct — One report definition for S2F33 or for a fixed report catalog.
• GemReportSpec::id Field — Report ID (RPTID).
• GemReportSpec::variableIds Field — Variable IDs (VIDs) in report order. In S2F33, an empty list deletes the report.
• GemReportState Struct — Counters of the equipment's report and event store.
• GemReportState::eventCount Field — Configured collection events.
• GemReportState::reportCount Field — Defined reports.
• GemReportState::totalLinks Field — Event-to-report links across all events.
• GemReportState::totalVariables Field — Variable references across all reports.
• GemRequest Enum — Kind of GEM transaction that a request, token or result belongs to.
• GemRequest::AlarmList Enumerator — S5F5/F6 List Alarms Request and Data.
• GemRequest::AlarmReport Enumerator — S5F1/F2 Alarm Report Send and Acknowledge.
• GemRequest::AnnotatedQuery Enumerator — S6F21/F22 Annotated Individual Report Request and Data.
• GemRequest::AreYouOnline 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 Enumerator — S2F15/F16 New Equipment Constant Send and Acknowledge.
• GemRequest::ConstantMetadata Enumerator — S2F29/F30 Equipment Constant Namelist Request and Reply.
• GemRequest::ConstantValues Enumerator — S2F13/F14 Equipment Constant Request and Data.
• GemRequest::DataDirectory Enumerator — S1F21/F22 Data Variable Namelist Request and Data.
• GemRequest::DefineReports Enumerator — S2F33/F34 Define Report.
• GemRequest::EnableAlarm Enumerator — S5F3/F4 Enable/Disable Alarm Send.
• GemRequest::EnableEvents Enumerator — S2F37/F38 Enable/Disable Event Report.
• GemRequest::EnabledAlarmList Enumerator — S5F7/F8 List Enabled Alarm Request and Data.
• GemRequest::EnhancedRemoteCommand Enumerator — S2F49/F50 Enhanced Remote Command and Acknowledge.
• GemRequest::Establish Enumerator — S1F13/F14 Establish Communications Request.
• GemRequest::EventDirectory Enumerator — S1F23/F24 Collection Event Namelist Request and Data.
• GemRequest::EventQuery Enumerator — S6F15/F16 Event Report Request and Data.
• GemRequest::EventReport Enumerator — S6F11/F12 Event Report Send and Acknowledge.
• GemRequest::FormattedProgramCapabilitySend Enumerator — S7F21/F22 Process Capability Request and Data.
• GemRequest::FormattedProgramQuerySend Enumerator — S7F25/F26 Formatted Process Program Request and Data.
• GemRequest::FormattedProgramSend Enumerator — S7F27/F28 Process Program Verification Send.
• GemRequest::FormattedProgramTransferSend Enumerator — S7F23/F24 Formatted Process Program Send.
• GemRequest::FormattedProgramVerificationNegotiationSend Enumerator — S7F29/F30 Process Program Verification Inquire and Grant, followed by S7F27/F28.
• GemRequest::FormattedProgramVerificationRequestSend Enumerator — S7F31/F32 Verification Request Send.
• GemRequest::IndividualQuery Enumerator — S6F19/F20 Individual Report Request and Data.
• GemRequest::LinkReports Enumerator — S2F35/F36 Link Event Report.
• GemRequest::Offline Enumerator — S1F15/F16 Request OFF-LINE.
• GemRequest::Online Enumerator — S1F17/F18 Request ON-LINE.
• GemRequest::OperatorOnline Enumerator — The equipment's operator-initiated S1F1/F2 ON-LINE attempt from GemEquipment::operatorOnline(). GemHost::request() rejects it.
• GemRequest::ProgramDelete Enumerator — S7F17/F18 Delete Process Program Send and Acknowledge.
• GemRequest::ProgramDirectory Enumerator — S7F19/F20 Current Process Program Directory Request and Data.
• GemRequest::ProgramGrant Enumerator — S7F1/F2 Process Program Load Inquire and Grant.
• GemRequest::ProgramRequest Enumerator — S7F5/F6 Process Program Request and Data.
• GemRequest::ProgramSend Enumerator — S7F3/F4 Process Program Send and Acknowledge.
• GemRequest::RemoteCommand Enumerator — S2F41/F42 Host Command Send and Acknowledge.
• GemRequest::SpoolConfigure Enumerator — S2F43/F44 Reset Spooling Streams and Functions.
• GemRequest::SpoolControl Enumerator — S6F23/F24 Request Spooled Data (transmit or purge).
• GemRequest::SpoolDelivery Enumerator — Delivery of one spooled message, started by GemEndpoint::sendNextSpool().
• GemRequest::SpoolQuery Enumerator — S2F59/F60 query of the current spooling selection.
• GemRequest::StatusNames Enumerator — S1F11/F12 Status Variable Namelist Request and Reply.
• GemRequest::StatusValues Enumerator — S1F3/F4 Selected Equipment Status Request and Data.
• GemResult Class — Owned snapshot of one TCP event after GEM processing.
• GemResult::GemResult Constructor — Creates an empty result that owns no native handle.
• GemResult::GemResult Constructor — Takes ownership of the native handle owned by other.
• GemResult::GemResult Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• GemResult::adopt Method — Wraps a native result handle and takes ownership of it.
• GemResult::alarmAt Method — Returns one alarm of a received S5F1 report or S5F6/S5F8 list.
• GemResult::alarmInfo Method — Summarizes a received S5F1 alarm report or S5F6/S5F8 alarm list.
• GemResult::body Method — Returns a copy of the message body.
• GemResult::commandInfo Method — Summarizes a received S2F41 request (equipment) or S2F42 reply (host).
• GemResult::commandIssue Method — Returns one parameter issue: a validation issue of a request, or a CPACK entry of a reply.
• GemResult::commandName Method — Returns the RCMD of a received S2F41 request in its wire format.
• GemResult::commandParameter Method — Returns one (CPNAME, CPVAL) pair of a received S2F41 request.
• GemResult::constantChange Method — Returns one proposed change of a received S2F15 request.
• GemResult::constantChangeInfo Method — Summarizes a received S2F15 request (equipment) or S2F16 reply (host).
• GemResult::constantMetadata Method — Returns one field of one row of an S2F30 namelist reply received by a host.
• GemResult::constantValue Method — Returns one value of an S2F14 equipment constant reply received by a host.
• GemResult::definition Method — Alias of statusName().
• GemResult::directory Method — Alias of directoryGet().
• GemResult::directoryAt Method — Returns one row of an S1F22 or S1F24 namelist reply received by a host.
• GemResult::directoryGet Method — Returns one field of one row of an S1F22 or S1F24 namelist reply.
• GemResult::enhancedCommandAcknowledgements Method — Returns the outer acknowledgement list of an enhanced command result.
• GemResult::enhancedCommandInfo Method — Summarizes a received S2F49 request (equipment) or S2F50 reply (host).
• GemResult::enhancedCommandName Method — Returns the RCMD of a received S2F49 request.
• GemResult::enhancedCommandObject Method — Returns the OBJSPEC of a received S2F49 request.
• GemResult::enhancedCommandParameter Method — Returns one (CPNAME, CEPVAL) pair of a received S2F49 request.
• GemResult::eventInfo Method — Returns the header of an S6F11 event report received by a host.
• GemResult::eventReport Method — Returns one report of a received S6F11.
• GemResult::eventValue Method — Returns one value of one report of a received S6F11.
• GemResult::info Method — Returns the kind, outcome, request kind, codes, token and state of this result.
• GemResult::nativeHandle Method — Returns the owned native handle for direct C API calls.
• GemResult::nativeHandle Method — Returns the owned native handle for read-only C API calls.
• GemResult::operator bool Method — Reports whether the wrapper owns a native result.
• GemResult::operator= Method — Releases the current handle, then takes ownership of the handle owned by other.
• GemResult::operator= Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• GemResult::programInfo Method — Summarizes a process program request or reply (stream 7, functions 1 to 6, 17 to 20).
• GemResult::programItem Method — Returns a program ID or body carried by a program result.
• GemResult::queryInfo Method — Summarizes a report query request (equipment) or its S6F16/S6F20/S6F22 reply (host).
• GemResult::queryReport Method — Returns one report of an S6F16 reply.
• GemResult::queryValue Method — Returns one value of a report query reply.
• GemResult::spoolError Method — Returns one rejected stream of an S2F44 reply received by a host.
• GemResult::spoolInfo Method — Summarizes a spool request, reply or delivery result.
• GemResult::spoolSelection Method — Returns one stream selection of a received S2F43 request or an S2F60 reply.
• GemResult::statusName Method — Returns one row of an S1F12 status variable namelist reply.
• GemResult::statusValue Method — Returns one status value of an S1F4 reply.
• GemResult::value Method — Alias of statusValue().
• GemResult::value Method — Alias of eventValue().
• GemResult::~GemResult Method — Releases the native handle with pdcomm_gem_result_destroy().
• GemResultInfo Struct — Common information about a GemResult, returned by GemResult::info().
• GemResultInfo::acknowledgement Field — Acknowledgement code from the reply (for example COMMACK, ONLACK, DRACK or HCACK); valid only when #acknowledgementPresent is true.
• GemResultInfo::acknowledgementPresent Field — true when #acknowledgement holds a received or sent acknowledgement code.
• GemResultInfo::code 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 Field — Number of entries that the typed getters can read (values, names, alarms, reports, rows or IDs, depending on the outcome).
• GemResultInfo::kind Field — Result classification.
• GemResultInfo::outcome Field — Meaning of the result.
• GemResultInfo::replySent Field — true when a reply to an incoming primary was sent, by the library or by a respond call.
• GemResultInfo::request Field — Transaction kind the result belongs to.
• GemResultInfo::state Field — Endpoint state captured when the result was produced.
• GemResultInfo::token Field — Transaction token: the submitted request's token for replies and failures, or the incoming message's identity for primaries.
• GemResultKind Enum — Classification of a GemResult returned by GemEndpoint::handleEvent().
• GemResultKind::Failed 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 Enumerator — The TCP event is not a GEM message (for example an HSMS state change). Nothing to do.
• GemResultKind::InvalidResponse 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 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 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 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 Enum — GEM role configured on an endpoint (SEMI E30).
• GemRole::Equipment Enumerator — Equipment role: the tool that answers host requests and reports events and alarms.
• GemRole::Host Enumerator — Host role: the factory system that sends requests to equipment.
• GemSpoolCommand Enum — RSDC value of S6F23 Request Spooled Data.
• GemSpoolCommand::Purge Enumerator — Delete the spooled messages.
• GemSpoolCommand::Transmit Enumerator — Transmit the spooled messages.
• GemSpoolDeliveryProof Enum — Evidence carried by a spool delivery result.
• GemSpoolDeliveryProof::None Enumerator — No usable delivery proof.
• GemSpoolDeliveryProof::Response Enumerator — The matching reply to a W-bit message arrived.
• GemSpoolDeliveryProof::Written Enumerator — A message without W-bit was fully written locally; this is not peer receipt.
• GemSpoolDurability Enum — Durability reached by a spool mutation.
• GemSpoolDurability::Confirmed Enumerator — The application accepted an unconfirmed reply with GemEndpoint::confirmSpoolReply(). This is not a synchronization.
• GemSpoolDurability::None Enumerator — Nothing was installed.
• GemSpoolDurability::Synced Enumerator — Written to the file and the parent directory was synchronized.
• GemSpoolDurability::Unconfirmed Enumerator — Installed, but synchronizing the parent directory failed; the call reported PDCOMM_SPOOL_UNCONFIRMED.
• GemSpoolDurability::Volatile Enumerator — Installed in memory only (no file was configured).
• GemSpoolEntry Struct — One stored message, returned by GemEndpoint::spoolEntryAt().
• GemSpoolEntry::body Field — Message body; an empty item when #bodyPresent is false.
• GemSpoolEntry::bodyPresent Field — false for a header-only message; differs from an empty body.
• GemSpoolEntry::captureTimePresent Field — false for entries from older snapshots without a capture time.
• GemSpoolEntry::capturedAt Field — Application timestamp passed when the message was captured.
• GemSpoolEntry::entryId Field — Entry ID.
• GemSpoolEntry::function Field — Function number.
• GemSpoolEntry::replyExpected Field — W-bit of the stored message.
• GemSpoolEntry::stream Field — Stream number.
• GemSpoolError Struct — One rejected stream of an S2F44 reply, returned by GemResult::spoolError().
• GemSpoolError::acknowledgement Field — STRACK for the stream.
• GemSpoolError::functions Field — Rejected functions as a U1 array item.
• GemSpoolError::stream Field — Stream number.
• GemSpoolHostOptions Typedef — Host spool request limits; build them with gemSpoolHostOptions().
• GemSpoolInfo Struct — Summary of a spool request, reply or delivery result, returned by GemResult::spoolInfo().
• GemSpoolInfo::acknowledgement Field — RSPACK or RSDA; valid when #acknowledgementPresent is true.
• GemSpoolInfo::acknowledgementPresent Field — true when #acknowledgement is set.
• GemSpoolInfo::applied Field — true when processing changed the spool.
• GemSpoolInfo::command Field — RSDC of an S6F23 request.
• GemSpoolInfo::confirmationRequired Field — true when the reply waits for GemEndpoint::confirmSpoolReply().
• GemSpoolInfo::deliveryAttempt Field — Delivery attempt number.
• GemSpoolInfo::deliveryCompleted Field — true after GemEndpoint::completeSpoolDelivery() accepted this delivery result.
• GemSpoolInfo::deliveryProof Field — Proof type carried by a delivery result.
• GemSpoolInfo::dequeuePending Field — true when removing the delivered entry failed and needs GemEndpoint::retrySpoolDequeue().
• GemSpoolInfo::durability Field — Durability reached while processing a request.
• GemSpoolInfo::entryId Field — Spool entry delivered by a delivery result.
• GemSpoolInfo::errorCount Field — Rejected streams in an S2F44 reply.
• GemSpoolInfo::isRequest Field — true for a request received by the equipment.
• GemSpoolInfo::persistenceStatus Field — Status of the persistence step.
• GemSpoolInfo::replyReady Field — true when a prepared reply is retained for retry.
• GemSpoolInfo::request Field — Spool transaction kind.
• GemSpoolInfo::responded Field — true after GemEndpoint::respondSpool() sent the reply.
• GemSpoolInfo::selectionCount Field — Selections in an S2F43 request or S2F60 reply.
• GemSpoolInfo::successAccepted Field — true when a successful completion was accepted for this delivery.
• GemSpoolMessageKey Struct — Stream and function of a primary message that may be spooled.
• GemSpoolMessageKey::function Field — Function number of a primary message (odd). The stream must be 2 to 127.
• GemSpoolMessageKey::stream Field — Stream number.
• GemSpoolMutation Enum — Kind of change a spool call made.
• GemSpoolMutation::Activated Enumerator — Spooling became active because communication was lost.
• GemSpoolMutation::Captured Enumerator — A message was stored.
• GemSpoolMutation::Configured Enumerator — Spooling configuration or selection changed.
• GemSpoolMutation::Discarded Enumerator — A message was discarded because the spool was full (statistics changed).
• GemSpoolMutation::None Enumerator — No change.
• GemSpoolMutation::Purged Enumerator — All stored messages were deleted.
• GemSpoolMutation::Removed Enumerator — A delivered message was removed from the head of the spool.
• GemSpoolOptions Typedef — Equipment spool limits; build them with gemSpoolOptions().
• GemSpoolOverflow Enum — What the equipment spool does when it is full.
• GemSpoolOverflow::DiscardNew Enumerator — Discard the new message and keep the stored ones.
• GemSpoolOverflow::OverwriteOldest Enumerator — Remove the oldest stored message to make room.
• GemSpoolPolicy Struct — Local spooling policy for GemEquipment::configureLocalSpooling().
• GemSpoolPolicy::enabled Field — Global spooling switch, separate from the stream selection.
• GemSpoolPolicy::maxTransmit Field — Maximum messages sent per transmit run; 0 means unbounded.
• GemSpoolPolicy::overflow Field — Behaviour when the spool is full.
• GemSpoolSelection Struct — Stream and functions selected for spooling (S2F43 entry or local selection).
• GemSpoolSelection::functions Field — Selected functions; an empty list selects every registered primary of the stream.
• GemSpoolSelection::stream Field — Stream number.
• GemSpoolState Struct — State of the spool, returned by GemEndpoint::spoolState().
• GemSpoolState::active Field — true while spooling is active (communication lost).
• GemSpoolState::bodyBytes Field — Total bytes of stored message bodies.
• GemSpoolState::catalogCount Field — Registered spoolable stream and function pairs.
• GemSpoolState::connected Field — Connection state observed at the last synchronization.
• GemSpoolState::deliveryPending Field — true while a delivery attempt is in flight.
• GemSpoolState::dequeuePending Field — true when a delivered entry still waits for GemEndpoint::retrySpoolDequeue().
• GemSpoolState::discarded Field — Messages discarded or overwritten because the spool was full.
• GemSpoolState::enabled Field — Global spooling switch.
• GemSpoolState::fullTime Field — Application timestamp when the spool became full; valid when #fullTimePresent is true.
• GemSpoolState::fullTimePresent Field — true when #fullTime is set.
• GemSpoolState::maxTransmit Field — Configured messages per transmit run; 0 means unbounded.
• GemSpoolState::messageCount Field — Stored messages.
• GemSpoolState::nextId Field — ID the next stored entry will get.
• GemSpoolState::overflow Field — Configured overflow behaviour.
• GemSpoolState::persistent Field — true when the spool is backed by a file.
• GemSpoolState::received Field — Selected messages offered for capture.
• GemSpoolState::selectionCount Field — Selected streams.
• GemSpoolState::startTime Field — Application timestamp when spooling started; valid when #startTimePresent is true.
• GemSpoolState::startTimePresent Field — true when #startTime is set.
• GemSpoolState::stored Field — Messages stored.
• GemSpoolState::synchronized Field — true when GemEquipment::syncSpool() observed the current connection state.
• GemSpoolState::transmitted Field — Messages delivered and removed from the spool.
• GemSpoolState::transmittedInRun Field — Messages sent in the current transmit run.
• GemSpoolState::transmitting Field — true during a transmit run accepted by S6F23.
• GemSpoolWriteInfo Struct — Outcome of a spool mutation.
• GemSpoolWriteInfo::affectedCount Field — Entries overwritten on capture, removed on purge, or 1 on dequeue.
• GemSpoolWriteInfo::applied Field — true when the change was installed.
• GemSpoolWriteInfo::durability Field — Durability reached.
• GemSpoolWriteInfo::entryId Field — ID of the captured or removed entry.
• GemSpoolWriteInfo::mutation Field — Kind of change made.
• GemSpoolWriteInfo::persistenceStatus Field — Status of the persistence step, for example PDCOMM_IO_ERROR.
• GemSpoolWriteInfo::selected Field — true when a captured message was within the selection.
• GemSpoolWriteResult Struct — Status and details of a spool mutation.
• GemSpoolWriteResult::info Field — Details of the mutation.
• GemSpoolWriteResult::status Field — PDCOMM_OK, or PDCOMM_SPOOL_UNCONFIRMED when the change was installed but its durability is unconfirmed. Do not repeat an unconfirmed mutation.
• GemState Struct — Snapshot of an endpoint's GEM state, returned by GemEndpoint::state().
• GemState::communication Field — Communication state (SEMI E30).
• GemState::control Field — Control state; GemControl::Unavailable for a host.
• GemState::endpointId Field — Process-unique identity of the endpoint, also carried in every token.
• GemState::generation Field — HSMS connection generation; it changes on every new connection.
• GemState::onlineMode Field — Online substate used when going online; GemOnlineMode::Unavailable for a host.
• GemState::pendingCount Field — Native requests waiting for a reply (at most 32).
• GemState::pendingIds Field — Identifiers held by pending requests, counted against the configured max_pending_ids.
• GemState::role Field — Configured role.
• GemState::variableCount Field — Registered status variables at the equipment; 0 for a host.
• GemStatusName Struct — Status variable name and units, from S1F12 or from local equipment metadata.
• GemStatusName::id Field — Status variable ID (SVID).
• GemStatusName::name Field — Name (SVNAME), length-delimited ASCII; embedded NUL bytes are kept.
• GemStatusName::units Field — Units, length-delimited ASCII; may be empty.
• GemStatusValue Struct — One status value from an S1F4 reply, returned by GemResult::statusValue().
• GemStatusValue::id Field — Requested status variable ID (SVID); valid only when #idPresent is true.
• GemStatusValue::idPresent Field — true for replies to an explicit ID list. A request for all values has no IDs on the wire.
• GemStatusValue::value Field — Independently owned value item. An empty list alone does not prove that the SVID is unknown.
• Secs1BorrowedIo Class — A non-owning I/O binding built from raw C callbacks.
• Secs1BorrowedIo::Secs1BorrowedIo Constructor — Moving is disabled; endpoints refer to this binding by address.
• Secs1BorrowedIo::Secs1BorrowedIo Constructor — Copying is disabled; endpoints refer to this binding by address.
• Secs1BorrowedIo::Secs1BorrowedIo Constructor — Fills the callback table.
• Secs1BorrowedIo::native Method — Returns the callback table that Secs1Endpoint passes to pdcomm_secs1_create().
• Secs1BorrowedIo::operator= Method — Move assignment is disabled; endpoints refer to this binding by address.
• Secs1BorrowedIo::operator= Method — Copy assignment is disabled; endpoints refer to this binding by address.
• Secs1Endpoint Class — Move-only owner of one SECS-I (SEMI E4) endpoint over caller-provided serial I/O.
• Secs1Endpoint::Secs1Endpoint Constructor — Creates a stopped SECS-I endpoint with pdcomm_secs1_create().
• Secs1Endpoint::Secs1Endpoint Constructor — Takes ownership of the native handle owned by other.
• Secs1Endpoint::Secs1Endpoint Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• Secs1Endpoint::nativeHandle Method — Returns the owned native handle for direct C API calls.
• Secs1Endpoint::nativeHandle Method — Returns the owned native handle for read-only C API calls.
• Secs1Endpoint::nextEvent Method — Takes the oldest queued event, with pdcomm_secs1_next_event().
• Secs1Endpoint::operator= Method — Releases the current handle, then takes ownership of the handle owned by other.
• Secs1Endpoint::operator= Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• Secs1Endpoint::poll Method — Runs line control, timers and callback I/O for one time slice, with pdcomm_secs1_poll().
• Secs1Endpoint::reset Method — Clears a terminal fault so the endpoint can transfer messages again, with pdcomm_secs1_reset().
• Secs1Endpoint::start Method — Starts a created or stopped endpoint with pdcomm_secs1_start().
• Secs1Endpoint::state Method — Reads the identity and lifecycle flags of the endpoint, with pdcomm_secs1_state().
• Secs1Endpoint::stop Method — Stops a started endpoint and discards its runtime state, with pdcomm_secs1_stop().
• Secs1Endpoint::submit Method — Queues one message for transmission, with pdcomm_secs1_submit().
• Secs1Endpoint::~Secs1Endpoint Method — Releases the endpoint with pdcomm_secs1_destroy(), without invoking callbacks.
• Secs1Event Class — Owned, immutable snapshot of one SECS-I endpoint event.
• Secs1Event::Secs1Event Constructor — Creates an empty event that owns no native handle.
• Secs1Event::Secs1Event Constructor — Takes ownership of the native handle owned by other.
• Secs1Event::Secs1Event Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• Secs1Event::body Method — Copies the body of a received message.
• Secs1Event::info Method — Describes the event with pdcomm_secs1_event_info().
• Secs1Event::operator bool Method — Reports whether the wrapper owns a native event.
• Secs1Event::operator= Method — Releases the current handle, then takes ownership of the handle owned by other.
• Secs1Event::operator= Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• Secs1Event::~Secs1Event Method — Releases the native event with pdcomm_secs1_event_destroy().
• Secs1IoAdapter Class — Owns a typed serial port and exposes it to a Secs1Endpoint through exception-safe callbacks.
• Secs1IoAdapter::Secs1IoAdapter Constructor — Constructs the port in place and fills the callback table.
• Secs1IoAdapter::Secs1IoAdapter Constructor — Moving is disabled; the callback context is this adapter's address.
• Secs1IoAdapter::Secs1IoAdapter Constructor — Copying is disabled; the callback context is this adapter's address.
• Secs1IoAdapter::native Method — Returns the callback table that Secs1Endpoint passes to pdcomm_secs1_create().
• Secs1IoAdapter::operator= Method — Move assignment is disabled; the callback context is this adapter's address.
• Secs1IoAdapter::operator= Method — Copy assignment is disabled; the callback context is this adapter's address.
• Secs1IoAdapter::port Method — Returns the owned port.
• Secs1IoAdapter::port Method — Returns the owned port for read-only access.
• SecsItem Class — Owned, immutable SECS-II data item (SEMI E5 section 9).
• SecsItem::SecsItem Constructor — Creates an empty item that owns no native handle.
• SecsItem::SecsItem Constructor — Takes ownership of the native handle owned by other.
• SecsItem::SecsItem Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• SecsItem::adopt Method — Wraps a native item handle and takes ownership of it.
• SecsItem::bytes Method — Encodes the item into SECS-II wire format.
• SecsItem::child Method — Returns a copy of one child of a list item.
• SecsItem::decode Method — Decodes exactly one encoded SECS-II item from a vector.
• SecsItem::decode Method — Decodes exactly one encoded SECS-II item.
• SecsItem::info Method — Describes the item's format and size.
• SecsItem::list Method — Creates a list item that contains copies of children.
• SecsItem::list Method — Creates a list item that contains copies of children.
• SecsItem::nativeHandle Method — Returns the owned native handle for direct C API calls.
• SecsItem::nativeHandle Method — Returns the owned native handle for read-only C API calls.
• SecsItem::operator bool Method — Reports whether the wrapper owns a native item.
• SecsItem::operator= Method — Releases the current handle, then takes ownership of the handle owned by other.
• SecsItem::operator= Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• SecsItem::payload Method — Copies the raw payload bytes of a primitive item.
• SecsItem::primitive Method — Creates a primitive item from a payload vector.
• SecsItem::primitive Method — Creates a primitive item from raw payload bytes.
• SecsItem::~SecsItem Method — Releases the native handle with pdcomm_secs_destroy().
• TcpEndpoint Class — Move-only owner of one HSMS (SEMI E37) endpoint over TCP/IP.
• TcpEndpoint::TcpEndpoint Constructor — Creates an empty endpoint that owns no native handle.
• TcpEndpoint::TcpEndpoint Constructor — Takes ownership of the native handle owned by other.
• TcpEndpoint::TcpEndpoint Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• TcpEndpoint::TcpEndpoint Constructor — Creates an HSMS endpoint with pdcomm_tcp_create().
• TcpEndpoint::TcpEndpoint Constructor — Creates an HSMS endpoint from an address string.
• TcpEndpoint::cancel Method — Cancels an open transaction with pdcomm_tcp_cancel().
• TcpEndpoint::deselect Method — Sends Deselect.req to leave the SELECTED state, with pdcomm_tcp_deselect().
• TcpEndpoint::isPending Method — Reports whether a transaction still waits for its response, with pdcomm_tcp_is_pending().
• TcpEndpoint::linktest Method — Sends Linktest.req to check that the connection is alive, with pdcomm_tcp_linktest().
• TcpEndpoint::localAddress Method — Returns the local socket address as text.
• TcpEndpoint::nativeHandle Method — Returns the owned native handle for direct C API calls.
• TcpEndpoint::nativeHandle Method — Returns the owned native handle for read-only C API calls.
• TcpEndpoint::nextEvent Method — Removes the oldest event from the endpoint's event queue, with pdcomm_tcp_next_event().
• TcpEndpoint::operator bool Method — Reports whether the wrapper owns a native endpoint.
• TcpEndpoint::operator= Method — Releases the current handle, then takes ownership of the handle owned by other.
• TcpEndpoint::operator= Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• TcpEndpoint::poll Method — Performs pending socket I/O and HSMS timer processing with pdcomm_tcp_poll().
• TcpEndpoint::reply Method — Submits the reply to a received W-bit primary, with a body held in a vector.
• TcpEndpoint::reply Method — Submits the reply to a received primary that has the W-bit set, with pdcomm_tcp_reply().
• TcpEndpoint::request Method — Submits a primary data message whose body is held in a vector.
• TcpEndpoint::request Method — Submits a primary data message with pdcomm_tcp_request().
• TcpEndpoint::select Method — Sends Select.req to enter the SELECTED state, with pdcomm_tcp_select().
• TcpEndpoint::start Method — Starts a new connection generation with pdcomm_tcp_start().
• TcpEndpoint::state Method — Reads the endpoint identity, generation, HSMS state and close status.
• TcpEndpoint::stop Method — Stops the endpoint and starts a graceful close with pdcomm_tcp_stop().
• TcpEndpoint::~TcpEndpoint Method — Releases the endpoint and its sockets with pdcomm_tcp_destroy().
• TcpEvent Class — Owned, immutable snapshot of one HSMS endpoint event.
• TcpEvent::TcpEvent Constructor — Creates an empty event that owns no native handle.
• TcpEvent::TcpEvent Constructor — Takes ownership of the native handle owned by other.
• TcpEvent::TcpEvent Constructor — Copying is disabled; the wrapper exclusively owns its native handle.
• TcpEvent::body Method — Copies the message body of a received data message.
• TcpEvent::info Method — Decodes the kind, codes, message header and token of the event.
• TcpEvent::nativeHandle Method — Returns the owned native handle for direct C API calls.
• TcpEvent::nativeHandle Method — Returns the owned native handle for read-only C API calls.
• TcpEvent::operator bool Method — Reports whether the wrapper owns a native event.
• TcpEvent::operator= Method — Releases the current handle, then takes ownership of the handle owned by other.
• TcpEvent::operator= Method — Copy assignment is disabled; the wrapper exclusively owns its native handle.
• TcpEvent::~TcpEvent Method — Releases the native event with pdcomm_tcp_event_destroy().
• cancelFormattedProgramExecution Function — Requests cancellation of a running execution as a cancel action.
• checkFormattedProgramDryRunStatus Function — Throws pdcomm::Error when status is not PDCOMM_OK.
• checkFormattedProgramExecutionStatus Function — Throws pdcomm::Error when status is not PDCOMM_OK.
• clearFormattedProgramCapabilityCatalog Function — Removes the equipment's capability catalog.
• clearFormattedProgramSelection Function — Clears the current selection when token matches it.
• completeFormattedProgramExecution Function — Submits the application's final report with detail bytes from a vector.
• completeFormattedProgramExecution Function — Submits the application's final report for a running execution.
• configureFormattedProgramCapabilities Function — Enables S7F21/F22 process capability exchange on an endpoint.
• configureFormattedProgramQueries Function — Enables S7F25/F26 formatted process program requests on an endpoint.
• configureFormattedProgramTransfers Function — Enables S7F23/F24 formatted process program transfer on an endpoint.
• configureFormattedProgramVerificationNegotiation Function — Enables S7F29/F30 verification negotiation on an endpoint.
• configureFormattedProgramVerificationRequests Function — Enables S7F31/F32 verification requests on an endpoint.
• configureFormattedPrograms Function — Enables S7F27/F28 process program verification on an endpoint.
• dryRunFormattedProgram Function — Analyses the selected formatted program against the equipment's capability catalog.
• formattedProgramCapabilityCommandInfo Function — Describes one command of a received S7F22.
• formattedProgramCapabilityCommandText Function — Copies the CCODE or CNAME of one command of a received S7F22.
• formattedProgramCapabilityDependency Function — Returns one entry of a dependency list of one command of a received S7F22.
• formattedProgramCapabilityInfo Function — Summarizes an S7F21 request or S7F22 reply carried by result.
• formattedProgramCapabilityModel Function — Copies the MDLN of a received S7F22.
• formattedProgramCapabilityParameter Function — Returns one parameter description of one command of a received S7F22.
• formattedProgramCapabilitySoftwareRevision Function — Copies the SOFTREV of a received S7F22.
• formattedProgramCapabilityText Function — Copies the MDLN or SOFTREV of a received S7F22.
• formattedProgramDryRunReportHandle Function — Returns the native handle of report.
• formattedProgramExecutionActionTokenOutput Function — Converts a wrapper action token into the versioned C action token structure.
• formattedProgramExecutionSnapshot Function — Copies the current execution state into a snapshot.
• formattedProgramExecutionToken Function — Converts a C execution token into the wrapper token.
• formattedProgramExecutionTokenOutput Function — Converts a wrapper execution token into the versioned C token structure.
• formattedProgramId Function — Returns the PPID of an S7F27 report.
• formattedProgramInfo Function — Summarizes an S7F27 request or S7F28 reply carried by result.
• formattedProgramIssue Function — Copies one verification entry of an S7F27 report.
• formattedProgramQueryCommandCode Function — Returns the CCODE of one command of a returned program.
• formattedProgramQueryCommandInfo Function — Describes one command of a returned program.
• formattedProgramQueryId Function — Returns the requested PPID of an S7F25 request or S7F26 reply.
• formattedProgramQueryInfo Function — Summarizes an S7F25 request or S7F26 reply carried by result.
• formattedProgramQueryModel Function — Copies the MDLN of a returned program.
• formattedProgramQueryParameter Function — Returns one PPARM of one command of a returned program.
• formattedProgramQuerySoftwareRevision Function — Copies the SOFTREV of a returned program.
• formattedProgramQueryText Function — Copies the MDLN or SOFTREV of a returned program.
• formattedProgramSelectionSnapshot Function — Copies the current selection state, empty, ready or stale, into a snapshot.
• formattedProgramSelectionToken Function — Converts a C selection token into the wrapper token.
• formattedProgramStoreCommands Function — Converts wrapper commands into the C command structures of the store API.
• formattedProgramStoreInfo Function — Returns the current counters and limits of the formatted program store.
• formattedProgramStoreInfoOutput Function — Returns a C store-info structure prepared as an output buffer.
• formattedProgramStoreSnapshot Function — Copies the equipment's formatted program store into an independent snapshot.
• formattedProgramTransferCommandCode Function — Returns the CCODE of one command of a received S7F23.
• formattedProgramTransferCommandInfo Function — Describes one command of a received S7F23.
• formattedProgramTransferId Function — Returns the PPID of a received S7F23.
• formattedProgramTransferInfo Function — Summarizes an S7F23 request or S7F24 reply carried by result.
• formattedProgramTransferModel Function — Copies the MDLN of a received S7F23.
• formattedProgramTransferParameter Function — Returns one PPARM of one command of a received S7F23.
• formattedProgramTransferSoftwareRevision Function — Copies the SOFTREV of a received S7F23.
• formattedProgramTransferText Function — Copies the MDLN or SOFTREV of a received S7F23.
• formattedProgramVerificationNegotiationInfo Function — Describes the negotiation carried by result.
• formattedProgramVerificationRequestCommandCode Function — Returns the CCODE of one command of a received S7F31.
• formattedProgramVerificationRequestCommandInfo Function — Describes one command of a received S7F31.
• formattedProgramVerificationRequestId Function — Returns the PPID of a received S7F31.
• formattedProgramVerificationRequestInfo Function — Summarizes an S7F31 request or S7F32 reply carried by result.
• formattedProgramVerificationRequestModel Function — Copies the MDLN of a received S7F31.
• formattedProgramVerificationRequestParameter Function — Returns one PPARM of one command of a received S7F31.
• formattedProgramVerificationRequestSoftwareRevision Function — Copies the SOFTREV of a received S7F31.
• formattedProgramVerificationRequestText Function — Copies the MDLN or SOFTREV of a received S7F31.
• gem300CapabilityOptions Function — Builds versioned limits for a Gem300CapabilityCatalog.
• gemAlarmOptions Function — Builds versioned limits for the equipment alarm store (GemEquipment::configureAlarms()).
• gemBindingOptions Function — Builds versioned limits for report bindings (GemEquipment::configureReportBindings()).
• gemCommandOptions Function — Builds versioned limits for the remote command store (GemEquipment::configureCommands()).
• gemConstantOptions Function — Builds versioned limits for the equipment constant store (GemEquipment::configureConstants()).
• gemDataOptions Function — Builds versioned limits for the data variable store (GemEquipment::configureDataVariables()).
• gemDirectoryOptions Function — Builds versioned limits for the event directory (GemEquipment::configureEventDirectory()).
• gemEnhancedCommandOptions Function — Builds versioned limits for the enhanced remote command store (GemEquipment::configureEnhancedCommands()).
• gemFormattedProgramCapabilityOptions Function — Builds versioned limits for S7F21/F22 process capability exchange.
• gemFormattedProgramDryRunOptions Function — Builds versioned options for dryRunFormattedProgram().
• gemFormattedProgramOptions Function — Builds versioned limits for S7F27/F28 process program verification.
• gemFormattedProgramQueryOptions Function — Builds versioned limits for S7F25/F26 formatted process program requests.
• gemFormattedProgramTransferOptions Function — Builds versioned limits for S7F23/F24 formatted process program transfer.
• gemFormattedProgramVerificationNegotiationOptions Function — Builds versioned limits for S7F29/F30 verification negotiation.
• gemFormattedProgramVerificationRequestOptions Function — Builds versioned limits for S7F31/F32 verification requests.
• gemHostOptions Function — Builds versioned options for GemHost.
• gemProgramOptions Function — Builds versioned limits for the process program store (GemEndpoint::configurePrograms()).
• gemReportOptions Function — Builds versioned limits for the equipment report store (GemEquipment::configureReports(), GemEquipment::configureFixedCatalog()).
• gemSpoolHostOptions Function — Builds versioned limits for host spool requests (GemHost::configureSpoolHost()).
• gemSpoolOptions Function — Builds versioned limits for the equipment spool (GemEquipment::configureSpooling()).
• prepareFormattedProgramVerificationNegotiation Function — Prepares an S7F27 report for negotiation on the equipment, without sending anything.
• putFormattedProgramStore Function — Writes a program to the equipment's formatted program store.
• removeFormattedProgramQuery Function — Removes a program from the equipment's formatted program store.
• removeFormattedProgramStore Function — Removes a program from the equipment's formatted program store.
• replaceFormattedProgramCapabilityCatalog Function — Replaces the equipment's capability catalog that answers S7F21.
• respondFormattedProgram Function — Sends S7F28 Process Program Verification Acknowledge for a received S7F27.
• respondFormattedProgramCapability Function — Answers a received S7F21 with S7F22 built from the current catalog.
• respondFormattedProgramQuery Function — Answers a received S7F25 with S7F26 from the formatted program store.
• respondFormattedProgramTransfer Function — Sends S7F24 Formatted Process Program Acknowledge without storing the program.
• respondFormattedProgramTransferAndStore Function — Sends S7F24 for a received S7F23 and applies a store action to the received program.
• respondFormattedProgramVerificationNegotiation Function — Sends S7F30 Process Program Verification Grant for a received S7F29.
• respondFormattedProgramVerificationRequest Function — Sends S7F32 Verification Request Acknowledge for a received S7F31.
• retryFormattedProgramVerificationNegotiation Function — Resends the S7F27 report of a granted negotiation whose automatic send failed.
• retryFormattedProgramVerificationNegotiationResponse Function — Resends the S7F30 reply prepared by respondFormattedProgramVerificationNegotiation().
• secsLimits Function — Builds a PdcommSecsLimits structure with struct_size already set.
• seedFormattedProgramQuery Function — Adds or replaces a program in the equipment's formatted program store.
• selectFormattedProgram Function — Selects a program from the equipment's formatted program store.
• selectionTokenOutput Function — Converts a wrapper token into the versioned C token structure.
• startFormattedProgramExecution Function — Starts an execution of the selected program and returns its start action.
• stepFormattedProgramExecution Function — Requests the next command of a running execution as a step action.
• submitFormattedProgram Function — Sends S7F27 Process Program Verification Send from the equipment.
• submitFormattedProgramCapability Function — Sends S7F21 Process Capability Request (header only) from the host.
• submitFormattedProgramExecutionActionResult Function — Reports what the application did with a requested action.
• submitFormattedProgramQuery Function — Sends S7F25 Formatted Process Program Request from the host.
• submitFormattedProgramTransfer Function — Sends S7F23 Formatted Process Program Send from the host.
• submitFormattedProgramVerificationNegotiation Function — Sends S7F29 Process Program Verification Inquire for a prepared report.
• submitFormattedProgramVerificationRequest Function — Sends S7F31 Verification Request Send from the host.
• validateFormattedProgramSelection Function — Confirms that token still names a ready selection and returns its program.