Refactorization : RegulValve --> RegValve on many places.

2021-03-29 22:34:15 +02:00
parent 1a8ef4f1be
commit 71c4f8f32f
30 changed files with 128 additions and 128 deletions
@@ -0,0 +1,118 @@
+///
+/// Copyright (c) 2017 Sensus Metering Systems
+///
+using System;
+using System.Collections.Generic;
+using log4net;
+using TBF.Rig.GenericDevices;
+
+namespace TBF.Rig.Dummy.RegValve
+{
+	public class SetRegValvePositionOp : IOperation
+	{
+		private static readonly ILog log = LogManager.GetLogger(typeof(SetRegValvePositionOp));
+		public override string ToString()
+		{
+            return string.Format("SetRegValvePositionOp({0},{1},{2})", regulValve.Name, posLoPct, posHiPct);
+		}
+
+		///
+		///  Internal states of this operation
+		///
+		enum OpState
+		{
+			Idle = 0,
+			MoveToPosition,		/// Send commend to move to position
+			CheckState,			/// Check RV state by reading statos word
+			MovingToPosition,	/// Command passed OK, RV is moving to a position
+		}
+		OpState opState;
+
+		/// Set by the constructor
+		readonly RegValve regulValve;
+        readonly double posLoPct;
+        readonly double posHiPct;
+        readonly int timeout;
+
+        ///  Process values
+        bool firstRun;
+        int expireTime;
+		bool positionReached;
+
+		/// <summary>
+        /// Set required water flow.
+        /// Events:  FlowSet, FlowTimeOut
+		/// </summary>
+		/// <param name="controlBoard">Control board device</param>
+		/// <param name="_regulValve">Regulation valve component</param>
+		/// <param name="posLoPct">Lower limit of the position to be achieved</param>
+		/// <param name="posHiPct">Upper limit of the position to be achieved</param>
+		/// <param name="timeout">Timeout in sec. for setting the flow</param>
+		/// <remarks>Only Elde.Valve flow are used, other flow on the lists are ignored</remarks>
+		public SetRegValvePositionOp(RegValve regulValve, double posLoPct, double posHiPct, int timeout)
+        {
+            this.regulValve = regulValve as RegValve;
+            if (regulValve == null) throw new ArgumentNullException("regValve is null or not Elde");
+
+			this.posLoPct = posLoPct;
+            this.posHiPct = posHiPct;
+
+            this.timeout = timeout;
+			
+			log.Debug(this.ToString());
+        }
+
+        /// <summary>
+        /// Set required water flow - no timeout.
+        /// Events:  FlowSet
+        /// </summary>
+        public SetRegValvePositionOp(RegValve regValve, double posLoPct, double posHiPct)
+            : this(regValve, posLoPct, posHiPct, int.MaxValue)
+        {
+        }
+
+		/// <summary>Start this operation</summary>
+		public void Start()
+        {
+            firstRun = true;
+            positionReached = false;
+            expireTime = StateMachine.Time + timeout;
+            log.InfoFormat("Start(): RV#={0}, reqPosLo={1}%, reqPosHi={2}%", posLoPct.ToString("F1"), posHiPct.ToString("F1"));
+			opState = OpState.MoveToPosition;
+        }
+
+		/// <summary>Run this operation</summary>
+		/// <returns>
+		///		Event.None  . . . . . . . busy adjusting position
+		///		Event.PositionReached . . position reached
+		///		Event.OpArgumentError . . invalid required position
+		/// </returns>
+		public Event Run()
+		{
+			if (opState == OpState.MoveToPosition)
+            {
+				opState = OpState.CheckState;
+                return Event.None;
+            }
+
+			if (positionReached) return Event.PositionReached;
+
+			if (opState == OpState.CheckState)
+			{
+				opState = OpState.MovingToPosition;
+				return Event.None;
+			}
+			else if (opState == OpState.MovingToPosition)
+			{
+				positionReached = true;
+				return Event.PositionReached;
+			}
+			return Event.None;
+		}
+
+        /// <summary>Stop this operation</summary>
+        public void Stop()
+		{
+        }
+	}
+}