tbf/TestBenchFramework/BenchControl/TestMethods/ReferenceFlowmeterCalibration/ReferenceFlowmeterCalibrationSeq.cs

///
/// Copyright (c) 2013-2016 Sensus Metering Systems
///
using System;
using System.Collections.Generic;
using System.Text;
using log4net;
using TBF.BenchControl;
using TBF.Boxes;
using TBF.Resources;
using TBF.UiBridge;

namespace TBF.BenchControl.TestMethods.ReferenceFlowmeterCalibration
{
	public class ReferenceFlowmeterCalibrationSeq : Sequences.SequenceBase
    {
		private static readonly ILog log = LogManager.GetLogger(typeof(ReferenceFlowmeterCalibrationSeq));

		/// <summary>
		/// Flying start mass collection method sequence
		/// </summary>
		/// <param name="test">Test entity</param>
		/// <returns>
		///		Event.Done . . . . . . . OK
		///		Event.UiCmdStop  . . . . Stopped by the user using the on-screen button STOP
		///		Event.OpArgumentError  . Target flow is out of range
		///		Event.Error  . . . . . . Unspecified error
		/// </returns>
		public IList<Event> Execute(Config.Entities.Test test, bool outerLoopMode, int outerLoopCounter)
		{
			Elde.ControlBoardDev cBrd = StateMachine.ControlBoard;

			IList<Event> e = new List<Event>();             /// Events from currently running operations
			Event retVal = Event.Done;
			checkUiOp = new Operations.CheckUIOp(true);     /// Runs in more then one state

			LtrPerRefPulse = outPath.FlowMeter.LtrPerPulse;	/// [ltr/pulse], nominal flow in [m3/h]

			/// Notes:
			///   float timeHr = volumeLtr / (1000.0f * targetFlow);
			///   float timeSec = 3600.0f * timeHr;
			///   int refPulses = (int)(timeSec * (2000.0f * targetFlow / pOut.FlowMeter.NominalFlow));
			int totalPulses = (int)(test.Volume / LtrPerRefPulse + 0.5f);

			processDataLoggingOp = new TBF.BenchControl.Operations.ProcessDataLoggingOp(processDataLogger, this, false);

			int repetitionNr = outerLoopMode ? outerLoopCounter : 1;	/// First test: repetitionNr=1				

			//====================================
			// Transition or SetRoute - Start
			//====================================
			switch (Transition(transitionBefore, TransitionContext.BeforeTest))
			{
				case Event.Error: { retVal = Event.Error; goto stopTest; }
				case Event.UiCmdStop: { retVal = Event.UiCmdStop; goto stopTest; }
			}

		//====================================
		loop:
			/// Start the test, initialize test results
			Bridge.OnTestSelected(this, new TestSelectedEventArgs(test, repetitionNr, inPath, benchPath, outPath, sensPath, totalPulses));
			string testName = Results.Utils.GetTestName(test.Name, test.Repeats, repetitionNr);
			TestStartTime = DateTime.Now;
			TestProgressEventArgs.SetEstimatedTimes(new int[] { 1, 1, 1, 30, 0, Convert.ToInt32(test.TstTime) + 15, 0, 0 });
			Bridge.OnTestProgress(this, new TestProgressEventArgs(test, repetitionNr, Config.Entities.Progress.JustStarted));


			Bridge.OnTestProgress(this, new TestProgressEventArgs(test, repetitionNr, Config.Entities.Progress.FlowSetting));
			int flowSetTime0 = StateMachine.Time;

			//------------------------------------------------
			Bridge.OnActivity(this, Strings.Setting_the_flow);
			//------------------------------------------------
			if (inPath.Pump is GenericDevices.IPumpFM) (inPath.Pump as GenericDevices.IPumpFM).TurnOn(test.PumpPower);

			State.Create("ReferenceFlowmeterCalibration : Starting the pump")
				.AddOperation(checkUiOp)
				.AddOperation(new Operations.TimerOp(5))
				.EnterState();
			do
			{
				e = StateMachine.WaitRunDevsRunOps();
				Bridge.OnProcessData(this, new ProcessDataEventArgs(test, repetitionNr, Config.Entities.Progress.FlowSetting));
				Bridge.OnTestProgress(this, new TestProgressEventArgs(test, repetitionNr, Config.Entities.Progress.FlowSetting));

				if (TestAndLogUiCmdStop(test,e)) { retVal = Event.UiCmdStop; goto stopTest; }
			}
			while (!e.Contains(Event.TimerExpired));


			State.Create("ReferenceFlowmeterCalibration : Starting the pump")
				.AddOperation(checkUiOp)
				.AddOperation(cBrd.SetValvesOp(inPath.Pump, null))
				.EnterState();
			do
			{
				e = StateMachine.WaitRunDevsRunOps();
				Bridge.OnProcessData(this, new ProcessDataEventArgs(test, repetitionNr, Config.Entities.Progress.FlowSetting));
				Bridge.OnTestProgress(this, new TestProgressEventArgs(test, repetitionNr, Config.Entities.Progress.FlowSetting));

				if (TestAndLogUiCmdStop(test,e)) { retVal = Event.UiCmdStop; goto stopTest; }
			}
			while (!e.Contains(Event.ValvesSet));


			if (!test.DoDraining)		/// If condition met => skip measuring and force emptying
			{
				///
				/// Measure the weight and skip emptying if there is enough room in the tank
				///
				State.Create("ReferenceFlowmeterCalibration : Measuring mass of water in the tank")
					.AddOperation(checkUiOp)
					.AddOperation(outPath.Scale.ReadMassOp(ref Mass))
					.EnterState();
				do
				{
					e = StateMachine.WaitRunDevsRunOps();
					Bridge.OnProcessData(this, new ProcessDataEventArgs(test, repetitionNr, Config.Entities.Progress.FlowSetting));
					Bridge.OnTestProgress(this, new TestProgressEventArgs(test, repetitionNr, Config.Entities.Progress.FlowSetting));

					if (e.Contains(Event.Error)) { retVal = Event.Error; goto stopTest; }
					if (TestAndLogUiCmdStop(test,e)) { retVal = Event.UiCmdStop; goto stopTest; }
				}
				while (!e.Contains(Event.BalanceDone));

				double estimatedEndMass = Mass.Val + test.Volume;
				if (estimatedEndMass < outPath.Scale.Capacity * Constants.TankFullFactor)
				{
					goto set_flow;      /// Enough room in the tank -> skip emptying
				}
			}

			///
			/// Empty the water tank
			///
			switch (DrainTheTank(outPath.Scale.DrainValve, outPath.Scale))
			{
				case Event.Error: { retVal = Event.Error; goto stopTest; }
				case Event.UiCmdStop: { retVal = Event.UiCmdStop; goto stopTest; }
			}

		set_flow:

			//--------------------------------
			State.Create("ReferenceFlowmeterCalibration : Setting the flow")
				.AddOperation(checkUiOp)
				.AddOperation(outPath.RegulValve.SetFlowOp(outPath.FlowMeter, test.Qfrom, test.Qto, outPath.PidCoef, RefFlow, 600))    /// timeout = 10 min.
				.EnterState();
			do
			{
				e = StateMachine.WaitRunDevsRunOps();
				Bridge.OnProcessData(this, new ProcessDataEventArgs(test, repetitionNr, Config.Entities.Progress.FlowSetting));
				Bridge.OnTestProgress(this, new TestProgressEventArgs(test, repetitionNr, Config.Entities.Progress.FlowSetting));

				if (e.Contains(Event.OpArgumentError)) { retVal = Event.OpArgumentError; goto stopTest; }
				if (TestAndLogUiCmdStop(test,e)) { retVal = Event.UiCmdStop; goto stopTest; }
				if (e.Contains(Event.RegulValveTimeOut))
				{
					Bridge.OnError(this, Strings.Timeout);
					retVal = Event.Done;
					goto stopTest;
				}
				if (e.Contains(Event.Next)) goto flow_set;
			}
			while (!e.Contains(Event.FlowReached));

		flow_set:
            int flowSetTime = StateMachine.Time - flowSetTime0;

			double currentFlow = RefFlow.Val;

			//------------------------------------------------
			Bridge.OnActivity(this, Strings.Measuring_the_weight);
			//------------------------------------------------
			State.Create("ReferenceFlowmeterCalibration : Measuring the start mass")
				.AddOperation(checkUiOp)
				.AddOperation(benchPath.TempMtrUp.ReadTempOp(ref TempUp))
				.AddOperation(benchPath.TempMtrDown.ReadTempOp(ref TempDown))
				.AddOperation(outPath.TempDiv.ReadTempOp(ref TempDiv))
				.AddOperation(benchPath.PressMtrUp.ReadPressureOp(ref PressUp))
				.AddOperation(benchPath.PressMtrDown.ReadPressureOp(ref PressDown))
				.AddOperation(benchPath.PressMtrDelta == null ? null : benchPath.PressMtrDelta.ReadPressureOp(ref PressDelta))
				.AddOperation((StateMachine.Ambient != null)
								? StateMachine.Ambient.ReadAmbientOp(AmbTemp, AmbPress, AmbHumi) : null)
                .AddOperation(outPath.Scale.ReadStableMassOp(ref StartMass, test.MassRepeats, test.MassSpread, test.MassMethod))
				.AddOperation(cBrd.UpdateTankWeightOp())
				.AddOperation(processDataLoggingOp)
				.EnterState();
			do
			{
				e = StateMachine.WaitRunDevsRunOps();
				if (e.Contains(Event.Error)) { retVal = Event.Error; goto stopTest; }
				if (TestAndLogUiCmdStop(test,e)) { retVal = Event.UiCmdStop; goto stopTest; }
			}
			while (!e.Contains(Event.BalanceDone));

			Mass.Val = StartMass.Val;

			//------------------------------------------------
			Bridge.OnActivity(this, Strings.Test_in_progress);
			//------------------------------------------------
			State.Create("ReferenceFlowmeterCalibration : Starting the test")
				.AddOperation(checkUiOp)
				.AddOperation(cBrd.StartMeasurementOp(outPath, Elde.TestMethods.Diverter | Elde.TestMethods.Synchro,
													  test.Qfrom, test.Qto, totalPulses, (float)test.TolerRed))
				.EnterState();
			do
			{
				e = StateMachine.WaitRunDevsRunOps();
				if (e.Contains(Event.Error)) { retVal = Event.Error; goto stopTest; }
				if (TestAndLogUiCmdStop(test,e)) { retVal = Event.UiCmdStop; goto stopTest; }
			}
			while (!e.Contains(Event.MeasurementStarted));

			/// Measurement loop - preparation
			readRegistersOp = new Operations.ReadMoreRegistersOp(sensPath.RegisterReaders);
			queryEnd1 = cBrd.QueryMeasurementEndOp();
			queryEnd2 = cBrd.QueryMeasurementEndOp();

			ClearAllStatistics(StateMachine.Time);

			/// Measurement loop - begin
			while (true)
			{
				//--------------------------------
				switch (ReadRegistersTempPressAmbient(null, true))
				{
					case Event.Error:       { retVal = Event.Error;     goto stopTest; }
					case Event.UiCmdStop:   { retVal = Event.UiCmdStop; goto stopTest; }
					case Event.MeasurementCompleted: goto test_completed;
				}

				RefFreq.Val = cBrd.ReferenceFreq;
				RefFlow.Val = cBrd.ReferenceFlow;
				UpdateAllStatistics(StateMachine.Time);

				Bridge.OnProcessData(this, new ProcessDataEventArgs(test, repetitionNr, Config.Entities.Progress.Test));
				Bridge.OnTestProgress(this, new TestProgressEventArgs(test, repetitionNr, Config.Entities.Progress.Test));
			}
		/// Measurement loop - end

		test_completed:
			State.Create("ReferenceFlowmeterCalibration : Waiting before mass measurement")
				.AddOperation(checkUiOp)
				.AddOperation(benchPath.TempMtrUp.ReadTempOp(ref TempUp))
				.AddOperation(benchPath.TempMtrDown.ReadTempOp(ref TempDown))
				.AddOperation(outPath.TempDiv.ReadTempOp(ref TempDiv))
				.AddOperation(benchPath.PressMtrUp.ReadPressureOp(ref PressUp))
				.AddOperation(benchPath.PressMtrDown.ReadPressureOp(ref PressDown))
				.AddOperation(benchPath.PressMtrDelta == null ? null : benchPath.PressMtrDelta.ReadPressureOp(ref PressDelta))
				.AddOperation(readRegistersOp)
				.AddOperation((StateMachine.Ambient != null)
								? StateMachine.Ambient.ReadAmbientOp(AmbTemp, AmbPress, AmbHumi) : null)
				.AddOperation(outPath.Scale.ReadMassOp(ref Mass))
				.AddOperation(cBrd.UpdateTankWeightOp())
				.AddOperation(processDataLoggingOp)
				.AddOperation(new Operations.TimerOp(test.TimeStop2Mass))
				.EnterState();
			do
			{
				e = StateMachine.WaitRunDevsRunOps();
				if (e.Contains(Event.Error)) { retVal = Event.Error; goto stopTest; }
				if (TestAndLogUiCmdStop(test,e)) { retVal = Event.UiCmdStop; goto stopTest; }
			}
			while (!e.Contains(Event.TimerExpired));

			//------------------------------------------------
			Bridge.OnActivity(this, Strings.Measuring_the_weight);
			//------------------------------------------------
			State.Create("ReferenceFlowmeterCalibration : Measuring the end mass")
				.AddOperation(checkUiOp)
				.AddOperation(benchPath.TempMtrUp.ReadTempOp(ref TempUp))
				.AddOperation(benchPath.TempMtrDown.ReadTempOp(ref TempDown))
				.AddOperation(outPath.TempDiv.ReadTempOp(ref TempDiv))
				.AddOperation(benchPath.PressMtrUp.ReadPressureOp(ref PressUp))
				.AddOperation(benchPath.PressMtrDown.ReadPressureOp(ref PressDown))
				.AddOperation(benchPath.PressMtrDelta == null ? null : benchPath.PressMtrDelta.ReadPressureOp(ref PressDelta))
				.AddOperation((StateMachine.Ambient != null)
								? StateMachine.Ambient.ReadAmbientOp(AmbTemp, AmbPress, AmbHumi) : null)
                .AddOperation(outPath.Scale.ReadStableMassOp(ref EndMass, test.MassRepeats, test.MassSpread, test.MassMethod))
				.AddOperation(cBrd.UpdateTankWeightOp())
				.AddOperation(processDataLoggingOp)
				.EnterState();
			do
			{
				e = StateMachine.WaitRunDevsRunOps();
				if (e.Contains(Event.Error)) { retVal = Event.Error; goto stopTest; }
				if (TestAndLogUiCmdStop(test,e)) { retVal = Event.UiCmdStop; goto stopTest; }
			}
			while (!e.Contains(Event.BalanceDone));
			///
			TestEndTime = DateTime.Now;

			//------------------------------------------------
			Bridge.OnActivity(this, Strings.Test_completed);
			//------------------------------------------------

			/// Make sure the CycleBeginForm is closed so that water meter data (s/n) can be copied into results
			if (UIFlowControl.Stop == WaitBeginFormClosed()) goto stopTest;

			///
			/// Populate TestResult data entity with data
			/// 
			Results.Entities.TestRslt tstRslt = BatchRslts.GetTestRslt(testName, test.Part);

			if (tstRslt != null)
			{
                UpdateTempPressDensAmb(tstRslt);

				/// Main results
				tstRslt.StartTime    = TestStartTime;
				tstRslt.EndTime      = TestEndTime;
				tstRslt.FlowSetTime  = flowSetTime;
				tstRslt.TestTime     = cBrd.TTime;																	/// [s] measurement time
				tstRslt.PulsesMaster = Convert.ToDouble(cBrd.EtPulses(0));											/// Pulses of the master flow meter (test total)
				tstRslt.MassStartRaw = StartMass.Val;
				tstRslt.MassStart    = Formulas.CorrectedValue(tstRslt.MassStartRaw, outPath.Scale.Corrections);
				tstRslt.MassEndRaw   = EndMass.Val;
				tstRslt.MassEnd      = Formulas.CorrectedValue(tstRslt.MassEndRaw, outPath.Scale.Corrections);
				tstRslt.FlowMass     = 3600.0 * (tstRslt.MassEnd - tstRslt.MassStart) / tstRslt.TestTime;			/// [kg/h]
				tstRslt.FlowVolume   = 3.6 * LtrPerRefPulse * tstRslt.PulsesMaster / tstRslt.TestTime;				/// [m3/h]
				tstRslt.VolumeCTV    = TBF.BenchControl.Formulas.Buoyancy() * (tstRslt.MassEnd - tstRslt.MassStart) / tstRslt.DensityOut;		/// [l] 1000.0f is because density is in [kg/m3]
				tstRslt.VolumeMaster = LtrPerRefPulse * tstRslt.PulsesMaster;											/// [l] volume from the master flow meter
				tstRslt.ConstMaster  = LtrPerRefPulse * tstRslt.VolumeCTV / tstRslt.VolumeMaster;					/// Corrected master pulses per liter
				tstRslt.ErrorMaster  = Formulas.ErrorFromVolumes(tstRslt.VolumeMaster, tstRslt.VolumeCTV);

				tstRslt.FlowMean = (float)RefFlowStat.Average;
                tstRslt.FlowMin = (float)RefFlowStat.Min;
                tstRslt.FlowMax = (float)RefFlowStat.Max;

				/// Update flowmeter constant with the measured one
				if (outPath.FlowMeter.Idx1 > 0 && outPath.FlowMeter.Idx1 <= ReferenceFlowmetersCount)
				{
					CalibratedLtrPerRefPulse[outPath.FlowMeter.Idx1 - 1] = Convert.ToSingle(tstRslt.ConstMaster);
					log.InfoFormat("Updating LtrPerRefPulse[{0}] = {1}", outPath.FlowMeter.Idx1 - 1, tstRslt.ConstMaster);
				}

				tstRslt.Components = Results.Entities.Components
					.UpdateList(BatchRslts.ComponentsList,
								new Results.Entities.Components((BenchInfo != null) ? BenchInfo.TestBenchId : 1,
																(BenchInfo != null) ? BenchInfo.TestBenchName : "testbench",
																inPath.Pump != null ? inPath.Pump.Name : string.Empty,
																outPath.FlowMeter != null ? outPath.FlowMeter.Name : string.Empty,
																outPath.Scale != null ? outPath.Scale.Name : string.Empty,
																outPath.RegulValve != null ? outPath.RegulValve.Name : string.Empty,
																outPath.Diverter != null ? outPath.Diverter.Name : string.Empty));

				/// Update results
				Bridge.OnTestCompleted(this, new TestCompletedEventArgs(testName, tstRslt));
			}

			Bridge.OnTestProgress(this, new TestProgressEventArgs(test, repetitionNr, Config.Entities.Progress.TransitionAfter));

			/// Append the results to the CSV-file
			allResults.Info(TestResult2CsvLine(testName, test.Part));

            Bridge.OnTestProgress(this, new TestProgressEventArgs(test, repetitionNr,
                    (retVal == Event.Done) ? Config.Entities.Progress.Completed : Config.Entities.Progress.Aborted));

			if (!outerLoopMode && (++repetitionNr <= test.Repeats))
			{
				goto loop;
			}


		stopTest:

			///----------------------///
			///  Quit this sequence  ///
			///----------------------///
			State.Create("ReferenceFlowmeterCalibration : Stopping diverter, gate, etc.")
				.AddOperation(checkUiOp)
				.AddOperation(cBrd.StopPreviousOp())
				.EnterState();
			do
			{
				e = StateMachine.WaitRunDevsRunOps();
				if (TestAndLogUiCmdStop(test,e)) { retVal = Event.UiCmdStop; goto stopTest; }
			}
			while (!e.Contains(Event.PreviousStopped));

			/// Transition sequence at the end of test
			/// Prevent overwriting 'retVal' in case it was set to non-default value earlier
			switch (Transition(transitionAfter, (retVal == Event.Done) ? TransitionContext.AfterTest : TransitionContext.Stop))
			{
				case Event.Error:	  { if (retVal == Event.Done) retVal = Event.Error;		break; }
				case Event.UiCmdStop: { if (retVal == Event.Done) retVal = Event.UiCmdStop; break; }
			}

            Bridge.OnTestProgress(this, new TestProgressEventArgs(test, repetitionNr,
                    (retVal == Event.Done) ? Config.Entities.Progress.Completed : Config.Entities.Progress.Aborted));

			/// Create a list with one item 'retVal' (default is Event.Done) and return it
			IList<Event> retList = new List<Event>(1);
			retList.Add(retVal);
			return retList;
		}
    }
}