Samuele Locatelli
294 lines
9.5 KiB
C#
294 lines
9.5 KiB
C#
/* ========================================================================
|
|
* Copyright (c) 2005-2020 The OPC Foundation, Inc. All rights reserved.
|
|
*
|
|
* OPC Foundation MIT License 1.00
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person
|
|
* obtaining a copy of this software and associated documentation
|
|
* files (the "Software"), to deal in the Software without
|
|
* restriction, including without limitation the rights to use,
|
|
* copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the
|
|
* Software is furnished to do so, subject to the following
|
|
* conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be
|
|
* included in all copies or substantial portions of the Software.
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
* OTHER DEALINGS IN THE SOFTWARE.
|
|
*
|
|
* The complete license agreement can be found here:
|
|
* http://opcfoundation.org/License/MIT/1.00/
|
|
* ======================================================================*/
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Text;
|
|
using System.Xml;
|
|
using System.Runtime.Serialization;
|
|
|
|
namespace Opc.Ua.Client
|
|
{
|
|
/// <summary>
|
|
/// The current status of monitored item.
|
|
/// </summary>
|
|
public class MonitoredItemStatus
|
|
{
|
|
#region Constructors
|
|
/// <summary>
|
|
/// Creates a empty object.
|
|
/// </summary>
|
|
internal MonitoredItemStatus()
|
|
{
|
|
Initialize();
|
|
}
|
|
|
|
private void Initialize()
|
|
{
|
|
m_id = 0;
|
|
m_nodeId = null;
|
|
m_attributeId = Attributes.Value;
|
|
m_indexRange = null;
|
|
m_encoding = null;
|
|
m_monitoringMode = MonitoringMode.Disabled;
|
|
m_clientHandle = 0;
|
|
m_samplingInterval = 0;
|
|
m_filter = null;
|
|
m_queueSize = 0;
|
|
m_discardOldest = true;
|
|
}
|
|
#endregion
|
|
|
|
#region Public Properties
|
|
/// <summary>
|
|
/// The identifier assigned by the server.
|
|
/// </summary>
|
|
public uint Id
|
|
{
|
|
get { return m_id; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Whether the item has been created on the server.
|
|
/// </summary>
|
|
public bool Created
|
|
{
|
|
get { return m_id != 0; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Any error condition associated with the monitored item.
|
|
/// </summary>
|
|
public ServiceResult Error
|
|
{
|
|
get { return m_error; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// The node id being monitored.
|
|
/// </summary>
|
|
public NodeId NodeId
|
|
{
|
|
get { return m_nodeId; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// The attribute being monitored.
|
|
/// </summary>
|
|
public uint AttributeId
|
|
{
|
|
get { return m_attributeId; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// The range of array indexes to being monitored.
|
|
/// </summary>
|
|
public string IndexRange
|
|
{
|
|
get { return m_indexRange; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// The encoding to use when returning notifications.
|
|
/// </summary>
|
|
public QualifiedName DataEncoding
|
|
{
|
|
get { return m_encoding; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// The monitoring mode.
|
|
/// </summary>
|
|
public MonitoringMode MonitoringMode
|
|
{
|
|
get { return m_monitoringMode; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// The identifier assigned by the client.
|
|
/// </summary>
|
|
public uint ClientHandle
|
|
{
|
|
get { return m_clientHandle; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// The sampling interval.
|
|
/// </summary>
|
|
public double SamplingInterval
|
|
{
|
|
get { return m_samplingInterval; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// The filter to use to select values to return.
|
|
/// </summary>
|
|
public MonitoringFilter Filter
|
|
{
|
|
get { return m_filter; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// The length of the queue used to buffer values.
|
|
/// </summary>
|
|
public uint QueueSize
|
|
{
|
|
get { return m_queueSize; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Whether to discard the oldest entries in the queue when it is full.
|
|
/// </summary>
|
|
public bool DiscardOldest
|
|
{
|
|
get { return m_discardOldest; }
|
|
}
|
|
#endregion
|
|
|
|
#region Public Methods
|
|
/// <summary>
|
|
/// Updates the monitoring mode.
|
|
/// </summary>
|
|
public void SetMonitoringMode(MonitoringMode monitoringMode)
|
|
{
|
|
m_monitoringMode = monitoringMode;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Updates the object with the results of a translate browse paths request.
|
|
/// </summary>
|
|
internal void SetResolvePathResult(
|
|
BrowsePathResult result,
|
|
ServiceResult error)
|
|
{
|
|
m_error = error;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Updates the object with the results of a create monitored item request.
|
|
/// </summary>
|
|
internal void SetCreateResult(
|
|
MonitoredItemCreateRequest request,
|
|
MonitoredItemCreateResult result,
|
|
ServiceResult error)
|
|
{
|
|
if (request == null) throw new ArgumentNullException(nameof(request));
|
|
if (result == null) throw new ArgumentNullException(nameof(result));
|
|
|
|
m_nodeId = request.ItemToMonitor.NodeId;
|
|
m_attributeId = request.ItemToMonitor.AttributeId;
|
|
m_indexRange = request.ItemToMonitor.IndexRange;
|
|
m_encoding = request.ItemToMonitor.DataEncoding;
|
|
m_monitoringMode = request.MonitoringMode;
|
|
m_clientHandle = request.RequestedParameters.ClientHandle;
|
|
m_samplingInterval = request.RequestedParameters.SamplingInterval;
|
|
m_queueSize = request.RequestedParameters.QueueSize;
|
|
m_discardOldest = request.RequestedParameters.DiscardOldest;
|
|
m_filter = null;
|
|
m_error = error;
|
|
|
|
if (request.RequestedParameters.Filter != null)
|
|
{
|
|
m_filter = Utils.Clone(request.RequestedParameters.Filter.Body) as MonitoringFilter;
|
|
}
|
|
|
|
if (ServiceResult.IsGood(error))
|
|
{
|
|
m_id = result.MonitoredItemId;
|
|
m_samplingInterval = result.RevisedSamplingInterval;
|
|
m_queueSize = result.RevisedQueueSize;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Updates the object with the results of a modify monitored item request.
|
|
/// </summary>
|
|
internal void SetModifyResult(
|
|
MonitoredItemModifyRequest request,
|
|
MonitoredItemModifyResult result,
|
|
ServiceResult error)
|
|
{
|
|
if (request == null) throw new ArgumentNullException(nameof(request));
|
|
if (result == null) throw new ArgumentNullException(nameof(result));
|
|
|
|
m_error = error;
|
|
|
|
if (ServiceResult.IsGood(error))
|
|
{
|
|
m_clientHandle = request.RequestedParameters.ClientHandle;
|
|
m_samplingInterval = request.RequestedParameters.SamplingInterval;
|
|
m_queueSize = request.RequestedParameters.QueueSize;
|
|
m_discardOldest = request.RequestedParameters.DiscardOldest;
|
|
m_filter = null;
|
|
|
|
if (request.RequestedParameters.Filter != null)
|
|
{
|
|
m_filter = Utils.Clone(request.RequestedParameters.Filter.Body) as MonitoringFilter;
|
|
}
|
|
|
|
m_samplingInterval = result.RevisedSamplingInterval;
|
|
m_queueSize = result.RevisedQueueSize;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Updates the object with the results of a delete item request.
|
|
/// </summary>
|
|
internal void SetDeleteResult(ServiceResult error)
|
|
{
|
|
m_id = 0;
|
|
m_error = error;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Sets the error state for the monitored item status.
|
|
/// </summary>
|
|
internal void SetError(ServiceResult error)
|
|
{
|
|
m_error = error;
|
|
}
|
|
#endregion
|
|
|
|
#region Private Fields
|
|
private uint m_id;
|
|
private ServiceResult m_error;
|
|
private NodeId m_nodeId;
|
|
private uint m_attributeId;
|
|
private string m_indexRange;
|
|
private QualifiedName m_encoding;
|
|
private MonitoringMode m_monitoringMode;
|
|
private uint m_clientHandle;
|
|
private double m_samplingInterval;
|
|
private MonitoringFilter m_filter;
|
|
private uint m_queueSize;
|
|
private bool m_discardOldest;
|
|
#endregion
|
|
}
|
|
}
|