QuickOPC User's Guide and Reference
AEEventMappingKind Enumeration



OpcLabs.EasyOpcClassic Assembly > OpcLabs.EasyOpc.AlarmsAndEvents.LiveMapping Namespace : AEEventMappingKind Enumeration
Specifies how the OPC Alarms&Events event will be mapped.
Syntax
'Declaration
 
<ComVisibleAttribute(False)>
Public Enum AEEventMappingKind 
   Inherits System.Enum
   Implements System.IComparable, System.IConvertible, System.IFormattable 
'Usage
 
Dim instance As AEEventMappingKind
[ComVisible(false)]
public enum class AEEventMappingKind : public System.Enum, System.IComparable, System.IConvertible, System.IFormattable  
Members
MemberValueDescription
Acknowledged17Map new state of the condition: The condition is acknowledged.

Remarks:

This property is used only for Condition-Related Events (see EventType).

The linking target value is not changed if the operation resulted in an exception.

AcknowledgeRequired19Map a flag indicating that the related condition requires acknowledgment of this event.

Remarks:

This property is used only for Condition-Related Events (see EventType).

The determination of those events which require acknowledgment is server specific. For example, transition into a LimitAlarm condition would likely require an acknowledgment, while the event notification of the resulting acknowledgment would likely not require an acknowledgment.

The linking target value is not changed if the operation resulted in an exception.

Active16Map new state of the condition: The condition is active.

Remarks:

This property is used only for Condition-Related Events (see EventType).

The linking target value is not changed if the operation resulted in an exception.

ActiveTime20Map time that the condition became active (for single-state conditions), or the time of the transition into the current sub-condition (for multi-state conditions).

Remarks:

This property is used only for Condition-Related Events (see EventType).

This time is used by the client when acknowledging the condition.

The linking target value is not changed if the operation resulted in an exception.

ActorId22Map actor ID.

Remarks:

This property is used only for Tracking Events and for Condition-Related Events which are acknowledgment notifications (see EventType).

For tracking events, this is the actor ID for the event notification.

For condition-related events, this is the AcknowledgerID when the new state is acknowledged. If the AcknowledgerID is an empty string, the event was automatically acknowledged by the server.

For other events, the value is an empty string.

The linking target value is not changed if the operation resulted in an exception.

AttributeValues11Map a dictionary of vendor-specific event attributes.

Remarks:

Attributes are vendor-specific.

If a server cannot provide reasonable data for an attribute, the returned VARIANT should be set to VT_EMPTY.

This is a dictionary where the key is attribute ID, and the value is the actual value of that event attribute.

The linking target value is not changed if the operation resulted in an exception.

CategoryId9Map event category ID.

Remarks:

Standard and Vendor-specific event category codes.

The linking target value is not changed if the operation resulted in an exception.

ConditionName13Map the name of the condition related to this event notification.

Remarks:

This property is used only for Condition-Related Events (see EventType).

The linking target value is not changed if the operation resulted in an exception.

Cookie21Map server defined cookie associated with the event notification.

Remarks:

This property is used only for Condition-Related Events (see EventType).

The cookie is used by the client when acknowledging the condition. This value is opaque to the client.

The linking target value is not changed if the operation resulted in an exception.

Enabled15Map new state of the condition: The condition is enabled.

Remarks:

This property is used only for Condition-Related Events (see EventType).

The linking target value is not changed if the operation resulted in an exception.

ErrorId1Map the error ID, as System.String
ErrorMessage3Map the error message, as System.String. An empty string if the operation has been successful.
EventType8Map indication of Simple, Condition-Related, or Tracking event.

Remarks:

One of OpcLabs.EasyOpc.AlarmsAndEvents.AEEventType constants.

The linking target value is not changed if the operation resulted in an exception.

Exception2Map the exception, as Exception or a derived type. null if the operation has been successful.
Message7Map the event notification message describing the event. This is the default mapping kind.

Remarks:

The linking target value is not changed if the operation resulted in an exception.

QualifiedSourceName5Map the source of event notification.

Remarks:

The linking target value is not changed if the operation resulted in an exception.

Quality18Map the quality associated with the condition, as OpcLabs.EasyOpc.DataAccess.DAQuality.

Remarks:

This property is used only for Condition-Related Events (see EventType).

Values are as defined for the OPC Quality Flags in the OPC Data Access Server specification.

The linking target value is not changed if the operation resulted in an exception.

Result0Map the operation result, as OpcLabs.BaseLib.OperationModel.OperationResult or a derived type specific for the operation.
Severity10Map the event severity (1..1000).

Remarks:

The linking target value is not changed if the operation resulted in an exception.

StatusInfo4Map the status information, as StatusInfo.
SubconditionName14Map the name of the current sub-condition, for multi-state conditions. For a single-state condition, this contains the condition name.

Remarks:

This property is used only for Condition-Related Events (see EventType).

The linking target value is not changed if the operation resulted in an exception.

Time6Map the time of the event occurrence - for conditions, time that the condition transitioned into the new state or sub-condition.

Remarks:

For example, if the event notification is for acknowledgment of a condition, this would be the time that the condition became acknowledged.

The linking target value is not changed if the operation resulted in an exception.

Value12Map vendor-specific event attribute, specified by its ID.

Remarks:

Attributes are vendor-specific.

If a server cannot provide reasonable data for an attribute, the returned VARIANT should be set to VT_EMPTY.

The linking target value is not changed if the operation resulted in an exception.

Inheritance Hierarchy

System.Object
   System.ValueType
      System.Enum
         OpcLabs.EasyOpc.AlarmsAndEvents.LiveMapping.AEEventMappingKind

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2012 R2, Windows Server 2016; .NET: Linux, macOS, Microsoft Windows

See Also