/*
 * Copyright (c) 2005-2006 Erik Tigerholm <eriktigerholm@gmail.com>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
using System;
using System.Collections.Generic;
using System.Text;
using System.Xml.Serialization;
namespace OpenTraffic.Model.SpeedFunctions
{
    [Serializable]
    [XmlInclude(typeof(GeneralisedBurghout))]
    [XmlInclude(typeof(FlowPartlyLinear))]
    [XmlInclude(typeof(DensityPartlyLinear))]
    [XmlInclude(typeof(DensityGreenShields))]
    public abstract class SpeedFlow
    {
        [XmlElement(ElementName = "Id")]
        public string IdRegister
        {
            get
            {
                return SpeedFlowName;
            }

            set
            {
                this.SpeedFlowName = value;
                Importer.Lookup.Get().Add<SpeedFlow>(value, this);
            }
        }

        [XmlElement(ElementName = "Name")]
        public string SpeedFlowName { get; set; }

        [XmlElement(ElementName = "Description")]
        public string Description { get; set; }

        [XmlAttribute(AttributeName = "vMax")]
        public float vMax { get; set; }

        [XmlAttribute(AttributeName = "vMin")]
        public float vMin { get; set; }

        [XmlAttribute(AttributeName = "kMax")]
        public float kMax { get; set; }

        [XmlAttribute(AttributeName = "kMin")]
        public float kMin { get; set; }

        [XmlAttribute(AttributeName = "a")]
        public float a { get; set; }

        [XmlAttribute(AttributeName = "b")]
        public float b { get; set; }

        [XmlIgnore]
        public abstract float MinSpeed { get; }

        [XmlIgnore]
        public abstract float MaxDensity { get; }

        protected SpeedFlow(string name, string description)
        {
            this.SpeedFlowName = name;
            this.Description = description;
        }

        public abstract float GetSpeedByDensity(float density);

        public override string ToString()
        {
            return SpeedFlowName;
        }
    }
}