SuperMap.Analyst.Navigation.xml 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>SuperMap.Analyst.Navigation</name>
  5. </assembly>
  6. <members>
  7. <member name="T:SuperMap.Analyst.Navigation.CompilerParameter">
  8. <summary>
  9. Provides the necessary parameter information for road network data compiling, including the datasource, name, output path, result data package type and so on.
  10. </summary>
  11. </member>
  12. <member name="M:SuperMap.Analyst.Navigation.CompilerParameter.#ctor">
  13. <summary>
  14. Constructs a new road network data compiling parameter object.
  15. </summary>
  16. </member>
  17. <member name="M:SuperMap.Analyst.Navigation.CompilerParameter.#ctor(SuperMap.Analyst.Navigation.CompilerParameter)">
  18. <summary>
  19. Builds a same road network data compiling object as the specified object.
  20. </summary>
  21. <param name="parameter">The specified road data network compiling parameter object.</param>
  22. </member>
  23. <member name="P:SuperMap.Analyst.Navigation.CompilerParameter.Datasource">
  24. <summary>
  25. Gets or sets the datasource of input road network data.
  26. </summary>
  27. <value>The default value is null.</value>
  28. </member>
  29. <member name="P:SuperMap.Analyst.Navigation.CompilerParameter.NameRoadLine">
  30. <summary>
  31. Gets or sets the name of road network basic line dataset.
  32. Take 4D navigation electronic maps data exchange format as an example, corresponding to R table.
  33. </summary>
  34. <value>The default value is String.Empty .</value>
  35. </member>
  36. <member name="P:SuperMap.Analyst.Navigation.CompilerParameter.NameRoadPoint">
  37. <summary>
  38. Gets or sets the name of road network node dataset.
  39. Take 4D navigation electronic maps data exchange format as an example, corresponding to N table.
  40. </summary>
  41. <value>The default value is String.Empty .</value>
  42. </member>
  43. <member name="P:SuperMap.Analyst.Navigation.CompilerParameter.NameCondPoint">
  44. <summary>
  45. Gets or sets the name of road network turn node dataset.
  46. Take 4D navigation electronic maps data exchange format as an example, corresponding to C table.
  47. </summary>
  48. <value>The default value is String.Empty .</value>
  49. </member>
  50. <member name="P:SuperMap.Analyst.Navigation.CompilerParameter.NameAdminCode">
  51. <summary>
  52. Gets or sets the dataset name of input road network administrative division table.
  53. </summary>
  54. <value>The default value is String.Empty .</value>
  55. </member>
  56. <member name="P:SuperMap.Analyst.Navigation.CompilerParameter.NameRoadNameLink">
  57. <summary>
  58. Gets or sets the name of road network data basic line to be complied and road name relationship table.
  59. Take 4D navigation electronic maps data exchange format as an example, corresponding to R_LNAME table.
  60. </summary>
  61. <value>The default value is String.Empty .</value>
  62. </member>
  63. <member name="P:SuperMap.Analyst.Navigation.CompilerParameter.NameRoadName">
  64. <summary>
  65. Gets or sets the name of road network data basic road name table.
  66. Take 4D navigation electronic maps data exchange format as an example, corresponding to R_NAME table.
  67. </summary>
  68. <value>The default value is String.Empty .</value>
  69. </member>
  70. <member name="P:SuperMap.Analyst.Navigation.CompilerParameter.ExportPath">
  71. <summary>
  72. Gets or sets the output folder of road network data compiling. The path should be the existing folder.
  73. </summary>
  74. <value>The default value is String.Empty .</value>
  75. </member>
  76. <member name="P:SuperMap.Analyst.Navigation.CompilerParameter.DistrictName">
  77. <summary>
  78. Gets or sets the road network name in the current compiling.
  79. </summary>
  80. <value>The default value is String.Empty .</value>
  81. </member>
  82. <member name="P:SuperMap.Analyst.Navigation.CompilerParameter.PackageTypes">
  83. <summary>
  84. Gets or sets compiling result data package type.
  85. </summary>
  86. <value>The default value is null.</value>
  87. </member>
  88. <member name="P:SuperMap.Analyst.Navigation.CompilerParameter.SourceDataVersion">
  89. <summary>
  90. Gets or sets the the input road network data version.
  91. </summary>
  92. <value>Default value is NIG2013SumGreatChina.</value>
  93. </member>
  94. <member name="P:SuperMap.Analyst.Navigation.CompilerParameter.Language">
  95. <summary>
  96. Gets or sets the language type of the road name at the time of compiling the 4D navigation data. Refer to the four-dimensional navigation data description for details.
  97. </summary>
  98. </member>
  99. <member name="T:SuperMap.Analyst.Navigation.CompilerParameterSSC">
  100. <summary>
  101. Constructs SSC file parameter class. Provides parameters for compiling the road route data to SSC shortcut file.
  102. </summary>
  103. </member>
  104. <member name="M:SuperMap.Analyst.Navigation.CompilerParameterSSC.#ctor">
  105. <summary>
  106. Construct a new parameter object to generate the SCC file.
  107. </summary>
  108. </member>
  109. <member name="M:SuperMap.Analyst.Navigation.CompilerParameterSSC.#ctor(SuperMap.Analyst.Navigation.CompilerParameterSSC)">
  110. <summary>
  111. Initializes a new instance according to the specified parameter object.
  112. </summary>
  113. <param name="parameter">Specified parameter object to generate the SCC file.</param>
  114. </member>
  115. <member name="P:SuperMap.Analyst.Navigation.CompilerParameterSSC.NetworkDataset">
  116. <summary>
  117. Gets or sets the network dataset to generate the SCC file. Required.
  118. </summary>
  119. <value>The default value is null.</value>
  120. </member>
  121. <member name="P:SuperMap.Analyst.Navigation.CompilerParameterSSC.NodeIDField">
  122. <summary>
  123. Gets or sets the node ID field of the network dataset.
  124. </summary>
  125. <value>The default value is SmNodeID.</value>
  126. </member>
  127. <member name="P:SuperMap.Analyst.Navigation.CompilerParameterSSC.EdgeIDField">
  128. <summary>
  129. Gets or sets the edge ID field of the network dataset.
  130. </summary>
  131. <value>The default value is SmEdgeID.</value>
  132. </member>
  133. <member name="P:SuperMap.Analyst.Navigation.CompilerParameterSSC.FNodeIDField">
  134. <summary>
  135. Gets or sets the field identifying the from and to node ID of the edge.
  136. </summary>
  137. <value>The default value is SmFNode.</value>
  138. </member>
  139. <member name="P:SuperMap.Analyst.Navigation.CompilerParameterSSC.TNodeIDField">
  140. <summary>
  141. Gets or sets the field identifying the end node ID of the edge.
  142. </summary>
  143. <value>The default value is SmTNode.</value>
  144. </member>
  145. <member name="P:SuperMap.Analyst.Navigation.CompilerParameterSSC.WeightField">
  146. <summary>
  147. Gets or sets the weight field of the edge.
  148. </summary>
  149. <value>The default value is "SmLength".</value>
  150. </member>
  151. <member name="P:SuperMap.Analyst.Navigation.CompilerParameterSSC.EdgeNameField">
  152. <summary>
  153. Gets or sets the name field of the edge.
  154. </summary>
  155. <value>The default value is SmEdgeID.</value>
  156. </member>
  157. <member name="P:SuperMap.Analyst.Navigation.CompilerParameterSSC.TurnDataset">
  158. <summary>
  159. Gets or sets the turn dataset.
  160. </summary>
  161. <value>The default value is null.</value>
  162. </member>
  163. <member name="P:SuperMap.Analyst.Navigation.CompilerParameterSSC.TurnNodeIDField">
  164. <summary>
  165. Gets or sets the field of the turn node ID.
  166. </summary>
  167. </member>
  168. <member name="P:SuperMap.Analyst.Navigation.CompilerParameterSSC.TurnFEdgeIDField">
  169. <summary>
  170. Gets or sets the field of the start turn edge ID.
  171. </summary>
  172. </member>
  173. <member name="P:SuperMap.Analyst.Navigation.CompilerParameterSSC.TurnTEdgeIDField">
  174. <summary>
  175. Gets or sets the field of the end turn edge ID.
  176. </summary>
  177. </member>
  178. <member name="P:SuperMap.Analyst.Navigation.CompilerParameterSSC.RuleField">
  179. <summary>
  180. Gets or sets the transportation rule filed name.
  181. </summary>
  182. </member>
  183. <member name="P:SuperMap.Analyst.Navigation.CompilerParameterSSC.FTSingleWayRuleValues">
  184. <summary>
  185. Gets or sets an array of strings that are used to represent forward lines, that is, when the value of the RuleField field is one of the values of the array, it represents a forward line.
  186. </summary>
  187. </member>
  188. <member name="P:SuperMap.Analyst.Navigation.CompilerParameterSSC.TFSingleWayRuleValues">
  189. <summary>
  190. Gets or sets an array of strings that are used to represent backward lines, that is, when the value of the RuleField field is one of the values of the array, it represents a backward line.
  191. </summary>
  192. </member>
  193. <member name="P:SuperMap.Analyst.Navigation.CompilerParameterSSC.ProhibitedWayRuleValues">
  194. <summary>
  195. Gets or sets an array of strings that are used to represent forbidden lines, that is, when the value of the RuleField field is one of the values of the array, it represents a forbidden line.
  196. </summary>
  197. </member>
  198. <member name="P:SuperMap.Analyst.Navigation.CompilerParameterSSC.TwoWayRuleValues">
  199. <summary>
  200. Gets or sets an array of strings that are used to represent two-way lines, that is, when the value of the RuleField field is one of the values of the array, it represents a two-way line.
  201. </summary>
  202. </member>
  203. <member name="P:SuperMap.Analyst.Navigation.CompilerParameterSSC.FilePath">
  204. <summary>
  205. Gets or sets the directory of the created SSC file.
  206. </summary>
  207. <value>The default value is String.Empty.</value>
  208. </member>
  209. <member name="P:SuperMap.Analyst.Navigation.CompilerParameterSSC.LevelField">
  210. <summary>
  211. Gets or sets the road level field. The value range is 1-3. The one road level is highest, and 3 road level is the lowest.
  212. </summary>
  213. <value>The default value is String.Empty.</value>
  214. </member>
  215. <member name="P:SuperMap.Analyst.Navigation.CompilerParameterSSC.SpeedField">
  216. <summary>
  217. Gets or sets the road speed field. The value range is 1-7. The one road level is highest, and 7 road level is the lowest.
  218. </summary>
  219. <value>The default value is String.Empty.</value>
  220. </member>
  221. <member name="T:SuperMap.Analyst.Navigation.DataCompiler">
  222. <summary>
  223. The road network data compile class. This class can compile the road network, which is used to analyze.
  224. </summary>
  225. </member>
  226. <member name="M:SuperMap.Analyst.Navigation.DataCompiler.#ctor">
  227. <summary>
  228. Construct the road network data compile class object.
  229. </summary>
  230. </member>
  231. <member name="M:SuperMap.Analyst.Navigation.DataCompiler.Finalize">
  232. <summary>
  233. Releases unmanaged resources and performs other cleanup operations before the DataCompiler is reclaimed by garbage collection.
  234. </summary>
  235. </member>
  236. <member name="M:SuperMap.Analyst.Navigation.DataCompiler.Dispose">
  237. <summary>
  238. Releases the resources occupied by DataCompiler.
  239. </summary>
  240. </member>
  241. <member name="M:SuperMap.Analyst.Navigation.DataCompiler.CompileBaseRoad(SuperMap.Analyst.Navigation.CompilerParameter,System.Int32[])">
  242. <summary>
  243. Basic road data compiling.
  244. </summary>
  245. <param name="parameter">The specified road data compiling parameter class.</param>
  246. <param name="mapIDs">The specified road network compiled mapsheet ID array. It can be get by calling <see cref="M:SuperMap.Analyst.Navigation.DataCompiler.CompileMapID(SuperMap.Analyst.Navigation.CompilerParameter,System.String)">CompileMapID</see>. Also can specify the available mapsheet ID.</param>
  247. <returns>True if it is removed successfully; false otherwise.</returns>
  248. </member>
  249. <member name="M:SuperMap.Analyst.Navigation.DataCompiler.CompileGuideData(SuperMap.Analyst.Navigation.CompilerParameter,System.Int32[])">
  250. <summary>
  251. The guide data compile.
  252. </summary>
  253. <param name="parameter">The specified road data compiling parameter class.</param>
  254. <param name="mapIDs">The specified road network compiled mapsheet ID array. It can be get by calling <see cref="M:SuperMap.Analyst.Navigation.DataCompiler.CompileMapID(SuperMap.Analyst.Navigation.CompilerParameter,System.String)">CompileMapID</see>. Also can specify the available mapsheet ID.</param>
  255. <returns>True if it is removed successfully; false otherwise.</returns>
  256. </member>
  257. <member name="M:SuperMap.Analyst.Navigation.DataCompiler.CompileTopologyData(SuperMap.Analyst.Navigation.CompilerParameter,System.Int32[])">
  258. <summary>
  259. The topology data compile.
  260. </summary>
  261. <param name="parameter">The specified road data compiling parameter class.</param>
  262. <param name="mapIDs">The specified road network compiled mapsheet ID array. It can be get by calling <see cref="M:SuperMap.Analyst.Navigation.DataCompiler.CompileMapID(SuperMap.Analyst.Navigation.CompilerParameter,System.String)">CompileMapID</see>. Also can specify the available mapsheet ID.</param>
  263. <returns>True if it is removed successfully; false otherwise.</returns>
  264. </member>
  265. <member name="M:SuperMap.Analyst.Navigation.DataCompiler.PackageData(SuperMap.Analyst.Navigation.CompilerParameter,System.Int32[])">
  266. <summary>
  267. Data package.
  268. </summary>
  269. <param name="parameter">The specified road data compiling parameter class.</param>
  270. <param name="mapIDs">The specified road network compiled mapsheet ID array. It can be get by calling <see cref="M:SuperMap.Analyst.Navigation.DataCompiler.CompileMapID(SuperMap.Analyst.Navigation.CompilerParameter,System.String)">CompileMapID</see>. Also can specify the available mapsheet ID.</param>
  271. <returns>True if it is removed successfully; false otherwise.</returns>
  272. </member>
  273. <member name="M:SuperMap.Analyst.Navigation.DataCompiler.UpdatePathName(SuperMap.Analyst.Navigation.CompilerParameter)">
  274. <summary>
  275. Update road name field.
  276. </summary>
  277. <param name="parameter">The specified road data compiling parameter class.</param>
  278. <returns>True if it is removed successfully; false otherwise.</returns>
  279. </member>
  280. <member name="M:SuperMap.Analyst.Navigation.DataCompiler.CompileMapID(SuperMap.Analyst.Navigation.CompilerParameter,System.String)">
  281. <summary>
  282. Gets the mapsheet ID array.
  283. </summary>
  284. <param name="parameter">The specified road data compiling parameter class.</param>
  285. <param name="resultCoverageDatasetName">The specified map extent dataset name, which is used to create map extent dataset. This dataset contains the map extent of road network to be compiled.</param>
  286. <returns>Gets the mapsheet ID array.</returns>
  287. </member>
  288. <member name="M:SuperMap.Analyst.Navigation.DataCompiler.ExtractAdminCode(SuperMap.Data.DatasetVector,SuperMap.Data.DatasetVector,SuperMap.Data.Datasource,System.String)">
  289. <summary>
  290. Extract the AdminCode dataset from Admin and FName of 4D navigation data.
  291. </summary>
  292. <param name="datasetAdmin">The dataset of Admin.</param>
  293. <param name="datasetFName">The dataset of FName.</param>
  294. <param name="datasource">The datasource of result administrative dataset.</param>
  295. <param name="resultDatasetName">The name of result administrative dataset. It should be valid.</param>
  296. <returns>Returns the result administrative dataset. Returns null if failed.</returns>
  297. </member>
  298. <!-- 对于成员“M:SuperMap.Analyst.Navigation.DataCompiler.ExtractAdminCode(SuperMap.Data.DatasetVector,SuperMap.Data.DatasetVector,SuperMap.Data.Datasource,System.String,System.Int32)”忽略有格式错误的 XML 注释 -->
  299. <member name="M:SuperMap.Analyst.Navigation.DataCompiler.ExtractRoadDirection(SuperMap.Data.DatasetVector,System.Double,System.Double,System.String[],SuperMap.Data.Datasource,System.String)">
  300. <summary>
  301. Extract the road direction from 4D navigation road line dataset. Every road will create one or more direction segment along with the road direction. The line direction is the road direction.
  302. </summary>
  303. <param name="datasetRoad">It needs to create the line dataset of road direction, corresponding to R table of 4D navigation dataset.</param>
  304. <param name="segmentLength">The length of result direction segment. The unit is the same as road line dataset coordinate system.</param>
  305. <param name="spacingLength">The interval of every result direction segment. The unit is the same as road line dataset coordinate system.</param>
  306. <param name="roadKinds">The road lebel that needs to create road direction. In the 4D navigation data R table, road level is stored in the Kind field. For example, in 2013 summer data version, there are 0x00 highway, 0x01 urban highway, 0x02 national road, 0x03 provincial road, 0x04 country road, 0x06 country road, 0x08 other roads, 0x09 9 class road, 0x0a ferry, 0x0b pavement.</param>
  307. <param name="outputDatasource">The datasource where the result dataset is included.</param>
  308. <param name="resultDatasetName">The name of result dataset. It must be valid.</param>
  309. <returns>Represents the line dataset representing the road direction. Returns null if failed.</returns>
  310. </member>
  311. <member name="M:SuperMap.Analyst.Navigation.DataCompiler.CompileSSCData(SuperMap.Analyst.Navigation.CompilerParameterSSC)">
  312. <summary>
  313. Compile network data into SSC files containing shortcut information.
  314. </summary>
  315. <param name="parameter">Specify the SSC file to compile parameter classes.</param>
  316. <returns>Return "true" once get success, otherwise return to "false". </returns>
  317. </member>
  318. <member name="E:SuperMap.Analyst.Navigation.DataCompiler.Stepped">
  319. <summary>
  320. The event is trigged when the process bar is activated.
  321. </summary>
  322. </member>
  323. <member name="T:SuperMap.Analyst.Navigation.DataVersion">
  324. <summary>
  325. This enumeration defines the version of source road network data. Each manufacturer or same manufacturer released different data versions. So when you compile basic road data, users need to specify the version of road network data.
  326. </summary>
  327. </member>
  328. <member name="F:SuperMap.Analyst.Navigation.DataVersion.NIG2012WinGreatChina">
  329. <summary>
  330. The data before 4D 2012 winter navigation electronic map data exchange format.
  331. </summary>
  332. </member>
  333. <member name="F:SuperMap.Analyst.Navigation.DataVersion.NIG2013SumGreatChina">
  334. <summary>
  335. Siwei 2013 summer navigation electronic map data interchange format.
  336. </summary>
  337. </member>
  338. <member name="T:SuperMap.Analyst.Navigation.GPSData">
  339. <summary>
  340. GPS data classes.
  341. </summary>
  342. </member>
  343. <member name="M:SuperMap.Analyst.Navigation.GPSData.#ctor">
  344. <summary>
  345. Construct a new object for a new GPS data class.
  346. </summary>
  347. </member>
  348. <member name="M:SuperMap.Analyst.Navigation.GPSData.#ctor(SuperMap.Analyst.Navigation.GPSData)">
  349. <summary>
  350. Construct a new object for a new GPS data class.
  351. </summary>
  352. <param name="data">Given GPS data.</param>
  353. </member>
  354. <member name="P:SuperMap.Analyst.Navigation.GPSData.Point">
  355. <summary>
  356. Gets or sets the coordinates of the GPS points.
  357. </summary>
  358. </member>
  359. <member name="P:SuperMap.Analyst.Navigation.GPSData.TimeValue">
  360. <summary>
  361. Gets or sets the time value of the GPS point (in seconds).
  362. </summary>
  363. </member>
  364. <member name="T:SuperMap.Analyst.Navigation.MapMatchParameter">
  365. <summary>
  366. Parameter class for matching point pre-processing of map .
  367. </summary>
  368. </member>
  369. <member name="M:SuperMap.Analyst.Navigation.MapMatchParameter.#ctor">
  370. <summary>
  371. Construct a new map matching point pre-processing parameter object.
  372. </summary>
  373. </member>
  374. <member name="M:SuperMap.Analyst.Navigation.MapMatchParameter.#ctor(SuperMap.Analyst.Navigation.MapMatchParameter)">
  375. <summary>
  376. An identical object is constructed according to a given map matching point pre-processing parameter object.
  377. </summary>
  378. <param name="parameter">A pre-processing parameter object with given marching point.</param>
  379. </member>
  380. <member name="P:SuperMap.Analyst.Navigation.MapMatchParameter.DatasetVector">
  381. <summary>
  382. Gets or sets the map matching point dataset for the input.
  383. </summary>
  384. <value>The default value is null.</value>
  385. </member>
  386. <member name="P:SuperMap.Analyst.Navigation.MapMatchParameter.Velocity">
  387. <summary>
  388. Gets or sets the speed field of the input map matching point data set.
  389. </summary>
  390. <value>The default value is String. Empty.</value>
  391. </member>
  392. <member name="P:SuperMap.Analyst.Navigation.MapMatchParameter.Time">
  393. <summary>
  394. Gets or sets the time field of the input map matching point dataset, which is the integer field, the unit is seconds, and the field is set.
  395. </summary>
  396. <value>The default value is String. Empty.</value>
  397. </member>
  398. <member name="P:SuperMap.Analyst.Navigation.MapMatchParameter.Angle">
  399. <summary>
  400. Gets or sets the Angle field of the input map matching point dataset.
  401. </summary>
  402. <value>The default value is String.Empty .</value>
  403. </member>
  404. <member name="T:SuperMap.Analyst.Navigation.PackageType">
  405. <summary>
  406. This enumeration defines the data package type in road data compiling.
  407. </summary>
  408. </member>
  409. <member name="F:SuperMap.Analyst.Navigation.PackageType.PackageLine">
  410. <summary>
  411. Package basic road data.
  412. </summary>
  413. </member>
  414. <member name="F:SuperMap.Analyst.Navigation.PackageType.PackageTopo">
  415. <summary>
  416. Package topology data.
  417. </summary>
  418. </member>
  419. <member name="F:SuperMap.Analyst.Navigation.PackageType.PackageGuide">
  420. <summary>
  421. Package guide data.
  422. </summary>
  423. </member>
  424. <member name="T:SuperMap.Analyst.Navigation.PathAnalyst">
  425. <summary>
  426. The navigation analysis class. This class is used to perform navigation analysis through the data after data compiled.
  427. </summary>
  428. </member>
  429. <member name="M:SuperMap.Analyst.Navigation.PathAnalyst.#ctor">
  430. <summary>
  431. Constructs the object of navigation analysis class.
  432. </summary>
  433. </member>
  434. <member name="M:SuperMap.Analyst.Navigation.PathAnalyst.Dispose">
  435. <summary>
  436. Releases the object of navigation analysis class.
  437. </summary>
  438. </member>
  439. <member name="M:SuperMap.Analyst.Navigation.PathAnalyst.ConnectData(System.String)">
  440. <summary>
  441. Connects to the compiling result data.
  442. </summary>
  443. <param name="strPath">The detailed path of ompiled data.</param>
  444. <returns>Returns true if connected successfully; otherwise false.</returns>
  445. </member>
  446. <member name="M:SuperMap.Analyst.Navigation.PathAnalyst.Plan">
  447. <summary>
  448. Perform the path planning.
  449. </summary>
  450. <returns>Returns true if analyzed successfully; otherwise false.</returns>
  451. </member>
  452. <member name="M:SuperMap.Analyst.Navigation.PathAnalyst.GetPathPoints">
  453. <summary>
  454. Returns the collection of the nodes passed by the analysis result path.
  455. </summary>
  456. <returns>The collection of the nodes passed by the analysis result path.</returns>
  457. </member>
  458. <member name="M:SuperMap.Analyst.Navigation.PathAnalyst.GetPathLength">
  459. <summary>
  460. Returns the total length of analysis result.
  461. </summary>
  462. <returns>The total length of analysis result.</returns>
  463. </member>
  464. <member name="M:SuperMap.Analyst.Navigation.PathAnalyst.GetPathInfos">
  465. <summary>
  466. Returns the guide info set of analysis result.
  467. </summary>
  468. <returns>The guide info set of analysis result.</returns>
  469. </member>
  470. <member name="M:SuperMap.Analyst.Navigation.PathAnalyst.GetPathTime">
  471. <summary>
  472. Returns the driving time of the analysis result. The unit is in seconds.
  473. </summary>
  474. <returns>The driving time of the analysis result. </returns>
  475. </member>
  476. <member name="M:SuperMap.Analyst.Navigation.PathAnalyst.GetAltPathPoints">
  477. <summary>
  478. Returns the path point collection of alternative analysis results.
  479. </summary>
  480. <returns>A collection of point coordinates for alternative analysis results.</returns>
  481. </member>
  482. <member name="M:SuperMap.Analyst.Navigation.PathAnalyst.GetAltPathLength">
  483. <summary>
  484. Returns the total length of alternative analysis results.
  485. </summary>
  486. <returns>The total length of the alternative analysis results.</returns>
  487. </member>
  488. <member name="M:SuperMap.Analyst.Navigation.PathAnalyst.GetAltPathInfos">
  489. <summary>
  490. Returns the boot information collection of the alternative analysis results.
  491. </summary>
  492. <returns>The boot information collection of alternative analysis results.</returns>
  493. </member>
  494. <member name="M:SuperMap.Analyst.Navigation.PathAnalyst.GetAltPathTime">
  495. <summary>
  496. Returns the running time of the alternative analysis results in seconds.
  497. </summary>
  498. <returns>The driving time of the alternative analysis results.</returns>
  499. </member>
  500. <member name="M:SuperMap.Analyst.Navigation.PathAnalyst.SetSSCEnvironment(SuperMap.Analyst.Navigation.SSCDataEnvironment)">
  501. <summary>
  502. Set up the SSC data analysis environment.
  503. </summary>
  504. <param name="environment">SSC data environment objects.</param>
  505. <returns>Return to "ture" once get success. return to "false" once get false.</returns>
  506. </member>
  507. <member name="M:SuperMap.Analyst.Navigation.PathAnalyst.MapMatch(SuperMap.Analyst.Navigation.GPSData[],System.Int32)">
  508. <summary>
  509. API of map marching analysis
  510. </summary>
  511. <param name="datas">GPS data array.</param>
  512. <param name="candidateCount">Candidate number.</param>
  513. <returns>GPS matches the result point array.</returns>
  514. </member>
  515. <member name="M:SuperMap.Analyst.Navigation.PathAnalyst.PrepareData(SuperMap.Analyst.Navigation.MapMatchParameter,System.String)">
  516. <summary>
  517. Map matching point preprocessing interface.
  518. </summary>
  519. <param name="param">Preprocessing parameters, mainly set the GPS point data set and the required field names.</param>
  520. <param name="name">The GPS point dataset name returned after processing (if the name set is an existing dataset name, the dataset will be deleted and a new dataset will be generated).</param>
  521. <returns>Successfully returns an array of processed GPS point datasets.</returns>
  522. </member>
  523. <member name="P:SuperMap.Analyst.Navigation.PathAnalyst.StartPoint">
  524. <summary>
  525. Set the start point of navigation.
  526. </summary>
  527. </member>
  528. <member name="P:SuperMap.Analyst.Navigation.PathAnalyst.EndPoint">
  529. <summary>
  530. Set the end point of navigation.
  531. </summary>
  532. </member>
  533. <member name="P:SuperMap.Analyst.Navigation.PathAnalyst.Points">
  534. <summary>
  535. Set the middle point of navigation.
  536. </summary>
  537. </member>
  538. <member name="P:SuperMap.Analyst.Navigation.PathAnalyst.RouteMode">
  539. <summary>
  540. Set the mode of navigation.
  541. </summary>
  542. </member>
  543. <member name="P:SuperMap.Analyst.Navigation.PathAnalyst.IsAlternative">
  544. <summary>
  545. Gets or sets whether to return an alternative.
  546. </summary>
  547. <value>Default is false</value>
  548. </member>
  549. <member name="T:SuperMap.Analyst.Navigation.PathInfo">
  550. <summary>
  551. Navigation guide information class. Through this class, you can get road guide information after navigation analysis.
  552. </summary>
  553. </member>
  554. <member name="P:SuperMap.Analyst.Navigation.PathInfo.Length">
  555. <summary>
  556. Gets the length of the current road.
  557. </summary>
  558. </member>
  559. <member name="P:SuperMap.Analyst.Navigation.PathInfo.RouteName">
  560. <summary>
  561. Gets the name of the current road.
  562. </summary>
  563. </member>
  564. <member name="P:SuperMap.Analyst.Navigation.PathInfo.Junction">
  565. <summary>
  566. Gets the crossing coordinates of next road.
  567. </summary>
  568. </member>
  569. <member name="P:SuperMap.Analyst.Navigation.PathInfo.DirToSwerve">
  570. <summary>
  571. Returns the direction of turning of next road.
  572. </summary>
  573. </member>
  574. <member name="T:SuperMap.Analyst.Navigation.RouteType">
  575. <summary>
  576. This class defines the analysis mode of navigation analysis.
  577. </summary>
  578. </member>
  579. <member name="F:SuperMap.Analyst.Navigation.RouteType.Recommend">
  580. <summary>
  581. Recommended mode.
  582. </summary>
  583. </member>
  584. <member name="F:SuperMap.Analyst.Navigation.RouteType.MinLength">
  585. <summary>
  586. The shortest distance.
  587. </summary>
  588. </member>
  589. <member name="F:SuperMap.Analyst.Navigation.RouteType.NoHighWay">
  590. <summary>
  591. No express.
  592. </summary>
  593. </member>
  594. <member name="T:SuperMap.Analyst.Navigation.SSCDataEnvironment">
  595. <summary>
  596. SSC data environment class. Provide the high performance analysis environment for the path planning. Multiple PathAnalyst objects can be shared the environment.
  597. </summary>
  598. </member>
  599. <member name="M:SuperMap.Analyst.Navigation.SSCDataEnvironment.#ctor">
  600. <summary>
  601. Constructs a new SSC data environment object.
  602. </summary>
  603. </member>
  604. <member name="M:SuperMap.Analyst.Navigation.SSCDataEnvironment.Dispose">
  605. <summary>
  606. Disposes the SSC data environment object. After calling this method, this object will not be disable.
  607. </summary>
  608. </member>
  609. <member name="M:SuperMap.Analyst.Navigation.SSCDataEnvironment.ConnectData(System.String,SuperMap.Data.DatasetVector)">
  610. <summary>
  611. Connect the SSC compiling result data, and load the network dataset information.
  612. </summary>
  613. <param name="sscFilePath">SSC file path, including the file name.</param>
  614. <param name="networkDataset">The network dataset related to the SSC file.</param>
  615. <returns>Returns true if successfully; otherwise false.</returns>
  616. </member>
  617. <member name="E:SuperMap.Analyst.Navigation.SSCDataEnvironment.Stepped">
  618. <summary>
  619. The event is trigged when the process bar is activated.
  620. </summary>
  621. </member>
  622. </members>
  623. </doc>