An AQTS field data plugin to import cross section survey measurements.
- Download the latest release of the plugin here
- Install it using the FieldVisitPluginTool
The supported CSV file has the following text rules:
- UTF-8 encoding is assumed. The UTF-8 byte-order-mark of (
0xEF, 0xBB, 0xBF) at the start of the file is completely optional. - Lines starting with a
#as the first non-whitespace character are ignored as comment-lines. - Completely blank lines are ignored.
- The header line (line 14 in the example file below) can be repeated any number of times, and will always be ignored. The field names in the header line must match the English field names listed in the table below.
- Leading/trailing whitespace is allowed between fields.
- Double-quotes are only required if a field value contains a comma, or if the value must have leading/trailing whitespace.
- Multi-line text values are not supported. (ie. the Comment field must be a single line)
The first non-comment, non-blank line must be AQUARIUS Cross-Section CSV v1.0. Leading/trailing whitespace is ignored.
If the first line does not match the expected pattern, the plugin will not attempt to parse the file.
Lines that follow the <FieldName> : <FieldValue> pattern will not be parsed as CSV data rows, but will set some field values which apply to the entire cross-section measurement.
- Leading/trailing whitespace is ignored
- The whitespace separating
<FieldName>, the colon:, and<FieldValue>is ignored. - The
<FieldName>s are case-insensitive.
| Field name | Data type | Required? | Description |
|---|---|---|---|
| Location | string | Y | The location identifier for this measurement. |
| StartDate | Timestamp | Y | The starting time of the survey. |
| EndDate | Timestamp | Y | The ending time of the survey. |
| Party | string | N | The party performing the survey. |
| Channel | string | N | The name of the channel at the location. If omitted, a value of Main will be used. |
| RelativeLocation | string | N | A description of where the measurement was taken. If omitted, a value of At the control will be used. |
| Stage | numeric | Y | The stage height at the time of the survey. |
| Unit | string | Y | The stage height units. |
| StartBank | string | Y | The starting bank of the survey, The value must start with Left, LEW, Right, or REW. |
| Comment | string | N | An optional comment. |
A header line does not need to appear at all in the CSV file. But if it does exist, it must exactly match line 14 in the example file below. The header line must be the 3 column names, listed in the order below, separated by commas. Whitespace between column names is ignored.
| ColumnName | Data type | Required? | Description |
|---|---|---|---|
| Distance | numeric | Y | The distance from the start bank. |
| Elevation | numeric | Y | The elevation relative to the stage. Positive values are deeper (below the water line). Negative values are above the water line. |
| Comment | string | N | An optional comment |
Timestamps are specified in ISO 8601 format. Specifically the "O" (roundtrip) format for .NET DateTimeOffset values is used.
yyyy-MM-ddTHH:mm:ss.fffffffzzz
- The
Tcharacter must separate the date and time portions. - All seven fractional seconds digits are optional. This 100 nanosecond precision is the full resolution supported by AQUARIUS Time-Series.
- The time-zone (
zzz) portion can either be an explicit offset in hours/minutes (+04:00or-00:30) or it can be the UTC indicator of the letterZ. - These constraints ensure that the timestamps contain no ambiguity.
See https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings#Roundtrip for more details.
AQUARIUS Cross-Section CSV v1.0
Location: Server.Plugins.FieldVisit.CrossSection.Tests.CompleteCrossSection
StartDate: 2001-05-08T14:32:15+07:00
EndDate: 2001-05-08T17:12:45+07:00
Party: Cross-Section Party
Channel: Right overflow
RelativeLocation: At the Gage
Stage: 12.2
Unit: ft
StartBank: Left bank
Comment: Cross-section survey comments
Distance, Elevation, Comment
0, 7.467,
19.1, 6.909, "some comment"
44.8, 6.3, "yet, another, comment"
70.1, 5.356, another comment
82.4, 5.287,
- Requires Visual Studio 2017 (Community Edition is fine)
- .NET 4.7 runtime
- Load the
src\CrossSectionPlugin.slnfile in Visual Studio and build theReleaseconfiguration. - The
src\CrossSectionPlugin\deploy\Release\CrossSectionPlugin.pluginfile can then be installed on your AQTS app server.
Use the included PluginTester.exe tool from the Aquarius.FieldDataFramework package to test your plugin logic on the sample files.
- Open the EhsnPlugin project's Properties page
- Select the Debug tab
- Select Start external program: as the start action and browse to
"src\packages\Aquarius.FieldDataFramework.17.4.1\tools\PluginTester.exe - Enter the Command line arguments: to launch your plugin
/Plugin=CrossSectionPlugin.dll /Json=AppendedResults.json /Data=..\..\..\..\data\CrossSection.csv
The /Plugin= argument can be the filename of your plugin assembly, without any folder. The default working directory for a start action is the bin folder containing your plugin.
- Set a breakpoint in the plugin's
ParseFile()methods. - Select your plugin project in Solution Explorer and select "Debug | Start new instance"
- Now you're debugging your plugin!
See the PluginTester documentation for more details.
Use the FieldDataPluginTool to install the plugin on your AQTS app server.