pdcomm::GemOutcome
Enum
What a GemResult means, beyond its GemResultKind.
enum class GemOutcome : uint32_t"Host received" outcomes appear on Response results at the host; "equipment replied" outcomes appear on Primary results at the equipment after the library answered automatically. Results that wait for an application decision say so.
Members
AlarmAck
Enumerator
Equipment received S5F2; ACKC5 is in GemResultInfo::acknowledgement.
AlarmAck = PDCOMM_GEM_ALARM_ACKAlarmEnableAck
Enumerator
S5F4 ACKC5 was received (host) or sent (equipment).
AlarmEnableAck = PDCOMM_GEM_ALARM_ENABLE_ACKAlarmListReceived
Enumerator
Host received S5F6; read alarms with GemResult::alarmAt().
AlarmListReceived = PDCOMM_GEM_ALARM_LIST_RECEIVEDAlarmListReplied
Enumerator
Equipment answered S5F5 with S5F6.
AlarmListReplied = PDCOMM_GEM_ALARM_LIST_REPLIEDAlarmReceived
Enumerator
Host received S5F1. A W-bit report needs GemHost::acknowledgeAlarm().
AlarmReceived = PDCOMM_GEM_ALARM_RECEIVEDAlreadyOnline
Enumerator
Equipment replied S1F18 with ONLACK 2 because it is already online.
AlreadyOnline = PDCOMM_GEM_ALREADY_ONLINEAnnotatedQueryReceived
Enumerator
Host received S6F22.
AnnotatedQueryReceived = PDCOMM_GEM_ANNOTATED_QUERY_RECEIVEDCommandAck
Enumerator
Host received S2F42; HCACK is in GemResultInfo::acknowledgement.
CommandAck = PDCOMM_GEM_COMMAND_ACKCommandReceived
Enumerator
Equipment received S2F41. Nothing was executed or acknowledged; call GemEquipment::respondCommand().
CommandReceived = PDCOMM_GEM_COMMAND_RECEIVEDCommunicationEstablished
Enumerator
S1F13/F14 succeeded with COMMACK 0; the communication state is Communicating.
CommunicationEstablished = PDCOMM_GEM_COMMUNICATION_ESTABLISHEDCommunicationRejected
Enumerator
S1F14 carried a nonzero COMMACK, available in GemResultInfo::acknowledgement.
CommunicationRejected = PDCOMM_GEM_COMMUNICATION_REJECTEDConstantChangeAck
Enumerator
Host received S2F16; EAC is in GemResultInfo::acknowledgement.
ConstantChangeAck = PDCOMM_GEM_CONSTANT_CHANGE_ACKConstantChangesReceived
Enumerator
Equipment received S2F15; nothing is applied until GemEquipment::respondConstants().
ConstantChangesReceived = PDCOMM_GEM_CONSTANT_CHANGES_RECEIVEDConstantMetadataReceived
Enumerator
Host received S2F30; read rows with GemResult::constantMetadata().
ConstantMetadataReceived = PDCOMM_GEM_CONSTANT_METADATA_RECEIVEDConstantMetadataReplied
Enumerator
Equipment answered S2F29 with S2F30.
ConstantMetadataReplied = PDCOMM_GEM_CONSTANT_METADATA_REPLIEDConstantValuesReceived
Enumerator
Host received S2F14; read values with GemResult::constantValue().
ConstantValuesReceived = PDCOMM_GEM_CONSTANT_VALUES_RECEIVEDConstantValuesReplied
Enumerator
Equipment answered S2F13 with S2F14.
ConstantValuesReplied = PDCOMM_GEM_CONSTANT_VALUES_REPLIEDDataDirectoryReceived
Enumerator
Host received S1F22; read rows with GemResult::directoryAt() and GemResult::directoryGet().
DataDirectoryReceived = PDCOMM_GEM_DATA_DIRECTORY_RECEIVEDDataDirectoryReplied
Enumerator
Equipment answered S1F21 with S1F22.
DataDirectoryReplied = PDCOMM_GEM_DATA_DIRECTORY_REPLIEDDefineReportsAck
Enumerator
S2F34 DRACK was received (host) or sent (equipment); the code is in GemResultInfo::acknowledgement.
DefineReportsAck = PDCOMM_GEM_DEFINE_REPORTS_ACKEnableEventsAck
Enumerator
S2F38 ERACK was received (host) or sent (equipment).
EnableEventsAck = PDCOMM_GEM_ENABLE_EVENTS_ACKEnabledAlarmListReceived
Enumerator
Host received S5F8; read alarms with GemResult::alarmAt().
EnabledAlarmListReceived = PDCOMM_GEM_ENABLED_ALARM_LIST_RECEIVEDEnabledAlarmListReplied
Enumerator
Equipment answered S5F7 with S5F8.
EnabledAlarmListReplied = PDCOMM_GEM_ENABLED_ALARM_LIST_REPLIEDEnhancedCommandAck
Enumerator
Host received S2F50; HCACK is in GemResultInfo::acknowledgement.
EnhancedCommandAck = PDCOMM_GEM_ENHANCED_COMMAND_ACKEnhancedCommandReceived
Enumerator
Equipment received S2F49; call GemEquipment::respondEnhancedCommand().
EnhancedCommandReceived = PDCOMM_GEM_ENHANCED_COMMAND_RECEIVEDEquipmentIdentity
Enumerator
Host received S1F2 with the equipment model (MDLN) and software revision (SOFTREV).
EquipmentIdentity = PDCOMM_GEM_EQUIPMENT_IDENTITYEventAck
Enumerator
Equipment received S6F12; ACKC6 is in GemResultInfo::acknowledgement.
EventAck = PDCOMM_GEM_EVENT_ACKEventDirectoryReceived
Enumerator
Host received S1F24; read rows with GemResult::directoryAt() and GemResult::directoryGet().
EventDirectoryReceived = PDCOMM_GEM_EVENT_DIRECTORY_RECEIVEDEventDirectoryReplied
Enumerator
Equipment answered S1F23 with S1F24.
EventDirectoryReplied = PDCOMM_GEM_EVENT_DIRECTORY_REPLIEDEventQueryReceived
Enumerator
Host received S6F16.
EventQueryReceived = PDCOMM_GEM_EVENT_QUERY_RECEIVEDEventReceived
Enumerator
Host received S6F11. No acknowledgement was sent; call GemHost::acknowledgeEvent().
EventReceived = PDCOMM_GEM_EVENT_RECEIVEDFormattedProgramAcknowledgement
Enumerator
Equipment received S7F28.
FormattedProgramAcknowledgement = PDCOMM_GEM_FORMATTED_PROGRAM_ACK_RECEIVEDFormattedProgramCapabilityReceived
Enumerator
Equipment received S7F21 Process Capability Request.
FormattedProgramCapabilityReceived = PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_RECEIVEDFormattedProgramCapabilityResult
Enumerator
Host received S7F22.
FormattedProgramCapabilityResult = PDCOMM_GEM_FORMATTED_PROGRAM_CAPABILITY_RESULTFormattedProgramQueryReceived
Enumerator
Equipment received S7F25 Formatted Process Program Request.
FormattedProgramQueryReceived = PDCOMM_GEM_FORMATTED_PROGRAM_QUERY_RECEIVEDFormattedProgramQueryResult
Enumerator
Host received S7F26.
FormattedProgramQueryResult = PDCOMM_GEM_FORMATTED_PROGRAM_QUERY_RESULTFormattedProgramReceived
Enumerator
Host received S7F27 Process Program Verification Send.
FormattedProgramReceived = PDCOMM_GEM_FORMATTED_PROGRAM_RECEIVEDFormattedProgramTransferAcknowledgement
Enumerator
Host received S7F24; ACKC7 is in GemResultInfo::acknowledgement.
FormattedProgramTransferAcknowledgement = PDCOMM_GEM_FORMATTED_PROGRAM_TRANSFER_ACK_RECEIVEDFormattedProgramTransferReceived
Enumerator
Equipment received S7F23 Formatted Process Program Send.
FormattedProgramTransferReceived = PDCOMM_GEM_FORMATTED_PROGRAM_TRANSFER_RECEIVEDFormattedProgramVerificationNegotiationAcknowledgement
Enumerator
Equipment received S7F28 for the S7F27 sent after a grant.
FormattedProgramVerificationNegotiationAcknowledgement = PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_ACK_RECEIVEDFormattedProgramVerificationNegotiationGrant
Enumerator
Equipment received S7F30 with the host's PPGNT.
FormattedProgramVerificationNegotiationGrant = PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_GRANT_RECEIVEDFormattedProgramVerificationNegotiationReceived
Enumerator
Host received S7F29 Process Program Verification Inquire.
FormattedProgramVerificationNegotiationReceived = PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_NEGOTIATION_RECEIVEDFormattedProgramVerificationRequestAcknowledgement
Enumerator
Host received S7F32.
FormattedProgramVerificationRequestAcknowledgement = PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_REQUEST_ACK_RECEIVEDFormattedProgramVerificationRequestReceived
Enumerator
Equipment received S7F31 Verification Request Send.
FormattedProgramVerificationRequestReceived = PDCOMM_GEM_FORMATTED_PROGRAM_VERIFICATION_REQUEST_RECEIVEDIndividualQueryReceived
Enumerator
Host received S6F20.
IndividualQueryReceived = PDCOMM_GEM_INDIVIDUAL_QUERY_RECEIVEDLinkReportsAck
Enumerator
S2F36 LRACK was received (host) or sent (equipment).
LinkReportsAck = PDCOMM_GEM_LINK_REPORTS_ACKNamesReceived
Enumerator
Host received S1F12 status names; read them with GemResult::statusName().
NamesReceived = PDCOMM_GEM_NAMES_RECEIVEDNone
Enumerator
No specific outcome, for example on Ignored, Failed or Unhandled results.
None = PDCOMM_GEM_OUTCOME_NONEOfflineAccepted
Enumerator
Equipment accepted S1F15 and replied S1F16 with OFLACK 0.
OfflineAccepted = PDCOMM_GEM_OFFLINE_ACCEPTEDOfflineAck
Enumerator
Host received S1F16; OFLACK is in GemResultInfo::acknowledgement.
OfflineAck = PDCOMM_GEM_OFFLINE_ACKOnlineAccepted
Enumerator
Equipment went online: it accepted S1F17 (ONLACK 0), or the host answered the operator-initiated S1F1.
OnlineAccepted = PDCOMM_GEM_ONLINE_ACCEPTEDOnlineAck
Enumerator
Host received S1F18; ONLACK is in GemResultInfo::acknowledgement.
OnlineAck = PDCOMM_GEM_ONLINE_ACKOnlineRejected
Enumerator
Equipment refused to go online; the ONLACK is in GemResultInfo::acknowledgement.
OnlineRejected = PDCOMM_GEM_ONLINE_REJECTEDProgramAckReceived
Enumerator
S7F4 or S7F18 arrived; ACKC7 is in GemResultInfo::acknowledgement.
ProgramAckReceived = PDCOMM_GEM_PROGRAM_ACK_RECEIVEDProgramDataReceived
Enumerator
S7F6 arrived; read it with GemResult::programItem().
ProgramDataReceived = PDCOMM_GEM_PROGRAM_DATA_RECEIVEDProgramDirectoryReceived
Enumerator
S7F20 arrived; read IDs with GemResult::programItem().
ProgramDirectoryReceived = PDCOMM_GEM_PROGRAM_DIRECTORY_RECEIVEDProgramGrantReceived
Enumerator
S7F2 arrived; PPGNT is in GemResultInfo::acknowledgement.
ProgramGrantReceived = PDCOMM_GEM_PROGRAM_GRANT_RECEIVEDProgramReceived
Enumerator
A process program request (S7F1, S7F3 or S7F5, or S7F17/S7F19 at the equipment) arrived; call GemEndpoint::respondProgram().
ProgramReceived = PDCOMM_GEM_PROGRAM_RECEIVEDReplied
Enumerator
The library replied to an incoming primary. Results whose reply the application sent with a respond call also report this outcome afterwards.
Replied = PDCOMM_GEM_REPLIEDReportQueryReceived
Enumerator
Equipment received S6F15, S6F19 or S6F21; call GemEquipment::respondReportQuery().
ReportQueryReceived = PDCOMM_GEM_REPORT_QUERY_RECEIVEDSpoolConfigurationAck
Enumerator
Host received S2F44; read rejected streams with GemResult::spoolError().
SpoolConfigurationAck = PDCOMM_GEM_SPOOL_CONFIG_ACKSpoolConfigurationData
Enumerator
Host received S2F60; read selections with GemResult::spoolSelection().
SpoolConfigurationData = PDCOMM_GEM_SPOOL_CONFIG_DATASpoolControlAck
Enumerator
Host received S6F24; RSDA is in GemResultInfo::acknowledgement.
SpoolControlAck = PDCOMM_GEM_SPOOL_CONTROL_ACKSpoolDeliveryFailed
Enumerator
A spooled delivery attempt failed; the entry stays at the head of the spool.
SpoolDeliveryFailed = PDCOMM_GEM_SPOOL_DELIVERY_FAILEDSpoolDeliveryResponse
Enumerator
Equipment received the reply to a spooled W-bit message. Inspect the body, then call GemEndpoint::completeSpoolDelivery().
SpoolDeliveryResponse = PDCOMM_GEM_SPOOL_DELIVERY_RESPONSESpoolDeliveryWritten
Enumerator
A spooled message without W-bit was fully written to the socket.
SpoolDeliveryWritten = PDCOMM_GEM_SPOOL_DELIVERY_WRITTENSpoolReceived
Enumerator
Equipment received S2F43, S2F59 or S6F23; call GemEndpoint::respondSpool().
SpoolReceived = PDCOMM_GEM_SPOOL_RECEIVEDStatusReplied
Enumerator
Equipment answered a status request (S1F3 or S1F11) from its registered status variables.
StatusReplied = PDCOMM_GEM_STATUS_REPLIEDValuesReceived
Enumerator
Host received S1F4 status values; read them with GemResult::statusValue().
ValuesReceived = PDCOMM_GEM_VALUES_RECEIVED