Package mxaccess_gateway.v1

Interface MxaccessGateway.OnAlarmTransitionEventOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
MxaccessGateway.OnAlarmTransitionEvent, MxaccessGateway.OnAlarmTransitionEvent.Builder
Enclosing class:
MxaccessGateway
public static interface MxaccessGateway.OnAlarmTransitionEventOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getAlarmFullReference

      String getAlarmFullReference()
       Fully-qualified alarm reference (e.g. "Tank01.Level.HiHi"). Stable across
 transitions of the same condition; used by the lmxopcua side to correlate
 raise/ack/clear into a single Part 9 condition.
      string alarm_full_reference = 1;
      Returns:
      The alarmFullReference.

    • getAlarmFullReferenceBytes

      com.google.protobuf.ByteString getAlarmFullReferenceBytes()
       Fully-qualified alarm reference (e.g. "Tank01.Level.HiHi"). Stable across
 transitions of the same condition; used by the lmxopcua side to correlate
 raise/ack/clear into a single Part 9 condition.
      string alarm_full_reference = 1;
      Returns:
      The bytes for alarmFullReference.

    • getSourceObjectReference

      String getSourceObjectReference()
       Galaxy-side source object reference (e.g. "Tank01"). Empty for alarms
 that do not bind to a Galaxy object.
      string source_object_reference = 2;
      Returns:
      The sourceObjectReference.

    • getSourceObjectReferenceBytes

      com.google.protobuf.ByteString getSourceObjectReferenceBytes()
       Galaxy-side source object reference (e.g. "Tank01"). Empty for alarms
 that do not bind to a Galaxy object.
      string source_object_reference = 2;
      Returns:
      The bytes for sourceObjectReference.

    • getAlarmTypeName

      String getAlarmTypeName()
       MxAccess alarm-type qualifier (e.g. "AnalogLimitAlarm.HiHi", "DiscAlarm").
      string alarm_type_name = 3;
      Returns:
      The alarmTypeName.

    • getAlarmTypeNameBytes

      com.google.protobuf.ByteString getAlarmTypeNameBytes()
       MxAccess alarm-type qualifier (e.g. "AnalogLimitAlarm.HiHi", "DiscAlarm").
      string alarm_type_name = 3;
      Returns:
      The bytes for alarmTypeName.

    • getTransitionKindValue

      int getTransitionKindValue()
       What kind of state change this event represents.
      .mxaccess_gateway.v1.AlarmTransitionKind transition_kind = 4;
      Returns:
      The enum numeric value on the wire for transitionKind.

    • getTransitionKind

      MxaccessGateway.AlarmTransitionKind getTransitionKind()
       What kind of state change this event represents.
      .mxaccess_gateway.v1.AlarmTransitionKind transition_kind = 4;
      Returns:
      The transitionKind.

    • getSeverity

      int getSeverity()
       Raw MXAccess severity value. Mapping to OPC UA 0-1000 happens server-side
 in lmxopcua via MxAccessSeverityMapper; the gateway preserves the native
 MXAccess scale.
      int32 severity = 5;
      Returns:
      The severity.

    • hasOriginalRaiseTimestamp

      boolean hasOriginalRaiseTimestamp()
       When the alarm originally entered the active state. Preserved across
 acknowledge transitions so the Part 9 condition keeps the original raise
 time. Unset on retrigger from a previously-cleared condition.
      .google.protobuf.Timestamp original_raise_timestamp = 6;
      Returns:
      Whether the originalRaiseTimestamp field is set.

    • getOriginalRaiseTimestamp

      com.google.protobuf.Timestamp getOriginalRaiseTimestamp()
       When the alarm originally entered the active state. Preserved across
 acknowledge transitions so the Part 9 condition keeps the original raise
 time. Unset on retrigger from a previously-cleared condition.
      .google.protobuf.Timestamp original_raise_timestamp = 6;
      Returns:
      The originalRaiseTimestamp.

    • getOriginalRaiseTimestampOrBuilder

      com.google.protobuf.TimestampOrBuilder getOriginalRaiseTimestampOrBuilder()
       When the alarm originally entered the active state. Preserved across
 acknowledge transitions so the Part 9 condition keeps the original raise
 time. Unset on retrigger from a previously-cleared condition.
      .google.protobuf.Timestamp original_raise_timestamp = 6;

    • hasTransitionTimestamp

      boolean hasTransitionTimestamp()
       When this specific transition occurred (raise time on Raise, ack time on
 Acknowledge, clear time on Clear).
      .google.protobuf.Timestamp transition_timestamp = 7;
      Returns:
      Whether the transitionTimestamp field is set.

    • getTransitionTimestamp

      com.google.protobuf.Timestamp getTransitionTimestamp()
       When this specific transition occurred (raise time on Raise, ack time on
 Acknowledge, clear time on Clear).
      .google.protobuf.Timestamp transition_timestamp = 7;
      Returns:
      The transitionTimestamp.

    • getTransitionTimestampOrBuilder

      com.google.protobuf.TimestampOrBuilder getTransitionTimestampOrBuilder()
       When this specific transition occurred (raise time on Raise, ack time on
 Acknowledge, clear time on Clear).
      .google.protobuf.Timestamp transition_timestamp = 7;

    • getOperatorUser

      String getOperatorUser()
       Operator principal recorded by MXAccess on Acknowledge transitions.
 Empty on raise / clear.
      string operator_user = 8;
      Returns:
      The operatorUser.

    • getOperatorUserBytes

      com.google.protobuf.ByteString getOperatorUserBytes()
       Operator principal recorded by MXAccess on Acknowledge transitions.
 Empty on raise / clear.
      string operator_user = 8;
      Returns:
      The bytes for operatorUser.

    • getOperatorComment

      String getOperatorComment()
       Operator-supplied comment recorded by MXAccess on Acknowledge transitions.
 Empty on raise / clear or when no comment was supplied.
      string operator_comment = 9;
      Returns:
      The operatorComment.

    • getOperatorCommentBytes

      com.google.protobuf.ByteString getOperatorCommentBytes()
       Operator-supplied comment recorded by MXAccess on Acknowledge transitions.
 Empty on raise / clear or when no comment was supplied.
      string operator_comment = 9;
      Returns:
      The bytes for operatorComment.

    • getCategory

      String getCategory()
       MxAccess alarm category (taxonomy bucket configured in the Galaxy
 template, e.g. "Process", "Safety", "Diagnostics").
      string category = 10;
      Returns:
      The category.

    • getCategoryBytes

      com.google.protobuf.ByteString getCategoryBytes()
       MxAccess alarm category (taxonomy bucket configured in the Galaxy
 template, e.g. "Process", "Safety", "Diagnostics").
      string category = 10;
      Returns:
      The bytes for category.

    • getDescription

      String getDescription()
       Human-readable alarm description from the MxAccess alarm definition.
      string description = 11;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Human-readable alarm description from the MxAccess alarm definition.
      string description = 11;
      Returns:
      The bytes for description.

    • hasCurrentValue

      boolean hasCurrentValue()
       Current alarm value (the value of the source attribute at the moment of
 transition). Optional; populated when MxAccess surfaces it.
      .mxaccess_gateway.v1.MxValue current_value = 12;
      Returns:
      Whether the currentValue field is set.

    • getCurrentValue

      MxaccessGateway.MxValue getCurrentValue()
       Current alarm value (the value of the source attribute at the moment of
 transition). Optional; populated when MxAccess surfaces it.
      .mxaccess_gateway.v1.MxValue current_value = 12;
      Returns:
      The currentValue.

    • getCurrentValueOrBuilder

      MxaccessGateway.MxValueOrBuilder getCurrentValueOrBuilder()
       Current alarm value (the value of the source attribute at the moment of
 transition). Optional; populated when MxAccess surfaces it.
      .mxaccess_gateway.v1.MxValue current_value = 12;

    • hasLimitValue

      boolean hasLimitValue()
       Limit/threshold value that triggered the transition for limit alarms.
 Optional; populated for AnalogLimitAlarm-family transitions.
      .mxaccess_gateway.v1.MxValue limit_value = 13;
      Returns:
      Whether the limitValue field is set.

    • getLimitValue

      MxaccessGateway.MxValue getLimitValue()
       Limit/threshold value that triggered the transition for limit alarms.
 Optional; populated for AnalogLimitAlarm-family transitions.
      .mxaccess_gateway.v1.MxValue limit_value = 13;
      Returns:
      The limitValue.

    • getLimitValueOrBuilder

      MxaccessGateway.MxValueOrBuilder getLimitValueOrBuilder()
       Limit/threshold value that triggered the transition for limit alarms.
 Optional; populated for AnalogLimitAlarm-family transitions.
      .mxaccess_gateway.v1.MxValue limit_value = 13;

    • getDegraded

      boolean getDegraded()
       True when this transition came from the subtag-monitoring fallback rather
 than the native alarmmgr provider — synthesized from data changes, reduced
 fidelity (synthetic GUID, no native raise time).
      bool degraded = 14;
      Returns:
      The degraded.

    • getSourceProviderValue

      int getSourceProviderValue()
       Which provider produced this transition.
      .mxaccess_gateway.v1.AlarmProviderMode source_provider = 15;
      Returns:
      The enum numeric value on the wire for sourceProvider.

    • getSourceProvider

      MxaccessGateway.AlarmProviderMode getSourceProvider()
       Which provider produced this transition.
      .mxaccess_gateway.v1.AlarmProviderMode source_provider = 15;
      Returns:
      The sourceProvider.