145 lines
8.2 KiB
XML
145 lines
8.2 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingProtocol">
|
|
<inheritdoc />
|
|
<summary>
|
|
Layer between <see cref="T:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingDecoder" /> CRC16CCITT handler and Events
|
|
block trashy telegrams
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingProtocol._streamingDecode">
|
|
<summary>
|
|
Decode data and hold results
|
|
</summary>
|
|
</member>
|
|
<member name="E:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingProtocol.OnRecordIsDecoded">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingProtocol.DecodeRecord(Xylem.Common.Hardware.Interfaces.Ports.PortCore.EventArguments.IPortDataEventArgs)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingProtocol.#ctor(System.String,System.Boolean)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingDecoder">
|
|
<summary>
|
|
Data fields and definitions for GENESIS streaming protocol
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingDecoder._bendDetectionDefault">
|
|
<summary>
|
|
Default data for bend detection tests of Genesis
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingDecoder._dataDefault">
|
|
<summary>
|
|
Default data for flow tests of Genesis
|
|
</summary>
|
|
</member>
|
|
<member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingDecoder._rawDataDefault">
|
|
<summary>
|
|
Default data for calibration of Genesis
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingDecoder.#ctor(System.Boolean)">
|
|
<summary>
|
|
Constructor initializes all decoded members with default values
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingDecoder.DataCalib">
|
|
<summary>
|
|
Calibration data
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingDecoder.DataFlowTest">
|
|
<summary>
|
|
Flow test data
|
|
</summary>
|
|
</member>
|
|
<member name="P:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingDecoder.DataBendDetectTest">
|
|
<summary>
|
|
Bend detection test data
|
|
</summary>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingDecoder.DecodeMsg(System.String)">
|
|
<summary>
|
|
Decoding the raw message
|
|
</summary>
|
|
<param name="rawMsg">message received as one line delimited with LF</param>
|
|
<returns>true if decoding was successful and data has been validated</returns>
|
|
<remarks date="2023-Mar-09" author="T.Wiedebusch">
|
|
- Modified using common CRC check before branching to the protocol specific decoder.
|
|
</remarks>
|
|
<remarks date="2023-Dec-06" author="T.Wiedebusch">
|
|
- Introduced protocol 'm' for bending detection.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingDecoder.DecodeProtocolM(Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.BendDetectionRecord@,System.Collections.Generic.IList{System.String})">
|
|
<summary>
|
|
Extracting message from string fields for protocol 'm'
|
|
</summary>
|
|
<param name="dataBendTestRec">reference to bend detection test record</param>
|
|
<param name="fields">Separated fields containing the measurement as string</param>
|
|
<returns></returns>
|
|
<remarks date="2023-Mar-09" author="T.Wiedebusch">
|
|
- Modified using common CRC check in advance.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingDecoder.DecodeProtocolF(Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.FlowTestRecord@,System.Collections.Generic.IList{System.String})">
|
|
<summary>
|
|
Extracting message from string fields for protocol 'f'
|
|
</summary>
|
|
<param name="dataFlowTestRec">reference to flow test record</param>
|
|
<param name="fields">Separated fields containing the measurement as string</param>
|
|
<returns></returns>
|
|
<remarks date="2023-Mar-09" author="T.Wiedebusch">
|
|
- Modified using common CRC check in advance.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingDecoder.DecodeProtocolG(Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord@,System.Collections.Generic.IList{System.String})">
|
|
<summary>
|
|
Extracting message from string fields to individual raw channel for protocol 'g'
|
|
</summary>
|
|
<param name="dataProtGRec">Reference to result structure for raw data for one channel</param>
|
|
<param name="fields">Separated fields containing the measurement as string</param>
|
|
<returns>true if protocol is valid</returns>
|
|
<remarks date="2018-Mar-22" author="T.Wiedebusch">
|
|
- Usage of VolumeFactorRawToQm and calculation of AccuDutOverflowVolumeCm
|
|
</remarks>
|
|
<remarks date="2023-Mar-09" author="T.Wiedebusch">
|
|
- Modified using common CRC check in advance.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingDecoder.DecodeProtocolH(Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord@,System.Collections.Generic.IList{System.String})">
|
|
<summary>
|
|
Extracting message from string fields to individual raw channel for protocol 'g'
|
|
</summary>
|
|
<param name="dataProtHRec">Reference to result structure for raw data for one channel</param>
|
|
<param name="fields">Separated fields containing the measurement as string</param>
|
|
<returns>true if protocol is valid</returns>
|
|
<remarks date="2018-Mar-22" author="T.Wiedebusch">
|
|
- Usage of VolumeFactorRawToQm and calculation of AccuDutOverflowVolumeCm
|
|
</remarks>
|
|
<remarks date="2023-Mar-09" author="T.Wiedebusch">
|
|
- Modified using common CRC check in advance.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingDecoder.ProtFsubString">
|
|
field position in protocol 'f'
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingDecoder.ProtMsubString">
|
|
field position in protocol 'm'
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingDecoder.ProtGsubString">
|
|
field position in protocol 'g'
|
|
</member>
|
|
<member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.Protocols.StreamingProtocol.StreamingDecoder.ProtHsubString">
|
|
field position in protocol 'h'
|
|
</member>
|
|
</members>
|
|
</doc>
|