564 lines
29 KiB
XML
564 lines
29 KiB
XML
|
<?xml version="1.0"?>
|
|||
|
|
<doc>
|
|||
|
|
<assembly>
|
|||
|
|
<name>Xylem.Common.Hardware.WaterMeter.WaterMeterCore</name>
|
|||
|
|
</assembly>
|
|||
|
|
<members>
|
|||
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCall">
|
|||
|
|
<summary>
|
|||
|
|
Applies an action to a list of meters in a separate thread
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCall.RunAction(System.Collections.Generic.List{Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter})">
|
|||
|
|
<summary>
|
|||
|
|
Starts a new task for a list of meters
|
|||
|
|
</summary>
|
|||
|
|
<param name="forMeters"></param>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCall.DoSingleAction(Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter)">
|
|||
|
|
<summary>
|
|||
|
|
Apply a single action to a specific meter
|
|||
|
|
</summary>
|
|||
|
|
<param name="meter"></param>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCallConnectMeter">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCallConnectMeter.DoSingleAction(Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter)">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCallInitCalibration">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCallInitCalibration.DoSingleAction(Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter)">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCallInitMeasurement">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCallInitMeasurement.DoSingleAction(Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter)">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCallLogin">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCallLogin.DoSingleAction(Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter)">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCallSetCalibrationFactor">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCallSetCalibrationFactor.DoSingleAction(Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter)">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCallStartCalibration">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCallStartCalibration.DoSingleAction(Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter)">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCallStartMeasurement">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCallStartMeasurement.DoSingleAction(Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter)">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCallStopCalibration">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCallStopCalibration.DoSingleAction(Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter)">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCallStopMeasurement">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.BatchActions.BatchCallStopMeasurement.DoSingleAction(Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter)">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.Consts.ErrorState">
|
|||
|
|
<summary>
|
|||
|
|
Common definition for Meter handling in production and on test benches
|
|||
|
|
</summary>
|
|||
|
|
<summary>
|
|||
|
|
represents any error state a meter can have
|
|||
|
|
if hash code is 0 everything is running
|
|||
|
|
is Flags, so watch out to check with hasFlag!
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.Consts.ErrorState.None">
|
|||
|
|
<summary>
|
|||
|
|
everything is good
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.Consts.ErrorState.InitFailed">
|
|||
|
|
<summary>
|
|||
|
|
problems on initialization
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.Consts.ErrorState.MeasurementFailed">
|
|||
|
|
<summary>
|
|||
|
|
problems on Measurement
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.Consts.ErrorState.ComErrorRequestPort">
|
|||
|
|
<summary>
|
|||
|
|
Problem on communication with meter
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.Consts.ErrorState.ComErrorLed">
|
|||
|
|
<summary>
|
|||
|
|
Problem on optical output on meter
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.Consts.ErrorState.ComErrorPulse">
|
|||
|
|
<summary>
|
|||
|
|
if pulse can not readout
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.Consts.ErrorState.ErrorQRef">
|
|||
|
|
<summary>
|
|||
|
|
no (or no good) reference flow available
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.Consts.ErrorState.CalibrationFailed">
|
|||
|
|
<summary>
|
|||
|
|
Calibration went wrong
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.Consts.ErrorState.CalibrationOutOfRange">
|
|||
|
|
<summary>
|
|||
|
|
calibration is out of range. Check documentation from meter to find limitation
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.Consts.ErrorState.FatalError">
|
|||
|
|
<summary>
|
|||
|
|
blue screen like error
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterBatch">
|
|||
|
|
<summary>
|
|||
|
|
Can hold various <see cref="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter"/>s and hold connection record to relieve the meter.
|
|||
|
|
Every contact with meter has to go over <see cref="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterBatch"/> even if you have just only one.
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterBatch.AddMeter(Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter)">
|
|||
|
|
<summary>
|
|||
|
|
holds all <see cref="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter"/>
|
|||
|
|
Add <see cref="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterBatch.AddMeter(Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter)"/> and delete with <see cref="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterBatch.RemoveMeter(Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter)"/>
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterBatch.RemoveMeter(Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter)">
|
|||
|
|
<summary>
|
|||
|
|
Remove Meter from batch and clear communication
|
|||
|
|
</summary>
|
|||
|
|
<param name="meterToRemove"> meter to be removed</param>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterBatch.GetMeter(System.Int32)">
|
|||
|
|
<summary>
|
|||
|
|
Get meter from slot number.
|
|||
|
|
</summary>
|
|||
|
|
<param name="slot"></param>
|
|||
|
|
<returns>null if slot has no genesis</returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterBatch.RemoveAllMeters">
|
|||
|
|
<summary>
|
|||
|
|
Remove all Meters and comports
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterBatch.GetCurrentMeter">
|
|||
|
|
<summary>
|
|||
|
|
|
|||
|
|
</summary>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterBatch.GetCurrentMeterSlots">
|
|||
|
|
<summary>
|
|||
|
|
Detect all meters
|
|||
|
|
</summary>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterBatch.MetersLogin">
|
|||
|
|
<summary>
|
|||
|
|
login to all meters
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterBatch.MetersInit">
|
|||
|
|
<summary>
|
|||
|
|
Initialize all meters
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterBatch.MetersInitCalibration">
|
|||
|
|
<summary>
|
|||
|
|
Initialize calibration for all meters
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterBatch.MetersInitMeasurement">
|
|||
|
|
<summary>
|
|||
|
|
Initialize measurement for all meters
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterBatch.MetersSaveCalculatedCalibration">
|
|||
|
|
<summary>
|
|||
|
|
Store new calculated calibration to all meters
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterBatch.MetersStartCalibration">
|
|||
|
|
<summary>
|
|||
|
|
Start calibration for all meters
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterBatch.MetersStartMeasurement">
|
|||
|
|
<summary>
|
|||
|
|
Start measurement for all meters
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterBatch.MetersStopCalibration">
|
|||
|
|
<summary>
|
|||
|
|
Stop calibration of all meters
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterBatch.MetersStopMeasurement">
|
|||
|
|
<summary>
|
|||
|
|
Stop measurements of all meters
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch">
|
|||
|
|
<summary>
|
|||
|
|
Can hold various <see cref="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter"/>s and hold connection record to relieve the meter.
|
|||
|
|
Every contact with meter has to go over <see cref="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch"/> even if you have only one.
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch.#ctor(System.String)">
|
|||
|
|
<summary>
|
|||
|
|
ctor
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="P:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch.ListOfMeters">
|
|||
|
|
<summary>
|
|||
|
|
Registered list of meters
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch.AddMeter(Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter)">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch.GetCurrentMeter">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch.GetCurrentMeterSlots">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch.RemoveMeter(Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter)">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch.MetersLogin">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch.MetersInit">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch.MetersInitCalibration">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch.MetersInitMeasurement">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch.MetersSaveCalculatedCalibration">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch.MetersStartCalibration">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch.MetersStartMeasurement">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch.MetersStopCalibration">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch.MetersStopMeasurement">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch.GetMeter(System.Int32)">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch.RemoveAllMeters">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.MeterBatch.Dispose">
|
|||
|
|
<inheritdoc />
|
|||
|
|
</member>
|
|||
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter">
|
|||
|
|
<inheritdoc />
|
|||
|
|
<summary>
|
|||
|
|
IMeter is the highest level interface between a meter with direct communication to a test bench.
|
|||
|
|
has general things like calibration, measurement and set up routines.
|
|||
|
|
no specific meter stuff in here!
|
|||
|
|
it is always disposable
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="E:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.OnProcessStatusChanged">
|
|||
|
|
<summary>
|
|||
|
|
occurs when ProcessState has changed
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="E:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.OnErrorStatusChanged">
|
|||
|
|
<summary>
|
|||
|
|
occurs when ErrorState has changed
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="E:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.OnInitCompleted">
|
|||
|
|
<summary>
|
|||
|
|
occurs when Init is completed
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="E:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.OnMeasurementInitCompleted">
|
|||
|
|
<summary>
|
|||
|
|
occurs when the initialization for Measurement is completed
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="E:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.OnMeasurementCompleted">
|
|||
|
|
<summary>
|
|||
|
|
occurs when the Measurement is completed
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="E:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.OnCalibInitCompleted">
|
|||
|
|
<summary>
|
|||
|
|
occurs when the initialization for calibration is completed
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="E:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.OnCalibCompleted">
|
|||
|
|
<summary>
|
|||
|
|
occurs when the calibration is completed
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="E:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.OnDisposeCompleted">
|
|||
|
|
<summary>
|
|||
|
|
occurs when meter gets disposed
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="P:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.SerialNumber">
|
|||
|
|
<summary>
|
|||
|
|
unique meter identification
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="P:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.ProcessStatus">
|
|||
|
|
<summary>
|
|||
|
|
read-only to see current Process state <see cref="T:Xylem.Common.Metrology.Measurements.Consts.ProcessState" />
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="P:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.ErrorStatus">
|
|||
|
|
<summary>
|
|||
|
|
read-only to see current Error state <see cref="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.Consts.ErrorState" />
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="P:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.Slot">
|
|||
|
|
<summary>
|
|||
|
|
the current slot in test-bench
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="P:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.IntermediateUpdateTimeS">
|
|||
|
|
<summary>
|
|||
|
|
Setup of intermediate update time for measurement updates and overflow detections,
|
|||
|
|
has to be calculated depending on flow-rate and nominal diameter (DN)
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.ConnectMeter">
|
|||
|
|
<summary>
|
|||
|
|
Open Com ports, try some communication, login
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.SetupFromConfigFile(System.Int32,System.Boolean)">
|
|||
|
|
<summary>
|
|||
|
|
Setup up meter from config file. just a workaround for vb6 calls. please do not use if your working with .net
|
|||
|
|
</summary>
|
|||
|
|
<param name="slot">Slot Number for Test bench</param>
|
|||
|
|
<param name="ignoreCorruptedData">don´t send CRC error or telegrams with error flag to caller</param>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.Logout">
|
|||
|
|
<summary>
|
|||
|
|
Logout from device
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.Login">
|
|||
|
|
<summary>
|
|||
|
|
Start Login with password service
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.Login(System.String)">
|
|||
|
|
<summary>
|
|||
|
|
Start Login with out password service and a fixed password
|
|||
|
|
</summary>
|
|||
|
|
<param name="password">password for login</param>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.InitMeasurement">
|
|||
|
|
<summary>
|
|||
|
|
set up measurement parameter and set meter into test-mode
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.StartMeasurement">
|
|||
|
|
<summary>
|
|||
|
|
Starting a Measurement
|
|||
|
|
Meter must be initialized <see cref="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.InitMeasurement" />
|
|||
|
|
Start to receive record from meter and decode this record into <code>MeasurementRecord</code>
|
|||
|
|
<see cref="T:Xylem.Common.Metrology.Measurements.IMeasurementRecord" />
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.StopMeasurement">
|
|||
|
|
<summary>
|
|||
|
|
Meter must have a active measurement <see cref="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.StartMeasurement" />
|
|||
|
|
Stop receive record from meter and decode record
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.GetMainMeasurementResult(System.Nullable{System.Double},System.Nullable{System.Double},System.Boolean)">
|
|||
|
|
<remarks date="2018JAN09" author="drabesch">
|
|||
|
|
- simplify the measurement results handling
|
|||
|
|
- getting the main measurement of the entire device (combination of all paths)
|
|||
|
|
- add MeasurementResult
|
|||
|
|
- remove all other methods
|
|||
|
|
</remarks>
|
|||
|
|
<summary>
|
|||
|
|
After a completed measurement , you can grab <see cref="T:Xylem.Common.Metrology.Measurements.MeasurementResults"/>
|
|||
|
|
</summary>
|
|||
|
|
<returns>Calculated results</returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.GetAllMeasurementResults(System.Nullable{System.Double},System.Nullable{System.Double},System.Boolean,System.Nullable{System.Int32})">
|
|||
|
|
<summary>
|
|||
|
|
The first measurement is ALWAYS a FlowTestRecord.
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.GetMeasurementState(System.Nullable{System.Int32})">
|
|||
|
|
<summary>
|
|||
|
|
get current state of the running measurement
|
|||
|
|
</summary>
|
|||
|
|
<param name="onlyChannelNr">leave empty for an aggregate state for all measurements or pass the channel number to check</param>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.InitCalibration">
|
|||
|
|
<summary>
|
|||
|
|
set up calibration parameter (calibration factor to default) and set meter into calibration mode
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.StartCalibration">
|
|||
|
|
<summary>
|
|||
|
|
Starting a Calibration
|
|||
|
|
Meter must be initialized <see cref="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.InitCalibration" />
|
|||
|
|
Start to receive record from meter, decode and store this record
|
|||
|
|
no <see cref="T:Xylem.Common.Metrology.Measurements.IMeasurementRecord" /> available
|
|||
|
|
To finish calibration process run <see cref="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.StopCalibration" />
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.StopCalibration">
|
|||
|
|
<summary>
|
|||
|
|
Meter must have a active for calibration <see />
|
|||
|
|
Stop receive record from meter, decode and store record
|
|||
|
|
record will not calculate or store
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.GetCalibrationState">
|
|||
|
|
<summary>
|
|||
|
|
Get current state of the running calibration
|
|||
|
|
</summary>
|
|||
|
|
<returns></returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.BuildAndCheckCalibFactorsAllChannels(System.Double,System.Nullable{System.Double},System.Double,System.Double)">
|
|||
|
|
<summary>
|
|||
|
|
Calculate calibration factor for static and flying start / stop
|
|||
|
|
Results kept internal and not being saved to meter.
|
|||
|
|
if you want to store them on meter use <see cref="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.SetCalibFactorsAllChannels(System.Boolean)" />
|
|||
|
|
</summary>
|
|||
|
|
<param name="refVolumeCm">the reference volume is essential for calculation of calibration factor</param>
|
|||
|
|
<param name="refTimeS">the reference time is needed for flying start/stop</param>
|
|||
|
|
<param name="reqDeviationPercent">the required deviation to set the scale apart from 0</param>
|
|||
|
|
<param name="maxCalibFactorTolerancePercent"> override the default max calibration factor tolerance</param>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.SetCalibFactorsAllChannels(System.Boolean)">
|
|||
|
|
<summary>
|
|||
|
|
Save calculated calibration on meter if no calibration results available an exception occurred
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.SetLcdText(System.Boolean,System.Byte[])">
|
|||
|
|
<summary>
|
|||
|
|
To control the LCD from meter for status information etc.
|
|||
|
|
</summary>
|
|||
|
|
<param name="release">if set to true the meter will show his normal screen, if set to false the next parameter will shown in display</param>
|
|||
|
|
<param name="textInHex">test shown in LCD in byte array as hex value (0x33,0xFF shows 33FF on screen)</param>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.SetProcessState(Xylem.Common.Hardware.WaterMeter.WaterMeterCore.Consts.DisplayCodes,System.Boolean)">
|
|||
|
|
<summary>
|
|||
|
|
Sets Display text and update production database
|
|||
|
|
</summary>
|
|||
|
|
<param name="newState">New ProductionState</param>
|
|||
|
|
<param name="webRequest">web logging required per default true, for offline usage set to false</param>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.GetLastProcessState">
|
|||
|
|
<summary>
|
|||
|
|
Get last Process State
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.WriteLog(System.String)">
|
|||
|
|
<summary>
|
|||
|
|
Add external text to internal log file handling
|
|||
|
|
</summary>
|
|||
|
|
<param name="text">text to log</param>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.LogRawData(System.Boolean)">
|
|||
|
|
<summary>
|
|||
|
|
Enable/Disable Raw record Logging
|
|||
|
|
</summary>
|
|||
|
|
<param name="on">True = Write Raw record into log/ false = Stop write raw record into log </param>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.CheckStateAfterMeasurement">
|
|||
|
|
<summary>
|
|||
|
|
Check if the meter has any errors that can occur on a measurement
|
|||
|
|
the error reason has find out in the log files
|
|||
|
|
</summary>
|
|||
|
|
<returns>false = everything is good, detect at least one error</returns>
|
|||
|
|
</member>
|
|||
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter.DisposeMeter">
|
|||
|
|
<summary>
|
|||
|
|
Clear all object set up on runtime
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterEvents">
|
|||
|
|
<summary>
|
|||
|
|
Interface for <see cref="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter"/> Events
|
|||
|
|
you can use <see cref="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterEvents"/> without events (so with out <see cref="T:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeter"/>)
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="E:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterEvents.OnProcessStatusChanged">
|
|||
|
|
<summary>
|
|||
|
|
occurs when ProcessState has changed
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="E:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterEvents.OnErrorStatusChanged">
|
|||
|
|
<summary>
|
|||
|
|
occurs when ErrorState has changed
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="E:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterEvents.OnInitCompleted">
|
|||
|
|
<summary>
|
|||
|
|
occurs when Init is completed
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="E:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterEvents.OnMeasurementInitCompleted">
|
|||
|
|
<summary>
|
|||
|
|
occurs when the initializations for Measurement is completed
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="E:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterEvents.OnMeasurementCompleted">
|
|||
|
|
<summary>
|
|||
|
|
occurs when the Measurement is completed
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="E:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterEvents.OnCalibInitCompleted">
|
|||
|
|
<summary>
|
|||
|
|
occurs when the initializations for calibration is completed
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
<member name="E:Xylem.Common.Hardware.WaterMeter.WaterMeterCore.IMeterEvents.OnCalibCompleted">
|
|||
|
|
<summary>
|
|||
|
|
occurs when the calibration is completed
|
|||
|
|
</summary>
|
|||
|
|
</member>
|
|||
|
|
</members>
|
|||
|
|
</doc>
|