Modbus.Net/Technosoftware/DaAeHdaClient/Hda/AggregateCollection.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.Hda
{
    /// <summary>
    /// The description of an item aggregate supported by the server.
    /// </summary>
    [Serializable]
    public class TsCHdaAggregateCollection : ICloneable, ICollection
    {
        #region Fields
        private TsCHdaAggregate[] hdaAggregates_ = new TsCHdaAggregate[0];
        #endregion

        #region Constructors, Destructor, Initialization
        /// <summary>
        /// Creates an empty collection.
        /// </summary>
        public TsCHdaAggregateCollection()
        {
            // do nothing.
        }

        /// <summary>
        /// Initializes the object with any Aggregates contained in the collection.
        /// </summary>
        /// <param name="collection">A collection containing aggregate descriptions.</param>
        public TsCHdaAggregateCollection(ICollection collection)
        {
            Init(collection);
        }
        #endregion

        #region Properties
        /// <summary>
        /// Returns the aggregate at the specified index.
        /// </summary>
        public TsCHdaAggregate this[int index]
        {
            get => hdaAggregates_[index];
            set => hdaAggregates_[index] = value;
        }
        #endregion

        #region Public Methods
        /// <summary>
        /// Returns the first aggregate with the specified id.
        /// </summary>
        public TsCHdaAggregate Find(int id)
        {
            foreach (var aggregate in hdaAggregates_)
            {
                if (aggregate.Id == id)
                {
                    return aggregate;
                }
            }

            return null;
        }

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

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

                foreach (var value in collection)
                {
                    if (value.GetType() == typeof(TsCHdaAggregate))
                    {
                        aggregates.Add(OpcConvert.Clone(value));
                    }
                }

                hdaAggregates_ = (TsCHdaAggregate[])aggregates.ToArray(typeof(TsCHdaAggregate));
            }
        }

        /// <summary>
        /// Removes all aggregates in the collection.
        /// </summary>
        public void Clear()
        {
            hdaAggregates_ = new TsCHdaAggregate[0];
        }
        #endregion

        #region ICloneable Members
        /// <summary>
        /// Creates a deep copy of the object.
        /// </summary>
        public virtual object Clone()
        {
            return new TsCHdaAggregateCollection(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 => hdaAggregates_?.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)
        {
            hdaAggregates_?.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(TsCHdaAggregate[] 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 hdaAggregates_.GetEnumerator();
        }
        #endregion
    }
}