c3bc096f by Mike Mathews

Added optional floor specifier, and refined the element documentation with clear…

…er and more details information.
1 parent 272d48d0
...@@ -591,13 +591,17 @@ ...@@ -591,13 +591,17 @@
591 </elem> 591 </elem>
592 592
593 <elem name="source" type="string" multiplicity="1"> 593 <elem name="source" type="string" multiplicity="1">
594 <comment>Estimate source identifier. If not defined set to "".</comment> 594 <comment>Estimate calculation source identifier. In multi-function engines like HPE, calculations can be handled by various calculation functions. This source identifier
595 provides an analytical characterization that enbles a deeper understanding of how the data is processed. Identifiers can include terms like 'hybrid', 'agnss', 'celldb', 'ecid',
596 tdoa, rf-base1, rf-base2, slame, etc. Terms are not constant and may be substantially different across systems using this XID struct. </comment>
595 </elem> 597 </elem>
596 <elem name="obstype" type="ObservationType" multiplicity="1"> 598 <elem name="obstype" type="ObservationType" multiplicity="1">
597 <comment>The last observation type used to create the estimate.</comment> 599 <comment>The last observation type used to create the estimate. In multi-type observables, multiple estimates will be generated with the last estimate usually indicating the last estimate use.
600 If estimated simultaneously, then the obstype will be the dominant observations (one with the most obversations and/or least uncertainty). If there is no dominance, then the observation
601 type is 'undefined'</comment>
598 </elem> 602 </elem>
599 <elem name="tic" type="uint32"> 603 <elem name="tic" type="uint32">
600 <comment>Tic count of the estimate. Set to zero if not known.</comment> 604 <comment>Tic count of the estimate. For single transaction sessions, the tic count is always 0. For multi-transaction sessions, the tic-count will be monotonic increasing.</comment>
601 </elem> 605 </elem>
602 <elem name="epoch" type="datetime" multiplicity="1"> 606 <elem name="epoch" type="datetime" multiplicity="1">
603 <comment>Epoch defines the point in time for which the estimate applies.</comment> 607 <comment>Epoch defines the point in time for which the estimate applies.</comment>
...@@ -610,14 +614,20 @@ ...@@ -610,14 +614,20 @@
610 </comment> 614 </comment>
611 </elem> 615 </elem>
612 <elem name="confidence" type="float32" multiplicity="1"> 616 <elem name="confidence" type="float32" multiplicity="1">
613 <comment>The estimate confidence. Valid range is 0.0 to 1.0</comment> 617 <comment>The estimate confidence. This is the confidence level associated with the uncertainties specified within the shape (e.g. Spheroid). Valid range is 0.0 to 1.0.
618 Typical values are 0.5 (50% CEP), 0.6827 (1 Std. Dev.), 0.9545 (2 Std. Dev.), 0.9973 (3 Std. Dev.). For example, a confidence of 0.6827 and Spheroid horizontal uncertainty of 10 meters
619 means the about 68% of the time the estimate will be within 10 meters horizontally to the true position.</comment>
614 </elem> 620 </elem>
615 <elem name="shape" type="Shape" multiplicity="1" polymorphic="true"> 621 <elem name="shape" type="Shape" multiplicity="1" polymorphic="true">
616 <comment> 622 <comment>
617 The estimate shape result. The particular shape is determined by the 623 The estimate shape result. In HPE, the particular shape is determined by the preferred shapes specified in the BeginCalculation. For other systems, the shape
618 preferred shapes specified in the BeginCalculation. 624 provided here is based on an external consideration. Typically only the common spatial types are used: Circle, Ellipse, Spheroid, and Ellispoid shape types.
619 </comment> 625 </comment>
620 </elem> 626 </elem>
627 <elem name="floor" type="Tensor.int16" multiplicity="0..1">
628 Optional floor specifier if availble. Floor values are specified by local venue mapping information. As general guideline, 0 denotes the ground-level floor.
629 Negative values denote floors under ground.
630 </elem>
621 </struct> 631 </struct>
622 632
623 <!-- eventually may be able to support variable sized elements 633 <!-- eventually may be able to support variable sized elements
......
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!