c30886f5 by Mike Mathews

Updated documentation on encoding. Added optional field constellationXmf field …

…in GnssDataOutput.  This is to fix the encoding issue ILP-220.
1 parent 90fdd590
...@@ -65,9 +65,9 @@ ...@@ -65,9 +65,9 @@
65 65
66 <elem name="encoding" multiplicity="0..1" type="EncodingFormat" default="0"> 66 <elem name="encoding" multiplicity="0..1" type="EncodingFormat" default="0">
67 <comment> 67 <comment>
68 ConstellationData encoding format for the response. This field is carried into 68 ConstellationData encoding format for the response. The default encoding is natural, which will
69 GnssDataOutput.encoding and GnssDataOutput.conData will be encoded 69 result in constellation data being returned in the "constellationData" field specified in the GnssDataOutput structure. If the
70 in this format. If not specified the "native" format of the protocol is used. 70 encoding value is 2 (XMF) or greater than 255 (custom encoding), then the data is returned in the "constellationXmf" field.
71 </comment> 71 </comment>
72 </elem> 72 </elem>
73 73
...@@ -97,17 +97,24 @@ ...@@ -97,17 +97,24 @@
97 97
98 <elem name="encoding" multiplicity="0..1" type="EncodingFormat" default="0"> 98 <elem name="encoding" multiplicity="0..1" type="EncodingFormat" default="0">
99 <comment> 99 <comment>
100 Constellation Data encoding format. Data can be provided in a different encoding format 100 Constellation Data encoding format. If encoding is default (natural), constellation data will be returned to caller in the constellationData field.
101 than the native protocol format. This is carried over from input. 101 If a value of 2(xmf) or greater than 255, constellation data will be returned in the constellation XMF field.
102 If not present, the data is in the native protocol format (e.g. XMF, JSON).
103 </comment> 102 </comment>
104 </elem> 103 </elem>
105 104
106 <elem name="constellationData" multiplicity="0..*" type ="HPE.Gnss.ConstellationData" encoding="encoding"> 105 <elem name="constellationData" multiplicity="0..*" type ="HPE.Gnss.ConstellationData" >
107 <comment> 106 <comment>
108 The list of ConstellationData encoded in the format specified by encoding. 107 The list of ConstellationData encoded in the format specified by encoding.
109 </comment> 108 </comment>
110 </elem> 109 </elem>
110
111 <elem name="constellationXmf" multiplicity="0..*" type ="xmf" >
112 <comment>
113 XMF formated constellation with the specified encoding format. If encoding is 2 (XMF) or greater than 255, then constellation data will be returned
114 in as XMF or encoded XMF.
115 </comment>
116 </elem>
117
111 </struct> 118 </struct>
112 119
113 120
......
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!