tbf/TBF/Rig/Elde/PumpWithFM/Pump.cs

///
/// Copyright (c) 2013-2016 Sensus Metering Systems
///
using System;
using System.Collections.Generic;
using log4net;
using Dirichlet.Numerics;
using SchematicDrawing;
using TBF.Rig.ControlBoard.Legacy;

namespace TBF.Rig.Elde.PumpWithFM
{
    public class Pump : ComponentBase, GenericDevices.IPumpFM, GenericDevices.IValve, IOperation, IDrawingItCmpntWithSetpoint
	{
        private static readonly ILog log = LogManager.GetLogger(typeof(Pump));
        public override string ToString() { return string.Format("PumpWithFM({0})", Cfg.ToString(1)); }

        readonly PumpCfg pumpCfg;
        public IDrawingItem DrawingItem { get { return pumpCfg as IDrawingItem; } }

		public int Delay { get { return pumpCfg.Delay; } }
        public ValveCategory Category { get { return ValveCategory.Feeding; } }     /// Pump category is Feeding
        public GenericDevices.IValve CoupledTo { get { return null; } }
		public bool InvertCouple { get { return false; } }
		public int LagOpening { get { return 0; } }
		public int LagClosing { get { return 0; } }

		readonly CBoard controlBoard;
        readonly int bitPosition;					/// 0 .. 63
        int FMIndex; 					            /// 0 .. FMPumpsCount-1

		public readonly UInt128 Mask;					/// derived from bitPosition in the constructor

		public bool State
		{
			get { return (controlBoard.Route & Mask) != 0; }
		}

		/// <summary>
		/// Pump power in [%] in range 0 .. 100.0f
		/// </summary>
        private double power;
        public double Power { get { return power; } }
        /// 
        public double SetpointVal
        {
            get { return power; }
            set
            {
                power = (float)value;
                if (power != 0) TurnOn(power);
            }
        }
        /// 
        public void IncreaseSetpoint()
        {
            power += 0.05;
            if (power > 100.0) power = 100.0;
            TurnOn(power);
        }
        /// 
        public void DecreaseSetpoint()
        {
            power -= 0.05;
            if (power <= 0)
            {
                power = 0;
                TurnOff();
            }
            else
            {
                TurnOn(power);
            }
        }


		public Pump()
		{
		}

		/// <summary>
		/// Constructor
		/// </summary>
		/// <param name="cfg">Pump configuration object</param>
		/// <param name="components">List of all components (used to find the control board)</param>
		public Pump(Generic.IComponentCfg cfg, IList<Generic.IComponent> components)
            : base(cfg)
		{
            pumpCfg = cfg as PumpCfg;

			controlBoard = (CBoard)TbfComponents.FindComponent(cfg.ParentName, components);
			if (controlBoard == null) throw new Exception("Cannot find " + Name + " parent");

            bitPosition = pumpCfg.BitNr;
            Mask = (((UInt128)1) << pumpCfg.BitNr);
            FMIndex = pumpCfg.FMIndex;

            log.Warn(this.ToString());
		}


        public void TurnOn(double powerArg)
        {
            log.InfoFormat("{0}.TurnOn({1})", Name, powerArg);
			this.power = powerArg;
            controlBoard.SetFMFreq(FMIndex, powerArg);
        }

        public void TurnOff()
        {
            log.InfoFormat("{0}.TurnOff()", Name);
			this.power = 0.0f;
            controlBoard.SetFMFreq(FMIndex, 0.0f);
        }


		/// <summary>
		/// The currently running operation.
		/// </summary>
		public enum CurrentOp
		{
			None,
			TurnOn,
			TurnOff,
		}
		/// 
		CurrentOp currentOp;

        double powerForOp;

        /// <summary>
        /// Turn the pump frequency inverter on.
        /// </summary>
        public IOperation TurnOnOp(double powerArg)
        {
            if (currentOp != CurrentOp.None) throw new Exception("Sequence error");
            currentOp = CurrentOp.TurnOn;
            powerForOp = powerArg;
            return this;
        }

		/// <summary>
		/// Turn the pump frequency inverter on.
		/// </summary>
		public IOperation TurnOffOp()
		{
			if (currentOp != CurrentOp.None) throw new Exception("Sequence error");
			currentOp = CurrentOp.TurnOff;
			return this;
		}

		/// <summary>Start the operation</summary>
		public void Start()
		{
			switch (currentOp)
			{
                case CurrentOp.TurnOn:
					TurnOn(powerForOp);
					return;
				case CurrentOp.TurnOff:
				default:
                    TurnOff();
					return;
			}
		}

		/// <summary>Run the operation</summary>
		public Event Run()
		{
			return Event.TurnPumpOnOffDone;
		}

		/// <summary>Stop the operation</summary>
		public void Stop()
		{
			currentOp = CurrentOp.None;
		}
	}
}