C# Synth Toolkit - Part II

#region License

/* Copyright (c) 2007 Leslie Sanford
 * 
 * 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.
 */

#endregion

#region Contact

/*
 * Leslie Sanford
 * Email: jabberdabber@hotmail.com
 */

#endregion

using System;
using System.Collections;
using System.Collections.Generic;
using System.Diagnostics;

namespace Sanford.Multimedia.Synth
{
    /// <summary>
    /// Represents a collection of IProgrammable objects.
    /// </summary>
    /// <remarks>
    /// The ProgrammableCollection class provides functionality for treating 
    /// a collection of IProgrammable objects as one IProgrammable object.
    /// </remarks>
    public class ProgrammableCollection : ICollection<IProgrammable>, IProgrammable
    {
        #region ProgrammableCollection Members

        #region Fields

        // The collection of IProgrammable objects.
        private List<IProgrammable> Programmables = new List<IProgrammable>();

        // The total number of parameters.
        private int parameterCount = 0;

        #endregion

        #region Methods

        // Map the specified index to an underlying IProgrammable object.
        private int MapToParameter(int index, out IProgrammable Programmable)
        {
            Debug.Assert(index < ParameterCount);

            int i = index;
            IEnumerator<IProgrammable> en = GetEnumerator();

            en.MoveNext();

            // Iterate through the collection of IProgrammable objects until
            // the index falls within the range of one of the IProgrammable objects.
            while(i >= en.Current.ParameterCount)
            {
                // Offset index.
                i -= en.Current.ParameterCount;

                en.MoveNext();
            }

            Programmable = en.Current;

            // Return the offset index.
            return i;
        }

        #endregion

        #endregion

        #region ICollection<IProgrammable> Members

        public void Add(IProgrammable item)
        {
            Programmables.Add(item);

            parameterCount += item.ParameterCount;
        }

        public void Clear()
        {
            Programmables.Clear();

            parameterCount = 0;
        }

        public bool Contains(IProgrammable item)
        {
            return Programmables.Contains(item);
        }

        public void CopyTo(IProgrammable[] array, int arrayIndex)
        {
            Programmables.CopyTo(array, arrayIndex);
        }

        public int Count
        {
            get
            {
                return Programmables.Count;
            }
        }

        public bool IsReadOnly
        {
            get
            {
                return false;
            }
        }

        public bool Remove(IProgrammable item)
        {
            bool result;

            if(Programmables.Remove(item))
            {
                parameterCount -= item.ParameterCount;

                result = true;
            }
            else
            {
                result = false;
            }

            return result;
        }

        #endregion

        #region IEnumerable<IProgrammable> Members

        public IEnumerator<IProgrammable> GetEnumerator()
        {
            return Programmables.GetEnumerator();
        }

        #endregion

        #region IEnumerable Members

        IEnumerator IEnumerable.GetEnumerator()
        {
            return Programmables.GetEnumerator();
        }

        #endregion

        #region IProgrammable Members

        public string GetParameterName(int index)
        {
            #region Require

            if(index < 0 || index >= ParameterCount)
            {
                throw new ArgumentOutOfRangeException("index");
            }

            #endregion

            IProgrammable Programmable;
            int i = MapToParameter(index, out Programmable);

            return Programmable.GetParameterName(i);
        }

        public string GetParameterLabel(int index)
        {
            #region Require

            if(index < 0 || index >= ParameterCount)
            {
                throw new ArgumentOutOfRangeException("index");
            }

            #endregion

            IProgrammable Programmable;
            int i = MapToParameter(index, out Programmable);

            return Programmable.GetParameterLabel(i);
        }

        public string GetParameterDisplay(int index)
        {
            #region Require

            if(index < 0 || index >= ParameterCount)
            {
                throw new ArgumentOutOfRangeException("index");
            }

            #endregion

            IProgrammable Programmable;
            int i = MapToParameter(index, out Programmable);

            return Programmable.GetParameterDisplay(i);
        }

        public float GetParameterValue(int index)
        {
            #region Require

            if(index < 0 || index >= ParameterCount)
            {
                throw new ArgumentOutOfRangeException("index");
            }

            #endregion

            IProgrammable Programmable;
            int i = MapToParameter(index, out Programmable);

            return Programmable.GetParameterValue(i);
        }

        public void SetParameterValue(int index, float value)
        {
            #region Require

            if(index < 0 || index >= ParameterCount)
            {
                throw new ArgumentOutOfRangeException("index");
            }
            else if(value < 0 || value > 1)
            {
                throw new ArgumentOutOfRangeException("value");
            }

            #endregion

            IProgrammable Programmable;
            int i = MapToParameter(index, out Programmable);

            Programmable.SetParameterValue(i, value);
        }

        public int ParameterCount
        {
            get
            {
                return parameterCount;
            }
        }

        #endregion
    }
}