UA-.NETStandard/SampleApplications/Samples/Controls.Net4/Subscriptions/NotificationMessageListCtrl.cs

/* ========================================================================
 * Copyright (c) 2005-2013 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.ComponentModel;
using System.Data;
using System.Drawing;
using System.Text;
using System.Windows.Forms;
using System.Reflection;

using Opc.Ua.Client;
using Opc.Ua.Client.Controls;

namespace Opc.Ua.Sample.Controls
{
    public partial class NotificationMessageListCtrl : Opc.Ua.Client.Controls.BaseListCtrl
    {
        #region Constructors
        /// <summary>
        /// Initializes the object with default values.
        /// </summary>
        public NotificationMessageListCtrl()
        {
            MaxMessageCount = 10;

            InitializeComponent();                        
			SetColumns(m_ColumnNames);

            ItemsLV.Sorting = SortOrder.Descending;
            m_SessionNotification = new NotificationEventHandler(Session_Notification);
        }
		#endregion

        #region Private Fields
        private Session m_session;
        private Subscription m_subscription;
        private NotificationEventHandler m_SessionNotification;
        private int m_maxMessageCount;
        
        /// <summary>
		/// The columns to display in the control.
		/// </summary>
		private readonly object[][] m_ColumnNames = new object[][]
		{
			new object[] { "Subscription",  HorizontalAlignment.Left,   null   },
			new object[] { "Message ID",    HorizontalAlignment.Center, null   },
			new object[] { "Publish Time",  HorizontalAlignment.Center, null   },
			new object[] { "Notifications", HorizontalAlignment.Center, null   },
			new object[] { "Data Changes",  HorizontalAlignment.Center, null   },
			new object[] { "EventTypes",    HorizontalAlignment.Center, null   }
		};
		#endregion

        #region Public Interface
        /// <summary>
        /// The maximum number of messages displayed in the control.
        /// </summary>
        public int MaxMessageCount
        {
            get { return m_maxMessageCount;  }
            set { m_maxMessageCount = value; }
        }

        /// <summary>
        /// Clears the contents of the control,
        /// </summary>
        public void Clear()
        {
            ItemsLV.Items.Clear();
            AdjustColumns();
        }

        /// <summary>
        /// Initializes the control with the session/subscription indicated.
        /// </summary>
        public void Initialize(Session session, Subscription subscription)
        {
            // do nothing if nothing has changed.
            if (Object.ReferenceEquals(session, m_session) && Object.ReferenceEquals(subscription, m_subscription))
            {
                return;
            }

            // subscription to event notifications.
            if (!Object.ReferenceEquals(session, m_session))
            {
                if (m_session != null)
                {
                    m_session.Notification -= m_SessionNotification;
                }

                if (session != null)
                {
                    session.Notification += m_SessionNotification;
                }
            }

            Clear();

            m_session = session;
            m_subscription = subscription;

            // nothing to do if no session provided.
            if (m_session == null)
            {
                return;
            }                     
                        
            List<ItemData> tags = new List<ItemData>();

            // display only items for current subscription.
            if (subscription != null)
            {
                foreach (NotificationMessage item in subscription.Notifications)
                {
                    tags.Insert(0, new ItemData(subscription, item));
                }
            }

            // display all notifications for all subscriptions.
            else
            {
                foreach (Subscription item1 in m_session.Subscriptions)
                {
                    foreach (NotificationMessage item2 in item1.Notifications)
                    {
                        tags.Insert(0, new ItemData(item1, item2));
                    }
                }
            }
            
            // update control.
            Update(tags);
        }
        #endregion
        
        #region ItemData Class
        /// <summary>
        /// Stores the data associated with a list view item.
        /// </summary>
        public class ItemData
        {
            public Subscription        Subscription;
            public NotificationMessage NotificationMessage;

            public ItemData(
                Subscription        subscription,
                NotificationMessage notificationMessage)
            {
                Subscription        = subscription;
                NotificationMessage = notificationMessage;
            }
        }
        #endregion

        #region Overridden Methods
        /// <see cref="BaseListCtrl.EnableMenuItems" />
		protected override void EnableMenuItems(ListViewItem clickedItem)
		{
            if (m_session != null)
            {
                OptionsMI.Enabled   = true;
                ClearMI.Enabled     = true;
                RepublishMI.Enabled = m_subscription != null;

                if (clickedItem != null)
                {
                    ItemData itemData = clickedItem.Tag as ItemData;

                    if (itemData != null)
                    {
                        ViewMI.Enabled   = true;
                        DeleteMI.Enabled = true;
                    }
                }
            }
		}

        /// <see cref="BaseListCtrl.UpdateItem" />
        protected override void UpdateItem(ListViewItem listItem, object item)
        {
            ItemData itemData = item as ItemData;

			if (itemData == null)
			{
				base.UpdateItem(listItem, item);
				return;
			}

			listItem.SubItems[0].Text  = String.Format("{0}", itemData.Subscription.DisplayName);
			listItem.SubItems[1].Text  = String.Format("{0}", itemData.NotificationMessage.SequenceNumber);
			listItem.SubItems[2].Text  = String.Format("{0:HH:mm:ss.fff}", itemData.NotificationMessage.PublishTime.ToLocalTime());
			
            int events = 0;
            int datachanges = 0;
            int notifications = 0;

            foreach (ExtensionObject notification in itemData.NotificationMessage.NotificationData)
            {
                notifications++;

                if (ExtensionObject.IsNull(notification))
                {
                    continue;
                }

                DataChangeNotification datachangeNotification = notification.Body as DataChangeNotification;

                if (datachangeNotification != null)
                {
                    datachanges += datachangeNotification.MonitoredItems.Count;
                }

                EventNotificationList EventNotification = notification.Body as EventNotificationList;

                if (EventNotification != null)
                {
                    events += EventNotification.Events.Count;
                }
            }

            listItem.SubItems[3].Text  = String.Format("{0}", notifications);
            listItem.SubItems[4].Text  = String.Format("{0}", datachanges);
            listItem.SubItems[5].Text  = String.Format("{0}", events);

			listItem.Tag = item;
        }
		#endregion

        private void Update(List<ItemData> tags)
        {
            if (tags.Count > MaxMessageCount)
            {
                tags.RemoveRange(MaxMessageCount, tags.Count-MaxMessageCount);
            }
                            
            BeginUpdate();
            
            foreach (ItemData tag in tags)
            {
                AddItem(tag);
            }

            EndUpdate();
        }

        private void Session_Notification(Session sender, NotificationEventArgs e)
        {
            if (InvokeRequired)
            {
                BeginInvoke(m_SessionNotification, sender, e);
                return;
            }
            else if (!IsHandleCreated)
            {
                return;
            }
            
            try
            {
                if (m_subscription != null)
                {
                    if (!Object.ReferenceEquals(m_subscription, e.Subscription))
                    {
                        return;
                    }
                }

                AddItem(new ItemData(e.Subscription, e.NotificationMessage));

                if (ItemsLV.Items.Count > MaxMessageCount)
                {
                    for (int i = 0; i < (ItemsLV.Items.Count - MaxMessageCount); i++)
                    {
                        ItemsLV.Items.RemoveAt(i);
                    }
                }
            }
            catch (Exception exception)
            {
				GuiUtils.HandleException(this.Text, MethodBase.GetCurrentMethod(), exception);
            }
        }

        private void ViewMI_Click(object sender, EventArgs e)
        {
            try
            {
            }
            catch (Exception exception)
            {
				GuiUtils.HandleException(this.Text, MethodBase.GetCurrentMethod(), exception);
            }
        }

        private void DeleteMI_Click(object sender, EventArgs e)
        {
            try
            {
                for (int ii = 0; ii < ItemsLV.SelectedItems.Count;)
                {
                    ItemsLV.SelectedItems[ii].Remove();
                }
            }
            catch (Exception exception)
            {
				GuiUtils.HandleException(this.Text, MethodBase.GetCurrentMethod(), exception);
            }
        }

        private void ClearMI_Click(object sender, EventArgs e)
        {
            try
            {
                Clear();
            }
            catch (Exception exception)
            {
				GuiUtils.HandleException(this.Text, MethodBase.GetCurrentMethod(), exception);
            }
        }

        private void RepublishMI_Click(object sender, EventArgs e)
        {
            try
            {
                if (m_subscription == null)
                {
                    return;
                }

                NotificationMessage message = new RepublishNotificationMessageDlg().ShowDialog(m_subscription);

                if (message != null)
                {
                    ListViewItem listItem = AddItem(new ItemData(m_subscription, message));
                    listItem.ForeColor = Color.Red;
                }
            }
            catch (Exception exception)
            {
				GuiUtils.HandleException(this.Text, MethodBase.GetCurrentMethod(), exception);
            }
        }
    }
}