/*
 * 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.
 */

namespace OpenTraffic.Model.SpeedFunctions
{
    using System;
    using System.Xml.Serialization;

    [Serializable]
    public class DensityGreenShields : SpeedFlow
    {
        [XmlIgnore]
        public override float MinSpeed { get { return vMin; } }

        [XmlIgnore]
        public override float MaxDensity { get { return kMax; } }

        public DensityGreenShields()
            : base(null, null)
        {
        }

        public DensityGreenShields(string name, string description)
            : base(name, description)
        {
        }

        public DensityGreenShields(string name, string description,
            float vMax, float vMin, float kMax)
            : base(name, description)
        {
            this.vMax = vMax;
            this.vMin = vMin;
            this.kMax = kMax;
        }

        public override float GetSpeedByDensity(float density)
        {
            return vMax * (1 - density / kMax);
        }
    }
}