Merge pull request #47 from DougSchmidt-AI/feature/PF-1218-ConfigurableIsoUncertaintyScalar

PF-1218 - Added configurable ISO uncertainty scalar setting

Author: Doug Schmidt

README.md

@@ -8,17 +8,26 @@ An AQTS field data plugin supporting FlowTracker2 measurement files, for AQTS 20
 
 - Use of this plugin implies agreement with the [license terms of this repository](./LICENSE.txt) and with license terms for software components provided by [SonTek/YSI](src/External/SonTek.StandaloneDataParser.License.md).
 - Download the latest release of the plugin [here](../../releases/latest)
-- Install it using the [FieldVisitPluginTool](https://github.com/AquaticInformatics/aquarius-field-data-framework/tree/master/src/FieldDataPluginTool)
+- Install it using the [SystemConfig page](https://github.com/AquaticInformatics/aquarius-field-data-framework#need-to-install-a-plugin-on-your-aqts-app-server)
 
 ## Plugin Compatibility Matrix
 
 It is recommended that you use the most recent version of the plugin which matches your AQTS server version.
 
 | AQTS Version | Latest compatible plugin Version |
 | --- | --- |
-| AQTS 2019.2+ | [v19.2.13](https://github.com/AquaticInformatics/flowtracker2-field-data-plugin/releases/download/v19.2.13/FlowTracker2Plugin.plugin) - Adds Party and Primary Meter to channel measurement<br/>v19.2.12 - Adds incrementing vertical numbers |
+| AQTS 2020.2+ | [v20.2.0](https://github.com/AquaticInformatics/flowtracker2-field-data-plugin/releases/download/v19.2.13/FlowTracker2Plugin.plugin) - Adds configurable ISO Uncertainty Scalar |
+| AQTS 2019.2 - 2020.1 | [v19.2.13](https://github.com/AquaticInformatics/flowtracker2-field-data-plugin/releases/download/v19.2.13/FlowTracker2Plugin.plugin) - Adds Party and Primary Meter to channel measurement<br/>v19.2.12 - Adds incrementing vertical numbers |
 | 2017.4 - 2019.1 | [v17.4.44](https://github.com/AquaticInformatics/flowtracker2-field-data-plugin/releases/download/v17.4.44/FlowTracker2Plugin.plugin) |
 
+## Configuring the plugin
+
+Starting with version 20.2.0, there are some configurable plugin settings which can be set in the Settings tab of the System Config Page.
+
+| Group | Key | Value | Description |
+|---|---|---|---|---|
+| `FieldDataPluginConfig-FlowTracker2Plugin` | `IsoUncertaintyScalar` | `1.0` | This value will be used to scale the FlowTracker2 ISO uncertainty measurement, which defaults to a single standard devation (68% confidence interval).<br/><br/>A value of `1.96` will scale the uncertainty into a two-standard-deviation value (95% confidence interval).<br/><br/>Defaults to `1.0` if the value is missing or is not a valid number. |
+
 ## Requirements for building the plugin from source
 
 - Requires Visual Studio 2017 (Community Edition is fine)

src/Flowtracker2Plugin/DataFileParser.cs

@@ -225,7 +225,15 @@ private DischargeActivity CreateDischargeActivity(FieldVisitInfo visit)
                 new DateTimeInterval(visit.StartDate, visit.EndDate), UnitConverter.ConvertDischarge(DataFile.Calculations.Discharge));
             dischargeActivity.Comments = DataFile.Properties.Comment;
             dischargeActivity.ActiveUncertaintyType = UncertaintyType.Quantitative;
-            dischargeActivity.QuantitativeUncertainty = DataFile.Calculations.UncertaintyIso.Overall * 100;
+
+            _resultsAppender.GetPluginConfigurations().TryGetValue("IsoUncertaintyScalar", out var scalarText);
+
+            if (!double.TryParse(scalarText, out var scalar))
+            {
+                scalar = 1.0;
+            }
+
+            dischargeActivity.QuantitativeUncertainty = scalar * DataFile.Calculations.UncertaintyIso.Overall * 100;
 
             return dischargeActivity;
         }

src/Flowtracker2Plugin/FlowTracker2Plugin.csproj

@@ -32,8 +32,8 @@
     <WarningLevel>4</WarningLevel>
   </PropertyGroup>
   <ItemGroup>
-    <Reference Include="FieldDataPluginFramework, Version=2.3.0.0, Culture=neutral, processorArchitecture=AMD64">
-      <HintPath>..\packages\Aquarius.FieldDataFramework.19.2.2\lib\net472\FieldDataPluginFramework.dll</HintPath>
+    <Reference Include="FieldDataPluginFramework, Version=2.9.0.0, Culture=neutral, processorArchitecture=AMD64">
+      <HintPath>..\packages\Aquarius.FieldDataFramework.20.2.5\lib\net472\FieldDataPluginFramework.dll</HintPath>
     </Reference>
     <Reference Include="ICSharpCode.SharpZipLib, Version=0.85.5.452, Culture=neutral, PublicKeyToken=1b03e6acf1164f73, processorArchitecture=MSIL">
       <SpecificVersion>False</SpecificVersion>
@@ -69,7 +69,7 @@
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <PropertyGroup>
-    <PostBuildEvent>$(SolutionDir)packages\Aquarius.FieldDataFramework.19.2.2\tools\PluginPackager.exe $(TargetPath) /OutputPath=$(ProjectDir)deploy\$(Configuration)\$(TargetName).plugin
-$(SolutionDir)packages\Aquarius.FieldDataFramework.19.2.2\tools\PluginTester.exe /Plugin=$(TargetPath) /Data=$(SolutionDir)..\data\DemoData.ft</PostBuildEvent>
+    <PostBuildEvent>$(SolutionDir)packages\Aquarius.FieldDataFramework.20.2.5\tools\PluginPackager.exe $(TargetPath) /OutputPath=$(ProjectDir)deploy\$(Configuration)\$(TargetName).plugin
+$(SolutionDir)packages\Aquarius.FieldDataFramework.20.2.5\tools\PluginTester.exe /Plugin=$(TargetPath) /Data=$(SolutionDir)..\data\DemoData.ft</PostBuildEvent>
   </PropertyGroup>
 </Project>

src/Flowtracker2Plugin/packages.config

@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="Aquarius.FieldDataFramework" version="19.2.2" targetFramework="net472" />
+  <package id="Aquarius.FieldDataFramework" version="20.2.5" targetFramework="net472" />
 </packages>