tbf/TestBenchFramework/BenchControl/GenericDevices/IErrorFlags.cs

34 lines
1.2 KiB
C#

///
/// Copyright (c) 2017 Sensus Metering Systems
///
using System;
using System.Collections.Generic;
using TBF.BenchControl.Generic;
using Results.Entities;
namespace TBF.BenchControl.GenericDevices
{
public interface IErrorFlags : IComponent
{
Config.Entities.ErrorFlagsMode Mode { get; }
/// <summary>
/// Ger error flags for a test
/// </summary>
/// <param name="testRslt">A valid test result</param>
/// <param name="diverter">true = diverter was used (times apply)</param>
/// <param name="startStopValve">true = start/stop valve was used (times apply)</param>
/// <param name="switchTimeStart">Test start switch time in ms</param>
/// <param name="switchTimeEnd">Test end switch time in ms</param>
/// <returns>Error flags</returns>
int GetErrorFlags(TestRslt testRslt, bool diverter, bool startStopValve, int switchTimeStart, int switchTimeEnd);
/// <summary>
/// Get water meter error flags (evaluated from all meter test results)
/// </summary>
/// <param name="meterTestRslts">Meter test results</param>
/// <returns>Error flags</returns>
int GetWMtrErrorFlags(IList<MeterTestRslt> meterTestRslts);
}
}