Modbus.Net/Technosoftware/DaAeHdaClient/OpcItemResultCollection.cs

#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 System.Collections;
#endregion

namespace Technosoftware.DaAeHdaClient
{
    /// <summary>
    /// A collection of identified results.
    /// </summary>
    [Serializable]
    public class OpcItemResultCollection : ICloneable, ICollection
    {
        /// <summary>
        /// Returns the IdentifiedResult at the specified index.
        /// </summary>
        public OpcItemResult this[int index]
        {
            get => itemResults_[index];
            set => itemResults_[index] = value;
        }

        /// <summary>
        /// Creates an empty collection.
        /// </summary>
        public OpcItemResultCollection()
        {
            // do nothing.
        }

        /// <summary>
        /// Initializes the object with any IdentifiedResults contained in the collection.
        /// </summary>
        /// <param name="collection">A collection containing item ids.</param>
        public OpcItemResultCollection(ICollection collection)
        {
            Init(collection);
        }

        /// <summary>
        /// Initializes the object with any item ids contained in the collection.
        /// </summary>
        /// <param name="collection">A collection containing item ids.</param>
        public void Init(ICollection collection)
        {
            Clear();

            if (collection != null)
            {
                var itemIDs = new ArrayList(collection.Count);

                foreach (var value in collection)
                {
                    if (value is OpcItemResult result)
                    {
                        itemIDs.Add(result.Clone());
                    }
                }

                itemResults_ = (OpcItemResult[])itemIDs.ToArray(typeof(OpcItemResult));
            }
        }

        /// <summary>
        /// Removes all itemIDs in the collection.
        /// </summary>
        public void Clear()
        {
            itemResults_ = new OpcItemResult[0];
        }

        #region ICloneable Members
        /// <summary>
        /// Creates a deep copy of the object.
        /// </summary>
        public virtual object Clone()
        {
            return new OpcItemResultCollection(this);
        }
        #endregion

        #region ICollection Members
        /// <summary>
        /// Indicates whether access to the ICollection is synchronized (thread-safe).
        /// </summary>
        public bool IsSynchronized => false;

        /// <summary>
        /// Gets the number of objects in the collection.
        /// </summary>
        public int Count => itemResults_?.Length ?? 0;

        /// <summary>
        /// Copies the objects to an Array, starting at a the specified index.
        /// </summary>
        /// <param name="array">The one-dimensional Array that is the destination for the objects.</param>
        /// <param name="index">The zero-based index in the Array at which copying begins.</param>
        public void CopyTo(Array array, int index)
        {
            itemResults_?.CopyTo(array, index);
        }

        /// <summary>
        /// Copies the objects to an Array, starting at a the specified index.
        /// </summary>
        /// <param name="array">The one-dimensional Array that is the destination for the objects.</param>
        /// <param name="index">The zero-based index in the Array at which copying begins.</param>
        public void CopyTo(OpcItemResult[] array, int index)
        {
            CopyTo((Array)array, index);
        }

        /// <summary>
        /// Indicates whether access to the ICollection is synchronized (thread-safe).
        /// </summary>
        public object SyncRoot => this;
        #endregion

        #region IEnumerable Members
        /// <summary>
        /// Returns an enumerator that can iterate through a collection.
        /// </summary>
        /// <returns>An IEnumerator that can be used to iterate through the collection.</returns>
        public IEnumerator GetEnumerator()
        {
            return itemResults_.GetEnumerator();
        }
        #endregion

        #region Private Members
        private OpcItemResult[] itemResults_ = new OpcItemResult[0];
        #endregion
    }
}