833 lines
38 KiB
XML
833 lines
38 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Xylem.Common.Metrology.Measurements</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Xylem.Common.Metrology.Measurements.BaseMeasurement">
|
|
<inheritdoc />
|
|
<summary>
|
|
Holds all stuff for calibration of a Genesis Meter
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.BaseMeasurement.DutStartRecord">
|
|
<summary>
|
|
Record at the start of the measurement
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.BaseMeasurement.DutStopRecord">
|
|
<summary>
|
|
Record at the end of the measurement
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.BaseMeasurement._lastIntermediateRecord">
|
|
<summary>
|
|
Backup of intermediate record
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.BaseMeasurement._last2IntermediateRecord">
|
|
<summary>
|
|
Backup of intermediate record for short term result
|
|
This can be used to observe a result (e.g. flow rate)
|
|
between two intermediate records. The update time is
|
|
set in the ctor by intermediateUpdateTimeS.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.BaseMeasurement.IntermediateRecord">
|
|
<summary>
|
|
Intermediate record for ongoing measurement
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xylem.Common.Metrology.Measurements.BaseMeasurement.OnActionStateHasChanged">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.BaseMeasurement._accuDutOverflowVolumeCm">
|
|
<summary>
|
|
Holds the accumulated overflow volume, will work only if
|
|
<see cref="M:Xylem.Common.Metrology.Measurements.BaseMeasurement.CheckForOverFlowVolumeAndTime" /> is being called cyclically.
|
|
The overflow will take place due to the fixed point number format or the
|
|
display resolution setting.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.BaseMeasurement._accuDutOverflowTimeS">
|
|
<summary>
|
|
Holds the accumulated overflow time, will work only if
|
|
<see cref="M:Xylem.Common.Metrology.Measurements.BaseMeasurement.CheckForOverFlowVolumeAndTime" /> is being called cyclically.
|
|
The overflow takes place due to the fixed point number format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.BaseMeasurement.LoggerMeasurement">
|
|
<summary>
|
|
Logger for debug output of measurement
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.BaseMeasurement.Slot">
|
|
<summary>
|
|
Physical slot of the device
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.BaseMeasurement._channel">
|
|
<summary>
|
|
Identification of the channel
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xylem.Common.Metrology.Measurements.BaseMeasurement.MeasurementState">
|
|
<inheritdoc />
|
|
<summary>
|
|
State machine for one measurement (on one meter and one channel)
|
|
</summary>
|
|
<history date="2018Jan24" author="drabesch">
|
|
- add State-machine for better handling
|
|
</history>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.BaseMeasurement.#ctor(System.Int32,System.Type,System.Int32,System.Int32)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="slot"></param>
|
|
<param name="measurementRecordType"></param>
|
|
<param name="intermediateUpdateTimeS"></param>
|
|
<param name="channel"></param>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.BaseMeasurement.RequestIntermediateRecordByTimer(System.Object,System.Timers.ElapsedEventArgs)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="o"></param>
|
|
<param name="e"></param>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.BaseMeasurement.RequestIntermediateRecord">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.BaseMeasurement.GetType">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.BaseMeasurement.GetChannel">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.BaseMeasurement.Clear">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.BaseMeasurement.Dispose">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.BaseMeasurement.GetShortTermMeasurementResult(System.Nullable{System.Double},System.Nullable{System.Double})">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.BaseMeasurement.GetIntermediateMeasurementResult(System.Nullable{System.Double},System.Nullable{System.Double})">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.BaseMeasurement.GetFinalMeasurementResult(System.Nullable{System.Double},System.Nullable{System.Double})">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.BaseMeasurement.GetMeasurementState">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.BaseMeasurement.StopMeasurement">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.BaseMeasurement.StartMeasurement">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.BaseMeasurement.StartIntermediateMeasurement">
|
|
<summary>
|
|
Set flag for starting Calibration.
|
|
The next record is going to set the start values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.BaseMeasurement.AddData(Xylem.Common.Metrology.Measurements.IMeasurementRecord)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Xylem.Common.Metrology.Measurements.CalibrationMeasurement">
|
|
<inheritdoc />
|
|
<summary>
|
|
Holds all stuff for calibration of a Genesis Meter
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.CalibrationMeasurement.CalibFactorRelativeDefault">
|
|
<summary>
|
|
Calibration default value used to reset meter calibration
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.CalibrationMeasurement._calibFactorToleranceRelative">
|
|
<summary>
|
|
relative value (e.g. 0.05)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xylem.Common.Metrology.Measurements.CalibrationMeasurement.CalibFactorTolerancePercent">
|
|
<summary>
|
|
Setup the required tolerance in percent for check (e.g. 5 = +/-5%)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.CalibrationMeasurement.IsCalibFactorInTolerance(System.Double)">
|
|
<summary>
|
|
Check the tolerance of the calibration factor (e.g. 0.95 to 1.05 at 0.05 tolerance)
|
|
</summary>
|
|
<param name="calibFactorToCheck"></param>
|
|
<returns>true if the calibration factor is inside the tolerance </returns>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.CalibrationMeasurement.#ctor(System.Int32,System.Type,System.Int32,System.Int32)">
|
|
<inheritdoc />
|
|
<summary>
|
|
Remind the calibration factor for the register write access
|
|
</summary>
|
|
<param name="slot"></param>
|
|
<param name="measurementRecordType">FlowTestRecord or CalibrationRecord</param>
|
|
<param name="intermediateUpdateTimeS">Update time needed for overflow detection in seconds</param>
|
|
<param name="channel"></param>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.CalibrationMeasurement.CalculateCalibFactorRel(System.Double,System.Nullable{System.Double},System.Double)">
|
|
<summary>
|
|
Calculate calibration factor from reference volume and reference time if set.
|
|
The deviation can adjust the factor to a required offset, it may be useful not to calibrate to 0.0).
|
|
The Result is NOT being stored to the meter.
|
|
CAN BE USED FOR STATIC START/STOP AND FLYING START/STOP PROCEDURE
|
|
</summary>
|
|
<param name="refVolumeCm">reference volume in m³</param>
|
|
<param name="refTimeS">reference time in seconds</param>
|
|
<param name="reqDeviationPercent">the deviation to set the calibration in %</param>
|
|
<returns> calibration factor as relative value or null if calibration factor cannot be calculated</returns>
|
|
<history date="06-Dec-2018" author="Thomas Wiedebusch">
|
|
- The scale factor for calibration is going to adjusted here to keep the measurement result accurate.
|
|
</history>
|
|
</member>
|
|
<member name="T:Xylem.Common.Metrology.Measurements.Consts.MeasurementResultsStates">
|
|
<summary>
|
|
information about measurement results to identify on input depending results
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.MeasurementResultsStates.Okay">
|
|
<summary>
|
|
everything is good
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.MeasurementResultsStates.WrongChannel">
|
|
<summary>
|
|
inconsistent channel assignment
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.MeasurementResultsStates.ZeroDutTime">
|
|
<summary>
|
|
DUT time zero
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.MeasurementResultsStates.InvalidDutTime">
|
|
<summary>
|
|
DUT time is invalid
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.MeasurementResultsStates.InvalidOverFlowTime">
|
|
<summary>
|
|
over flow time is invalid
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.MeasurementResultsStates.ZeroRefTime">
|
|
<summary>
|
|
REF time zero
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.MeasurementResultsStates.InvalidRefTime">
|
|
<summary>
|
|
REF time is invalid
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.MeasurementResultsStates.ZeroDutVolume">
|
|
<summary>
|
|
DUT volume zero
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.MeasurementResultsStates.ZeroRefVolume">
|
|
<summary>
|
|
REF volume is unknown
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xylem.Common.Metrology.Measurements.Consts.MeasurementStates">
|
|
<summary>
|
|
holds the current state for genesis actions (e.g. calibration,measurement)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.MeasurementStates.NotStarted">
|
|
<summary>
|
|
If Measurement/Calibration/Action is not started
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.MeasurementStates.IsWaitingForStartData">
|
|
<summary>
|
|
Measurement/Calibration/Action waits for next record package and sore this as start record,
|
|
After this Measurement/Calibration/Action IsRunning
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.MeasurementStates.IsRunning">
|
|
<summary>
|
|
Measurement/Calibration/Action collecting record and wait for end call
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.MeasurementStates.IsWaitingForIntermediateData">
|
|
<summary>
|
|
Measurement/Calibration/Action collecting next record record
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.MeasurementStates.IsWaitingForEndData">
|
|
<summary>
|
|
Measurement/Calibration/Action waits for next record package and sore this as end record,
|
|
After this Measurement/Calibration/Action IsCompleted
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.MeasurementStates.IsCompleted">
|
|
<summary>
|
|
Measurement/Calibration/Action has start and end record and can calculate a result
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xylem.Common.Metrology.Measurements.Consts.ProcessState">
|
|
<summary>
|
|
ProcessState nearly linear
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.ProcessState.IsNotInit">
|
|
<summary>
|
|
meter not initialized
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.ProcessState.InitIsActive">
|
|
<summary>
|
|
meter currently in initialization
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.ProcessState.WaitForMeasurement">
|
|
<summary>
|
|
initialization done
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.ProcessState.MeasurementIsActive">
|
|
<summary>
|
|
meter is on measurement
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.ProcessState.MeasurementIsDone">
|
|
<summary>
|
|
Measurement is done (not equal to succeed)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.ProcessState.WaitForCalibration">
|
|
<summary>
|
|
Meter is prepared for calibration
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.ProcessState.CalibrationIsActive">
|
|
<summary>
|
|
meter is on calibration
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.ProcessState.WaitForQRef">
|
|
<summary>
|
|
need Q from reference meter for calculation
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.ProcessState.QRefDone">
|
|
<summary>
|
|
Calibration is calculated
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.ProcessState.CalibrationIsDone">
|
|
<summary>
|
|
Calibration is stored on meter
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xylem.Common.Metrology.Measurements.Consts.Units">
|
|
<summary>
|
|
SI Units
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xylem.Common.Metrology.Measurements.Consts.Units.Name">
|
|
<summary>
|
|
Unit definitions based on SI or derived SI or NON SI
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.Units.Name.UNITLESS">
|
|
<summary>
|
|
Value without any attachable unit []
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.Units.Name.NORMALIZED">
|
|
<summary>
|
|
Normalized to +/- 1.000 [norm]
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.Units.Name.PERCENT">
|
|
<summary>
|
|
Percent [%]
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.Units.Name.VOLTAGE_V">
|
|
<summary>
|
|
Voltage in Volts [V]
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.Units.Name.CURRENT_A">
|
|
<summary>
|
|
Current in Amperes [A]
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.Units.Name.ELECTRICAL_POWER_W">
|
|
<summary>
|
|
Electrical Power in Watts [W]
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.Units.Name.ELECTRICAL_LOAD_Ah">
|
|
<summary>
|
|
Electrical Load in Ampere hours [Ah]
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.Units.Name.DISTANCE_m">
|
|
<summary>
|
|
Distance in Meters [m]
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.Units.Name.FLOW_RATE_cm_per_h">
|
|
<summary>
|
|
Flow rate in cubic-meters per hour [m³/h]
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.Units.Name.TEMPERATURE_degC">
|
|
<summary>
|
|
Temperature in degree Celsius [°C]
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.Units.Name.TIME_s">
|
|
<summary>
|
|
Time in seconds [s]
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.Units.Name.PRESSURE_Pa">
|
|
<summary>
|
|
Pressure in Pascal [Pa]
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.Units.Name.FREQUENCY_Hz">
|
|
<summary>
|
|
Frequency in Hertz [Hz]
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xylem.Common.Metrology.Measurements.Consts.Units.SiUnit">
|
|
<summary>
|
|
Combine SI unit names with string value
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.Units.SiUnit.Name">
|
|
<summary>
|
|
Hard coded return string from FM2014
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.Units.SiUnit.AbbreviationStr">
|
|
<summary>
|
|
SI unit string
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.Consts.Units.SiUnit.#ctor(Xylem.Common.Metrology.Measurements.Consts.Units.Name,System.String)">
|
|
<summary>
|
|
Ctor
|
|
</summary>
|
|
<param name="name"></param>
|
|
<param name="abbreviationStr"></param>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.Consts.Units.SiUnitTbl">
|
|
<summary>
|
|
Table of SI and NON-SI units
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.Consts.Units.GetInfo(Xylem.Common.Metrology.Measurements.Consts.Units.Name)">
|
|
<summary>
|
|
Get the information string
|
|
</summary>
|
|
<param name="name"></param>
|
|
<returns>Unit string</returns>
|
|
<remarks date="2026-Jan-10" author="Thomas Wiedebusch">
|
|
- Initial.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Xylem.Common.Metrology.Measurements.IMeasurement">
|
|
<inheritdoc />
|
|
<summary>
|
|
Collection of measurement interfaces
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xylem.Common.Metrology.Measurements.IMeasurement.OnActionStateHasChanged">
|
|
<summary>
|
|
Event for new action of measurement state
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.IMeasurement.GetType">
|
|
<summary>
|
|
Get the Type of the measurement record
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.IMeasurement.GetChannel">
|
|
<summary>
|
|
Get the channel no. the measurement collecting record for
|
|
</summary>
|
|
<returns> returns 0 when all channels should be collected</returns>
|
|
</member>
|
|
<member name="P:Xylem.Common.Metrology.Measurements.IMeasurement.MeasurementState">
|
|
<summary>
|
|
Actual state of the measurement
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xylem.Common.Metrology.Measurements.IMeasurement.FlowDirectionforCalculatingVol">
|
|
<summary>
|
|
Actual state of the measurement
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.IMeasurement.Clear">
|
|
<summary>
|
|
Clear start, intermediate and end record and set action state to idle
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.IMeasurement.AddData(Xylem.Common.Metrology.Measurements.IMeasurementRecord)">
|
|
<summary>
|
|
Adding measurement record to processing FIFO
|
|
</summary>
|
|
<param name="record"></param>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.IMeasurement.GetMeasurementState">
|
|
<summary>
|
|
Returns the actual state of the ongoing measurement
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.IMeasurement.StartMeasurement">
|
|
<summary>
|
|
Fist clear all record from earlier calibrations.
|
|
Set flag for starting measurement.
|
|
The next record is going to set the start values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.IMeasurement.StopMeasurement">
|
|
<summary>
|
|
Stop grabbing record from streaming.
|
|
Last Data package is count as end volume (and time)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.IMeasurement.GetShortTermMeasurementResult(System.Nullable{System.Double},System.Nullable{System.Double})">
|
|
<summary>
|
|
Returning the results of the ongoing measurement between two updates.
|
|
This can be used to update the screen during measurements like actual flow rate.
|
|
The timing will be set by the IntermediateUpdateTimeS.
|
|
</summary>
|
|
<param name="refTimeS"></param>
|
|
<param name="refVolumeCm"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.IMeasurement.GetIntermediateMeasurementResult(System.Nullable{System.Double},System.Nullable{System.Double})">
|
|
<summary>
|
|
Returning the intermediate results of the ongoing measurement from the start of measurement until now!
|
|
</summary>
|
|
<param name="refTimeS"></param>
|
|
<param name="refVolumeCm"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.IMeasurement.GetFinalMeasurementResult(System.Nullable{System.Double},System.Nullable{System.Double})">
|
|
<summary>
|
|
Returning the results of the measurements from start until stop.
|
|
</summary>
|
|
<param name="refTimeS">Measurement duration is needed explicit for flying start/stop procedure</param>
|
|
<param name="refVolumeCm">reference volume is ALWAYS needed for scale and deviation</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.IMeasurement.RequestIntermediateRecord">
|
|
<summary>
|
|
Sets a marker that a mesaurment start looking for an intermediate record
|
|
</summary>
|
|
</member>
|
|
<member name="T:Xylem.Common.Metrology.Measurements.IMeasurementRecord">
|
|
<inheritdoc />
|
|
<summary>
|
|
interface for all incoming streaming protocol
|
|
to simplify measurements
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.IMeasurementRecord.GetVolumeCm">
|
|
<summary>
|
|
Get volume of the record
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.IMeasurementRecord.GetTimeS">
|
|
<summary>
|
|
Get time stamp of the record from meter
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.IMeasurementRecord.GetDataSyncMark">
|
|
<summary>
|
|
Get Data
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.IMeasurementRecord.GetChannel">
|
|
<summary>
|
|
Get the channel the record comes from
|
|
</summary>
|
|
<returns>returns 0 if the channel is unavailable for this type of record (e.g. protocol f) </returns>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.IMeasurementRecord.GetOverflowVolumeCm">
|
|
<summary>
|
|
Get overflow volume
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.IMeasurementRecord.GetOverflowTimeS">
|
|
<summary>
|
|
get overflow time
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Xylem.Common.Metrology.Measurements.MeasurementRecord">
|
|
<inheritdoc />
|
|
<summary>
|
|
struct to hold a measurement record
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementRecord.Channel">
|
|
<summary>
|
|
physical channel 1, 2 and 3
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementRecord.VolumeCm">
|
|
<summary>
|
|
actual volume in cubic meters
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementRecord.ForwardVolumeCm">
|
|
<summary>
|
|
Forward volume in cubic meters
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementRecord.NegativeReverseVolumeCm">
|
|
<summary>
|
|
Reverse volume in cubic meters as negative value
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementRecord.FlowRateCmPh">
|
|
<summary>
|
|
Flow rate in cubic meters per hour
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementRecord.OverflowVolumeCm">
|
|
<summary>
|
|
Overflow volume
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementRecord.TimeS">
|
|
<summary>
|
|
time converted to seconds
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementRecord.OverflowTimeS">
|
|
<summary>
|
|
Overflow time
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementRecord.Crc">
|
|
<summary>
|
|
CRC16 CCITT
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementRecord.IsValid">
|
|
<summary>
|
|
record is valid
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementRecord.SyncMarkRecord">
|
|
<summary>
|
|
Mark package as start, end, intermediate or not sync
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementRecord.DecodedTime">
|
|
<summary>
|
|
time when package was decoded
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementRecord.ReceivedTime">
|
|
<summary>
|
|
time when package was received
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.MeasurementRecord.GetVolumeCm">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.MeasurementRecord.GetTimeS">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.MeasurementRecord.GetDataSyncMark">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.MeasurementRecord.GetChannel">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.MeasurementRecord.GetOverflowVolumeCm">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.MeasurementRecord.GetOverflowTimeS">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.MeasurementRecord.Clone">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Xylem.Common.Metrology.Measurements.MeasurementResults">
|
|
<summary>
|
|
Calculate the measurements based on time, start- and stop-volume and overflow.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementResults.State">
|
|
<inheritdoc cref="T:Xylem.Common.Metrology.Measurements.Consts.MeasurementResultsStates"/>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementResults.Channel">
|
|
<summary>
|
|
Channel being needed for later analysis of channel number
|
|
as feedback to the caller
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementResults.AccuDutOverflowVolumeCm">
|
|
<summary>
|
|
Accumulated overflow volume in cubic-meters,
|
|
the DUT internal range can overflow due to
|
|
the limitation of the number or the display resolution.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementResults.AccuDutOverflowTimeS">
|
|
<summary>
|
|
Accumulated overflow time in seconds,
|
|
the number-range can cause an timer overflow.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementResults.DutStartRecord">
|
|
<summary>
|
|
DUT start record
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementResults.DutStopRecord">
|
|
<summary>
|
|
DUT end record
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementResults.DutVolumeCm">
|
|
<summary>
|
|
Volume = (End Volume + overflow) - Start Volume in cubic meters,
|
|
real DUT measurement uncorrected
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementResults.CorrectedDutVolumeCm">
|
|
<summary>
|
|
DUT measurement corrected if REF time is given
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementResults.RefVolumeCm">
|
|
<summary>
|
|
REF volume in cubic meters
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementResults.DutTimeS">
|
|
<summary>
|
|
Time = (End time + overflow) - Start time in seconds,
|
|
real DUT measurement uncorrected
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementResults.RefTimeS">
|
|
<summary>
|
|
REF time in seconds
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementResults.DutFlowRateCmPh">
|
|
<summary>
|
|
Flow rate in cubic meters per hour based on DUT
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementResults.RefFlowRateCmPh">
|
|
<summary>
|
|
Flow rate in cubic meters per hour based on REF
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementResults.ScaleFactorRefToDut">
|
|
<summary>
|
|
Scale factor between REF volume and DUT volume
|
|
this will use the <see cref="F:Xylem.Common.Metrology.Measurements.MeasurementResults.CorrectedDutVolumeCm"/>
|
|
/// </summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementResults.DeviationDutToRefRel">
|
|
<summary>
|
|
Deviation between DUT volume and REF volume relative,
|
|
this will use the <see cref="F:Xylem.Common.Metrology.Measurements.MeasurementResults.CorrectedDutVolumeCm"/>
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Metrology.Measurements.MeasurementResults.DeviationDutToRefPer">
|
|
<summary>
|
|
Deviation between DUT volume and REF volume in percent,
|
|
this will use the <see cref="F:Xylem.Common.Metrology.Measurements.MeasurementResults.CorrectedDutVolumeCm"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Metrology.Measurements.MeasurementResults.#ctor(Xylem.Common.Metrology.Measurements.IMeasurementRecord,Xylem.Common.Metrology.Measurements.IMeasurementRecord,System.Double,System.Double,System.Nullable{System.Double},System.Nullable{System.Double},System.Int32,Xylem.Common.Metrology.Measurements.Consts.MeasurementDirection)">
|
|
<summary>
|
|
Calculation of measurement results, overflow will be taken into account:
|
|
- DutVolumeCm in cubic meters:
|
|
DUT volume measurement uncorrected, direct measurement from the DUT,
|
|
- CorrectedDutVolumeCm in cubic meters:
|
|
equals the uncorrected DutVolumeCm if REF time is unknown,
|
|
else it is the volume calculated from the DUT flow-rate with the REF time,
|
|
- DutTimeS in seconds:
|
|
DUT time measurement,
|
|
- DutFlowRateCmPh in cubic meters per hour:
|
|
based on DUT volume and DUT time uncorrected,
|
|
- RefFlowRateCmPh in cubic meters per hour:
|
|
REF volume and REF time being used,
|
|
- ScaleFactorRefToDut unit less:
|
|
calculated with absolute and corrected DUT volume and REF volume
|
|
needed for calibration, is higher than one if DUT volume is less than the REF volume,
|
|
can be directly used to calculate the new scale by multiplication with the current scale,
|
|
- DeviationDutToRefRel unit less:
|
|
calculated with absolute and corrected DUT volume and REF volume
|
|
deviation needed for verification relative of DUT to REF,
|
|
- DeviationDutToRefPer in percent:
|
|
calculated with absolute and corrected DUT volume and REF volume
|
|
deviation needed for verification of DUT to REF in percent.
|
|
</summary>
|
|
<history date="07-Nov-2018" author="Thomas Wiedebusch">
|
|
- Scale factor calculation added,
|
|
- Deviation calculation added.
|
|
</history>
|
|
<history date="03-Nov-2018" author="Thomas Wiedebusch">
|
|
- Flow rate calculation added,
|
|
- Slot added.
|
|
</history>
|
|
<history date="19-Dec-2018" author="Thomas Wiedebusch">
|
|
- RefVolumeCm, RefTimeSS and absVolumeQm added,
|
|
- Slot removed.
|
|
</history>
|
|
<history date="22-Jan-2019" author="Thomas Wiedebusch">
|
|
- FlowRateQmPh split to DutFlowRateCmPh and RefFlowRateCmPh,
|
|
- CorrectedDutVolumeCm added,
|
|
- input channel compared with start and end record channels.
|
|
</history>
|
|
<history date="27-Feb-2019" author="Thomas Wiedebusch">
|
|
- State implemented.
|
|
</history>
|
|
<history date="01-Mar-2019" author="Thomas Wiedebusch">
|
|
- Check and states for DUT time zero, DUT volume zero, over flow volume below zero,
|
|
start and end record time below zero.
|
|
</history>
|
|
<history date="04-Mar-2019" author="Thomas Wiedebusch">
|
|
- Supported static start/stop with DUT- and REF-volume, this is time independent but the
|
|
DUT- and over-flow-times shouldn't be negative or zero.
|
|
- Meter renamed to DUT (Device under Test).
|
|
</history>
|
|
<param name="dutStartRecord">Start of measurement record set </param>
|
|
<param name="dutStopRecord">End of measurement record set </param>
|
|
<param name="accuDutOverflowVolumeCm">accumulated overflow volume, will add to result volume</param>
|
|
<param name="accuDutOverflowTimeS">accumulated overflow time, will add to result time</param>
|
|
<param name="refTimeS">measured REF time</param>
|
|
<param name="refVolumeCm">REF volume</param>
|
|
<param name="requiredChannel">physical channel of measurement path (0 for main measurement)</param>
|
|
</member>
|
|
</members>
|
|
</doc>
|