Fix
This commit is contained in:
luosheng
275
Technosoftware/DaAeHdaClient/Ae/EventNotification.cs
Normal file
275
Technosoftware/DaAeHdaClient/Ae/EventNotification.cs
Normal file
@@ -0,0 +1,275 @@
|
||||
#region Copyright (c) 2011-2023 Technosoftware GmbH. All rights reserved
|
||||
//-----------------------------------------------------------------------------
|
||||
// Copyright (c) 2011-2023 Technosoftware GmbH. All rights reserved
|
||||
// Web: https://www.technosoftware.com
|
||||
//
|
||||
// The source code in this file is covered under a dual-license scenario:
|
||||
// - Owner of a purchased license: SCLA 1.0
|
||||
// - GPL V3: everybody else
|
||||
//
|
||||
// SCLA license terms accompanied with this source code.
|
||||
// See SCLA 1.0: https://technosoftware.com/license/Source_Code_License_Agreement.pdf
|
||||
//
|
||||
// GNU General Public License as published by the Free Software Foundation;
|
||||
// version 3 of the License are accompanied with this source code.
|
||||
// See https://technosoftware.com/license/GPLv3License.txt
|
||||
//
|
||||
// This source code is distributed in the hope that it will be useful, but
|
||||
// WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
||||
// or FITNESS FOR A PARTICULAR PURPOSE.
|
||||
//-----------------------------------------------------------------------------
|
||||
#endregion Copyright (c) 2011-2023 Technosoftware GmbH. All rights reserved
|
||||
|
||||
#region Using Directives
|
||||
|
||||
using System;
|
||||
|
||||
using Technosoftware.DaAeHdaClient.Da;
|
||||
|
||||
#endregion
|
||||
|
||||
namespace Technosoftware.DaAeHdaClient.Ae
|
||||
{
|
||||
/// <summary>
|
||||
/// A notification sent by the server when an event change occurs.
|
||||
/// </summary>
|
||||
[Serializable]
|
||||
public class TsCAeEventNotification : ICloneable
|
||||
{
|
||||
#region Fields
|
||||
private DateTime time_ = DateTime.MinValue;
|
||||
private TsCAeEventType eventType_ = TsCAeEventType.Condition;
|
||||
private int severity_ = 1;
|
||||
private AttributeCollection attributes_ = new AttributeCollection();
|
||||
private TsCDaQuality daQuality_ = TsCDaQuality.Bad;
|
||||
private DateTime activeTime_ = DateTime.MinValue;
|
||||
#endregion
|
||||
|
||||
#region AttributeCollection Class
|
||||
/// <summary>
|
||||
/// Contains a read-only collection of AttributeValues.
|
||||
/// </summary>
|
||||
[Serializable]
|
||||
public class AttributeCollection : OpcReadOnlyCollection
|
||||
{
|
||||
/// <summary>
|
||||
/// Creates an empty collection.
|
||||
/// </summary>
|
||||
internal AttributeCollection() : base(new object[0]) { }
|
||||
|
||||
/// <summary>
|
||||
/// Creates a collection from an array of objects.
|
||||
/// </summary>
|
||||
internal AttributeCollection(object[] attributes) : base(attributes) { }
|
||||
}
|
||||
#endregion
|
||||
|
||||
#region Properties
|
||||
/// <summary>
|
||||
/// The handle of the subscription that requested the notification
|
||||
/// </summary>
|
||||
public object ClientHandle { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The identifier for the source that generated the event.
|
||||
/// </summary>
|
||||
public string SourceID { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The time of the event occurrence.
|
||||
/// The <see cref="ApplicationInstance.TimeAsUtc">ApplicationInstance.TimeAsUtc</see> property defines
|
||||
/// the time format (UTC or local time).
|
||||
/// </summary>
|
||||
public DateTime Time
|
||||
{
|
||||
get => time_;
|
||||
set => time_ = value;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Event notification message describing the event.
|
||||
/// </summary>
|
||||
public string Message { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The type of event that generated the notification.
|
||||
/// </summary>
|
||||
public TsCAeEventType EventType
|
||||
{
|
||||
get => eventType_;
|
||||
set => eventType_ = value;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The vendor defined category id for the event.
|
||||
/// </summary>
|
||||
public int EventCategory { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The severity of the event (1..1000).
|
||||
/// </summary>
|
||||
public int Severity
|
||||
{
|
||||
get => severity_;
|
||||
set => severity_ = value;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The name of the condition related to this event notification.
|
||||
/// </summary>
|
||||
public string ConditionName { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The name of the current sub-condition, for multi-state conditions.
|
||||
/// For a single-state condition, this contains the condition name.
|
||||
/// </summary>
|
||||
public string SubConditionName { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The values of the attributes selected for the event subscription.
|
||||
/// </summary>
|
||||
public AttributeCollection Attributes => attributes_;
|
||||
|
||||
/// <summary>
|
||||
/// Indicates which properties of the condition have changed, to have caused the server to send the event notification.
|
||||
/// </summary>
|
||||
public int ChangeMask { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Indicates which properties of the condition have changed, to have caused the server to send the event notification.
|
||||
/// </summary>
|
||||
// ReSharper disable once UnusedMember.Global
|
||||
public string ChangeMaskAsText
|
||||
{
|
||||
get
|
||||
{
|
||||
string str = null;
|
||||
|
||||
if ((ChangeMask & 0x0001) == 0x0001) str = "Active State, ";
|
||||
if ((ChangeMask & 0x0002) == 0x0002) str += "Ack State, ";
|
||||
if ((ChangeMask & 0x0004) == 0x0004) str += "Enable State, ";
|
||||
if ((ChangeMask & 0x0008) == 0x0005) str += "Quality, ";
|
||||
if ((ChangeMask & 0x0010) == 0x0010) str += "Severity, ";
|
||||
if ((ChangeMask & 0x0020) == 0x0020) str += "SubCondition, ";
|
||||
if ((ChangeMask & 0x0040) == 0x0040) str += "Message, ";
|
||||
if ((ChangeMask & 0x0080) == 0x0080) str += "Attribute";
|
||||
|
||||
return str;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// A bit mask specifying the new state of the condition.
|
||||
/// </summary>
|
||||
public int NewState { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// A bit mask specifying the new state of the condition.
|
||||
/// </summary>
|
||||
// ReSharper disable once UnusedMember.Global
|
||||
public string NewStateAsText
|
||||
{
|
||||
get
|
||||
{
|
||||
string str;
|
||||
|
||||
if ((NewState & 0x0001) == 0x0001)
|
||||
{
|
||||
str = "Active, ";
|
||||
}
|
||||
else
|
||||
{
|
||||
str = "Inactive, ";
|
||||
}
|
||||
if ((NewState & 0x0002) == 0x0002)
|
||||
{
|
||||
str += "Acknowledged, ";
|
||||
}
|
||||
else
|
||||
{
|
||||
str += "UnAcknowledged, ";
|
||||
}
|
||||
if ((NewState & 0x0004) == 0x0004)
|
||||
{
|
||||
str += "Enabled";
|
||||
}
|
||||
else
|
||||
{
|
||||
str += "Disabled";
|
||||
}
|
||||
|
||||
return str;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The quality associated with the condition state.
|
||||
/// </summary>
|
||||
public TsCDaQuality Quality
|
||||
{
|
||||
get => daQuality_;
|
||||
set => daQuality_ = value;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Whether the related condition requires acknowledgment of this event.
|
||||
/// </summary>
|
||||
public bool AckRequired { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The 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).
|
||||
/// The <see cref="ApplicationInstance.TimeAsUtc">ApplicationInstance.TimeAsUtc</see> property defines
|
||||
/// the time format (UTC or local time).
|
||||
/// </summary>
|
||||
public DateTime ActiveTime
|
||||
{
|
||||
get => activeTime_;
|
||||
set => activeTime_ = value;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// A server defined cookie associated with the event notification.
|
||||
/// </summary>
|
||||
public int Cookie { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// For tracking events, this is the actor id for the event notification.
|
||||
/// For condition-related events, this is the acknowledgment id passed by the client.
|
||||
/// </summary>
|
||||
public string ActorID { get; set; }
|
||||
#endregion
|
||||
|
||||
#region Public Methods
|
||||
/// <summary>
|
||||
/// Sets the list of attribute values.
|
||||
/// </summary>
|
||||
public void SetAttributes(object[] attributes)
|
||||
{
|
||||
if (attributes == null)
|
||||
{
|
||||
attributes_ = new AttributeCollection();
|
||||
}
|
||||
else
|
||||
{
|
||||
attributes_ = new AttributeCollection(attributes);
|
||||
}
|
||||
}
|
||||
#endregion
|
||||
|
||||
#region ICloneable Members
|
||||
/// <summary>
|
||||
/// Creates a deep copy of the object.
|
||||
/// </summary>
|
||||
public virtual object Clone()
|
||||
{
|
||||
var clone = (TsCAeEventNotification)MemberwiseClone();
|
||||
|
||||
clone.attributes_ = (AttributeCollection)attributes_.Clone();
|
||||
|
||||
return clone;
|
||||
}
|
||||
#endregion
|
||||
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user