tbf/packages/Common/Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages</name>
    </assembly>
    <members>
        <member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.BaseDataEventArgs">
            <inheritdoc />
            <summary>
                abstract for set structure for BaseDataEventArgs
            </summary>
        </member>
        <member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.BaseDataEventArgs.GetData">
            <summary>
                'Base' get event record form real child.
            </summary>
            <returns></returns>
        </member>
        <member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.BaseDataEventArgs.GetEventData">
            <summary>
                get real Event record
            </summary>
            <returns></returns>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.BaseDataEventArgs.RawData">
            <summary>
            Holds the record before decoding, for logging 
            </summary>
        </member>
        <member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.CalibDataEventArgs">
            <inheritdoc />
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.CalibDataEventArgs.CalibChl">
            <summary>
            Stream record for calibration on channel
            </summary>
        </member>
        <member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.CalibDataEventArgs.GetEventData">
            <inheritdoc />
        </member>
        <member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.FlowDataEventArgs">
            <inheritdoc />
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.FlowDataEventArgs.NewData">
            <summary>
            new record from Stream
            </summary>
        </member>
        <member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.FlowDataEventArgs.GetEventData">
            <inheritdoc />
        </member>
        <member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.RegisterUpdatedEventArgs">
            <inheritdoc />
        </member>
        <member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.RegisterUpdatedEventArgs.#ctor(Xylem.Common.Hardware.WaterMeter.Genesis.Registers.RegisterDefinition,System.Byte[])">
            <inheritdoc />
            <summary>
            Ctor with base record
            </summary>
            <param name="register">base record <see cref="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.RegisterUpdatedEventArgs.Register" /></param>
            <param name="value">base record <see cref="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.RegisterUpdatedEventArgs.Value" /></param>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.RegisterUpdatedEventArgs.Register">
            <summary>
            Register witch has updated
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.RegisterUpdatedEventArgs.Value">
            <summary>
            New Value in Register
            </summary>
        </member>
        <member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.RequestResponseDataEventArgs">
            <inheritdoc />
            <summary>
                EventArgs for Request Responses
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.RequestResponseDataEventArgs.RequestResponseData">
            <summary>
            Request response from meter
            </summary>
        </member>
        <member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.EventArguments.RequestResponseDataEventArgs.GetEventData">
            <inheritdoc />
        </member>
        <member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord">
            <inheritdoc />
            <summary>
                hold streaming record for protocol H (contains calibration record)
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.Validation">
            <summary>
                record validation
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.TotalTimeOfFlightS">
            <summary>
                total time of flight in seconds
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.DeltaTimeOfFlightS">
            <summary>
                delta time of flight in seconds
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.RAWTotalTimeOfFlight">
            <summary>
                total time of flight in cordonel units
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.RAWDeltaTimeOfFlight">
            <summary>
                delta time of flight in cordonel units
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.VolumeScaleRawPerMl">
            <summary>
                volume scale (default: 1024) means
                1024digits = 1ml
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.VolumeFactorRawToQm">
            <summary>
                volume factor to convert raw to m³
                uses 1E-6 (ml to m³) / VolumeScaleRawPerMl
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.DeltaVolumeRaw">
            <summary>
                raw volume between two samples
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.DeltaVolumeQm">
            <summary>
                calculated out of dRawVolume * VolumeFactorRawToQm .
                in cubic meters
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.AccuVolumeRaw">
            <summary>
                accumulated raw volume 
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.SampleIntervalS">
            <summary>
                sample interval between two samples in seconds
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.AmplitudeUpV">
            <summary>
                high threshold amplitude in V
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.AmplitudeDownV">
            <summary>
                low threshold amplitude in V
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.PulseWidthRatioUp">
            <summary>
                high ratio for pulse width
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.PulseWidthRatioDown">
            <summary>
                low ratio for pulse width
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.TemperatureRaw">
            <summary>
                raw temperature
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.TemperaturePowFactor">
            <summary>
                temperature scale
            </summary>
        </member>
        <member name="F:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.TemperatureDegC">
            <summary>
                calculated temperature in degree C
            </summary>
        </member>
        <member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.CalibrationRecord.ToString">
            <summary>
                Get result as string
            </summary>
            <returns></returns>
        </member>
        <member name="T:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.FlowTestRecord">
            <inheritdoc />
            <summary>
                struct to hold Led record for protocol F (contains measurement record)
            </summary>
        </member>
        <member name="M:Xylem.Common.Hardware.WaterMeter.Genesis.DataPackages.MeasurementRecords.FlowTestRecord.ToString">
            <summary>
                Get result as string
            </summary>
            <returns></returns>
        </member>
    </members>
</doc>