SuperMap.Realspace.NetworkAnalyst.xml 68 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>SuperMap.Realspace.NetworkAnalyst</name>
  5. </assembly>
  6. <members>
  7. <member name="T:SuperMap.Realspace.NetworkAnalyst.BurstAnalyse3DResult">
  8. <summary>
  9. The pipe-broken analysis result class. The result of pipe-broken returns the crucial facility nodes, common facility nodes and arcs.
  10. </summary>
  11. </member>
  12. <member name="P:SuperMap.Realspace.NetworkAnalyst.BurstAnalyse3DResult.CriticalNodes">
  13. <summary>
  14. Obtain the key facilities in the burst analysis to influence the upstream and downstream of the burst position.
  15. <remark>
  16. Key facilities include two facilities:
  17. <para>1. The location of the pipe in the upper part of the pipe directly affect the location of the facilities.</para><para>2. In the downstream, there is a direct impact on the location of the pipe and the outflow (ie, the degree is greater than 0).</para></remark></summary>
  18. </member>
  19. <member name="P:SuperMap.Realspace.NetworkAnalyst.BurstAnalyse3DResult.NormalNodes">
  20. <summary>
  21. Gets the common facility nodes that are affected by the pipe-broken position.
  22. </summary>
  23. <remark>Ordinary facilities include three types:
  24. <para>1. Allowed by the location of the pipe directly affected and no outflow (out of 0) facilities.</para><para>2.The upstream of each of the key facilities points out of the arc, which directly affects all facilities A, (except for all key facilities), and facility A needs to be met: the upstream critical facility point to the point A of the facility A and the upstream and downstream key The influence of the facility has a common part of the arc.</para><para>3.(Point 2 and common facility point 1) which are directly affected by the location of the pipe in the downstream direction of the pipe burst, the facility point B in the upper reaches of the facility A directly affects the facility point B of the facility A (excluding all key facilities) And the need to meet the facilities A to the point B of the impact of the arc and the impact of the upstream and downstream key facilities have a common part of the arc.</para></remark>
  25. </member>
  26. <member name="P:SuperMap.Realspace.NetworkAnalyst.BurstAnalyse3DResult.Edges">
  27. <summary>
  28. Gets the edges that affect the pipe-broken position and the are affected by the pipe-broken. The edges that two-way search the crucial facility point and common facility points from the pipe-broken position.
  29. </summary>
  30. </member>
  31. <member name="T:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D">
  32. <summary>
  33. The FacilityAnalyst3D class is used for checking data, finding the edges between node/edge and source/sink, tracing upstream, tracing downstream, finding the upstream closest facility, etc.
  34. </summary>
  35. </member>
  36. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.#ctor">
  37. <summary>
  38. Creates a new FacilityAnalyst3D object.
  39. </summary>
  40. </member>
  41. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.Load">
  42. <summary>
  43. loads the network model according to the environment parameters of the FacilityAnalystSetting3D class.
  44. </summary>
  45. <returns>A boolean value denotes whether the network model loads successfully or not. True if successful; otherwise, false.</returns>
  46. <para>Please refer to <see cref="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.FindSourceFromEdge(System.Int32,System.String,System.Boolean)">FindSourceFromEdge</see>, <see cref="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.TraceUpFromEdge(System.Int32,System.String,System.Boolean)">TraceUpFromEdge</see> and <see cref="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.FindCriticalFacilitiesUpFromEdge(System.Int32[],System.Int32,System.Boolean)">FindCriticalFacilitiesUpFromEdge</see>.</para>
  47. </member>
  48. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.Check">
  49. <summary>
  50. Checks the data for the 3D facility network dataset, and returns the results object of the Check class.
  51. </summary>
  52. <returns>The data check result of the 3D facility network analysis.</returns>
  53. </member>
  54. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.FindSourceFromEdge(System.Int32,System.String,System.Boolean)">
  55. <summary>
  56. Finds the source according to the given edge ID. i.e., from the given edge, finding the network source that flows to this edge according to the flow, and returning the edges, nodes and cost in least path cost.
  57. </summary>
  58. <param name="edgeID">The specified edge ID.</param>
  59. <param name="weightName">The name of the specified WeightFieldInfo object. i.e., the <see cref="P:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D.Name">Name</see> value of a certain <see cref="T:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D">WeightFieldInfo3D</see> object of the <see cref="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.WeightFieldInfos">WeightFieldInfos</see> object specified by the TransportationAnalystSetting class.</param>
  60. <param name="isUncertainDirectionValid">Specifies whether the uncertain flow is valid. True represents it is valid. The edged that have the uncertain flow still in the analysis. If it is false, it will stop searching when meeting the uncertain flow. When the flow field is 2, it is an uncertain flow. Please refer to <see cref="M:SuperMap.Realspace.NetworkAnalyst.NetworkBuilder3D.BuildFacilityNetworkDirections(SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D,System.Int32[],System.Int32[],System.String)">BuildFacilityNetworkDirections</see> for more information.</param>
  61. <returns>Facility Analysis Result.</returns>
  62. </member>
  63. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.FindSourceFromNode(System.Int32,System.String,System.Boolean)">
  64. <summary>
  65. Finds the source according to the given node ID. i.e., from the given node, finding the network source that flows to this node according to the flow, and returning the edges, nodes and cost in least path cost.
  66. </summary>
  67. <param name="nodeID">The specified Node ID.</param>
  68. <param name="weightName">The name of the specified WeightFieldInfo object. i.e., the <see cref="P:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D.Name">Name</see> value of a certain <see cref="T:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D">WeightFieldInfo3D</see> object of the <see cref="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.WeightFieldInfos">WeightFieldInfos</see> object specified by the TransportationAnalystSetting class.</param>
  69. <param name="isUncertainDirectionValid">Specifies whether the uncertain flow is valid. True represents it is valid. The edged that have the uncertain flow still in the analysis. If it is false, it will stop searching when meeting the uncertain flow. When the flow field is 2, it is an uncertain flow. Please refer to <see cref="M:SuperMap.Realspace.NetworkAnalyst.NetworkBuilder3D.BuildFacilityNetworkDirections(SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D,System.Int32[],System.Int32[],System.String)">BuildFacilityNetworkDirections</see> for more information.</param>
  70. <returns>Facility Analysis Result.</returns>
  71. </member>
  72. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.FindSinkFromEdge(System.Int32,System.String,System.Boolean)">
  73. <summary>
  74. Finds the sink according to the given edge ID. i.e., from the given edge, finding the downstream sink that flows out this edge according to the flow, and returning the edges, nodes and cost in least path cost from gien edge to this sink.
  75. </summary>
  76. <param name="edgeID">The specified edge ID.</param>
  77. <param name="weightName">The name of the specified WeightFieldInfo object. i.e., the <see cref="P:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D.Name">Name</see> value of a certain <see cref="T:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D">WeightFieldInfo3D</see> object of the <see cref="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.WeightFieldInfos">WeightFieldInfos</see> object specified by the TransportationAnalystSetting class.</param>
  78. <param name="isUncertainDirectionValid">Specifies whether the uncertain flow is valid. True represents it is valid. The edged that have the uncertain flow still in the analysis. If it is false, it will stop searching when meeting the uncertain flow. When the flow field is 2, it is an uncertain flow. Please refer to <see cref="M:SuperMap.Realspace.NetworkAnalyst.NetworkBuilder3D.BuildFacilityNetworkDirections(SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D,System.Int32[],System.Int32[],System.String)">BuildFacilityNetworkDirections</see> for more information.</param>
  79. <returns>Facility Analysis Result.</returns>
  80. </member>
  81. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.FindSinkFromNode(System.Int32,System.String,System.Boolean)">
  82. <summary>
  83. Finds the sink according to the given node ID. i.e., from the given node, finding the downstream sink that flows out this node according to the flow, and returning the edges, nodes and cost in least path cost from given node to this sink.
  84. </summary>
  85. <param name="nodeID">The specified Node ID.</param>
  86. <param name="weightName">The name of the specified WeightFieldInfo object. i.e., the <see cref="P:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D.Name">Name</see> value of a certain <see cref="T:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D">WeightFieldInfo3D</see> object of the <see cref="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.WeightFieldInfos">WeightFieldInfos</see> object specified by the TransportationAnalystSetting class.</param>
  87. <param name="isUncertainDirectionValid">Specifies whether the uncertain flow is valid. True represents it is valid. The edged that have the uncertain flow still in the analysis. If it is false, it will stop searching when meeting the uncertain flow. When the flow field is 2, it is an uncertain flow. Please refer to <see cref="M:SuperMap.Realspace.NetworkAnalyst.NetworkBuilder3D.BuildFacilityNetworkDirections(SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D,System.Int32[],System.Int32[],System.String)">BuildFacilityNetworkDirections</see> for more information.</param>
  88. <returns>Facility Analysis Result.</returns>
  89. </member>
  90. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.TraceUpFromEdge(System.Int32,System.String,System.Boolean)">
  91. <summary>
  92. According to the given arc ID, perform the tracing upstream. Namely, finding the arcs, nodes and cost of the upstream.
  93. </summary>
  94. <param name="edgeID">The specified edge ID.</param>
  95. <param name="weightName">The name of the specified WeightFieldInfo object. i.e., the <see cref="P:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D.Name">Name</see> value of a certain <see cref="T:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D">WeightFieldInfo3D</see> object of the <see cref="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.WeightFieldInfos">WeightFieldInfos</see> object specified by the TransportationAnalystSetting class.</param>
  96. <param name="isUncertainDirectionValid">Specifies whether the uncertain flow is valid. True represents it is valid. The edged that have the uncertain flow still in the analysis. If it is false, it will stop searching when meeting the uncertain flow. When the flow field is 2, it is an uncertain flow. Please refer to <see cref="M:SuperMap.Realspace.NetworkAnalyst.NetworkBuilder3D.BuildFacilityNetworkDirections(SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D,System.Int32[],System.Int32[],System.String)">BuildFacilityNetworkDirections</see> for more information.</param>
  97. <returns>Facility Analysis Result.</returns>
  98. </member>
  99. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.TraceUpFromNode(System.Int32,System.String,System.Boolean)">
  100. <summary>
  101. According to the given node ID, perform the tracing upstream. Namely, finding the arcs, nodes and cost of the upstream.
  102. </summary>
  103. <param name="nodeID">The specified Node ID.</param>
  104. <param name="weightName">The name of the specified WeightFieldInfo object. i.e., the <see cref="P:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D.Name">Name</see> value of a certain <see cref="T:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D">WeightFieldInfo3D</see> object of the <see cref="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.WeightFieldInfos">WeightFieldInfos</see> object specified by the TransportationAnalystSetting class.</param>
  105. <param name="isUncertainDirectionValid">Specifies whether the uncertain flow is valid. True represents it is valid. The edged that have the uncertain flow still in the analysis. If it is false, it will stop searching when meeting the uncertain flow. When the flow field is 2, it is an uncertain flow. Please refer to <see cref="M:SuperMap.Realspace.NetworkAnalyst.NetworkBuilder3D.BuildFacilityNetworkDirections(SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D,System.Int32[],System.Int32[],System.String)">BuildFacilityNetworkDirections</see> for more information.</param>
  106. <returns>Facility Analysis Result.</returns>
  107. </member>
  108. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.TraceDownFromEdge(System.Int32,System.String,System.Boolean)">
  109. <summary>
  110. According to the given arc ID, perform the tracing downstream. Namely, finding the arcs, nodes and cost of the downstream.
  111. </summary>
  112. <param name="edgeID">The specified edge ID.</param>
  113. <param name="weightName">The name of the specified WeightFieldInfo object. i.e., the <see cref="P:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D.Name">Name</see> value of a certain <see cref="T:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D">WeightFieldInfo3D</see> object of the <see cref="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.WeightFieldInfos">WeightFieldInfos</see> object specified by the TransportationAnalystSetting class.</param>
  114. <param name="isUncertainDirectionValid">Specifies whether the uncertain flow is valid. True represents it is valid. The edged that have the uncertain flow still in the analysis. If it is false, it will stop searching when meeting the uncertain flow. When the flow field is 2, it is an uncertain flow. Please refer to <see cref="M:SuperMap.Realspace.NetworkAnalyst.NetworkBuilder3D.BuildFacilityNetworkDirections(SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D,System.Int32[],System.Int32[],System.String)">BuildFacilityNetworkDirections</see> for more information.</param>
  115. <returns>Facility Analysis Result.</returns>
  116. </member>
  117. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.TraceDownFromNode(System.Int32,System.String,System.Boolean)">
  118. <summary>
  119. According to the given node ID, perform the tracing downstream. Namely, finding the arcs, nodes and cost of the downstream.
  120. </summary>
  121. <param name="nodeID">The specified Node ID.</param>
  122. <param name="weightName">The name of the specified WeightFieldInfo object. i.e., the <see cref="P:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D.Name">Name</see> value of a certain <see cref="T:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D">WeightFieldInfo3D</see> object of the <see cref="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.WeightFieldInfos">WeightFieldInfos</see> object specified by the TransportationAnalystSetting class.</param>
  123. <param name="isUncertainDirectionValid">Specifies whether the uncertain flow is valid. True represents it is valid. The edged that have the uncertain flow still in the analysis. If it is false, it will stop searching when meeting the uncertain flow. When the flow field is 2, it is an uncertain flow. Please refer to <see cref="M:SuperMap.Realspace.NetworkAnalyst.NetworkBuilder3D.BuildFacilityNetworkDirections(SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D,System.Int32[],System.Int32[],System.String)">BuildFacilityNetworkDirections</see> for more information.</param>
  124. <returns>Facility Analysis Result.</returns>
  125. </member>
  126. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.FindCriticalFacilitiesUpFromEdge(System.Int32[],System.Int32,System.Boolean)">
  127. <summary>
  128. Crucial facility analysis in upstream, i.e., finding the crucial facility nodes in the upstream of the given edge, and returning the crucial node ID array and it edge Id array of downstream.
  129. </summary>
  130. <param name="sourceNodeIDs">The specified facility node ID array which can not be null.</param>
  131. <param name="edgeID">The specified analysis arc ID.</param>
  132. <param name="isUncertainDirectionValid">Specifies whether the uncertain flow is valid. True represents it is valid. The edged that have the uncertain flow still in the analysis. If it is false, it will stop searching when meeting the uncertain flow. When the flow field is 2, it is an uncertain flow. Please refer to <see cref="M:SuperMap.Realspace.NetworkAnalyst.NetworkBuilder3D.BuildFacilityNetworkDirections(SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D,System.Int32[],System.Int32[],System.String)">BuildFacilityNetworkDirections</see> for more information.</param>
  133. <returns>The facility analysis result. Returns null if it doesn't search the crucial facility node.</returns>
  134. </member>
  135. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.FindCriticalFacilitiesUpFromNode(System.Int32[],System.Int32,System.Boolean)">
  136. <summary>
  137. Crucial facility analysis in upstream, i.e., finding the crucial facility nodes in the upstream of the given node, and returning the crucial node ID array and it edge Id array of downstream.
  138. </summary>
  139. <param name="sourceNodeIDs">The specified facility node ID array which can not be null.</param>
  140. <param name="nodeID">The specified analysis node ID.</param>
  141. <param name="isUncertainDirectionValid">Specifies whether the uncertain flow is valid. True represents it is valid. The edged that have the uncertain flow still in the analysis. If it is false, it will stop searching when meeting the uncertain flow. When the flow field is 2, it is an uncertain flow. Please refer to <see cref="M:SuperMap.Realspace.NetworkAnalyst.NetworkBuilder3D.BuildFacilityNetworkDirections(SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D,System.Int32[],System.Int32[],System.String)">BuildFacilityNetworkDirections</see> for more information.</param>
  142. <returns>The facility analysis result. Returns null if it doesn't search the crucial facility node.</returns>
  143. </member>
  144. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.FindCriticalFacilitiesDownFromEdge(System.Int32[],System.Int32,System.Boolean)">
  145. <summary>
  146. Crucial facility analysis in upstream, i.e., finding the crucial facility nodes in the upstream of the given edge, and returning the crucial node ID array and it edge Id array of downstream.
  147. </summary>
  148. <param name="sourceNodeIDs">The specified facility node ID array which can not be null.</param>
  149. <param name="edgeID">The specified analysis arc ID.</param>
  150. <param name="isUncertainDirectionValid">Specifies whether the uncertain flow is valid. True represents it is valid. The edged that have the uncertain flow still in the analysis. If it is false, it will stop searching when meeting the uncertain flow. When the flow field is 2, it is an uncertain flow. Please refer to <see cref="M:SuperMap.Realspace.NetworkAnalyst.NetworkBuilder3D.BuildFacilityNetworkDirections(SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D,System.Int32[],System.Int32[],System.String)">BuildFacilityNetworkDirections</see> for more information.</param>
  151. <returns>The facility analysis result. Returns null if it doesn't search the crucial facility node.</returns>
  152. </member>
  153. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.FindCriticalFacilitiesDownFromNode(System.Int32[],System.Int32,System.Boolean)">
  154. <summary>
  155. Crucial facility analysis in downstream, i.e., finding the crucial facility nodes in the downstream of the given node, and returning the crucial node ID array and it edge Id array of downstream.
  156. </summary>
  157. <param name="sourceNodeIDs">The specified facility node ID array which can not be null.</param>
  158. <param name="nodeID">The specified analysis node ID.</param>
  159. <param name="isUncertainDirectionValid">Specifies whether the uncertain flow is valid. True represents it is valid. The edged that have the uncertain flow still in the analysis. If it is false, it will stop searching when meeting the uncertain flow. When the flow field is 2, it is an uncertain flow. Please refer to <see cref="M:SuperMap.Realspace.NetworkAnalyst.NetworkBuilder3D.BuildFacilityNetworkDirections(SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D,System.Int32[],System.Int32[],System.String)">BuildFacilityNetworkDirections</see> for more information.</param>
  160. <returns>The facility analysis result. Returns null if it doesn't search the crucial facility node.</returns>
  161. </member>
  162. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.BurstAnalyseFromNode(System.Int32[],System.Int32,System.Boolean)">
  163. <summary>
  164. Two-way tube-broken analysis. Through specifying the pipe-broken node, search the nodes that affect the pipe-broken position and are affected by the pipe-broken position in the pipe-broken node upstream and downstream.
  165. </summary>
  166. <param name="sourceNodeIDs">The specified facility node ID array which can not be null.</param>
  167. <param name="nodeID">The specified analysis node ID.</param>
  168. <param name="isUncertainDirectionValid">Specifies whether the uncertain flow is valid. True represents it is valid. The edged that have the uncertain flow still in the analysis. If it is false, it will stop searching when meeting the uncertain flow. When the flow field is 2, it is an uncertain flow. Please refer to <see cref="!:NetworkBuilder.BuildFacilityNetworkDirections">BuildFacilityNetworkDirections</see> for more information.</param>
  169. <returns>The pipe-broken analysis result</returns>
  170. </member>
  171. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.BurstAnalyseFromEdge(System.Int32[],System.Int32,System.Boolean)">
  172. <summary>
  173. Two-way tube-broken analysis. Through specifying the pipe-broken edge, search the nodes that affect the pipe-broken position and are affected by the pipe-broken position in the pipe-broken edge upstream and downstream.
  174. </summary>
  175. <param name="sourceNodeIDs">The specified facility node ID array which can not be null.</param>
  176. <param name="edgeID">The specified analysis arc ID.</param>
  177. <param name="isUncertainDirectionValid">Specifies whether the uncertain flow is valid. True represents it is valid. The edged that have the uncertain flow still in the analysis. If it is false, it will stop searching when meeting the uncertain flow. When the flow field is 2, it is an uncertain flow. Please refer to <see cref="!:NetworkBuilder.BuildFacilityNetworkDirections">BuildFacilityNetworkDirections</see> for more information.</param>
  178. <returns>The pipe-broken analysis result</returns>
  179. </member>
  180. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.Dispose">
  181. <summary>
  182. Releases all resources that the object occupies.
  183. </summary>
  184. </member>
  185. <member name="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.AnalystSetting">
  186. <summary>
  187. Gets or sets the environment of the 3D facility network analysis.
  188. </summary>
  189. <value>The default value is an initialized <see cref="T:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D">FacilityAnalystSetting3D</see> object.</value>
  190. <para>Please refer to <see cref="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.FindSourceFromEdge(System.Int32,System.String,System.Boolean)">FindSourceFromEdge</see>, <see cref="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.TraceUpFromEdge(System.Int32,System.String,System.Boolean)">TraceUpFromEdge</see> and <see cref="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalyst3D.FindCriticalFacilitiesUpFromEdge(System.Int32[],System.Int32,System.Boolean)">FindCriticalFacilitiesUpFromEdge</see>.</para>
  191. </member>
  192. <member name="T:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystCheckResult3D">
  193. <summary>
  194. The FacilityAnalystCheckResult3D class provides the check result of the network dataset of the 3D facility network analysis, including the edge error information and node error information.
  195. </summary>
  196. </member>
  197. <member name="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystCheckResult3D.NodeErrorInfos">
  198. <summary>
  199. Gets the node error information. The key is the SMID of the error node, and the value is the error type. For more information about the error type, see the <see cref="M:SuperMap.Realspace.NetworkAnalyst.TransportationAnalyst3D.Check">Check</see> method of the TransportationAnalyst3D class.
  200. </summary>
  201. </member>
  202. <member name="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystCheckResult3D.ArcErrorInfos">
  203. <summary>
  204. Gets the edge error information. The key is the SMID of the edge node, and the value is the error type. For more information about the error type, see the <see cref="M:SuperMap.Realspace.NetworkAnalyst.TransportationAnalyst3D.Check">Check</see> method of the TransportationAnalyst3D class.
  205. </summary>
  206. </member>
  207. <member name="T:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystResult3D">
  208. <summary>
  209. The 3D facility network analyst class. This class is used to get the analysis results of finding source and sink, tracing upstream and downstream, crucial facility nodes, including edge ID array, result node ID array and the cost.
  210. </summary>
  211. </member>
  212. <member name="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystResult3D.Edges">
  213. <summary>
  214. Gets the edge ID array in the facility network analysis results.
  215. </summary>
  216. </member>
  217. <member name="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystResult3D.Nodes">
  218. <summary>
  219. Gets the node ID array in the facility network analysis results.
  220. </summary>
  221. </member>
  222. <member name="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystResult3D.Cost">
  223. <summary>
  224. Gets the cost in the facility network analysis results.
  225. </summary>
  226. </member>
  227. <member name="T:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D">
  228. <summary>
  229. The FacilityAnalystSetting3D class provides all the required parameters for the 3D facility network analysis, including 3D network dataset, direction field, barrier edges, barrier nodes, weight field, etc. The settings of these parameters will directly influence the final analysis result.
  230. </summary>
  231. </member>
  232. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.#ctor">
  233. <summary>
  234. Creates a new FacilityAnalystSetting3D object.
  235. </summary>
  236. </member>
  237. <member name="M:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.#ctor(SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D)">
  238. <summary>
  239. Creates a new FacilityAnalystSetting3D object which is the same with the specified FacilityAnalystSetting3D object.
  240. </summary>
  241. <param name="facilityAnalystSetting">The specifped FacilityAnalystSetting3D object.</param>
  242. </member>
  243. <member name="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.NetworkDataset">
  244. <summary>
  245. Gets or sets the 3D network dataset to be analyzed. It is required.
  246. </summary>
  247. <value>The default value is null.</value>
  248. </member>
  249. <member name="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.NodeIDField">
  250. <summary>
  251. Gets or sets the field that identifies the node ID in the 3D network dataset. The ID field identifying the network node must be set, and it supports 16-bit integer and 32-bit integer.
  252. </summary>
  253. <value>The default value is SmNodeID.</value>
  254. </member>
  255. <member name="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.EdgeIDField">
  256. <summary>
  257. Gets or sets the field that identifies the edge ID in the 3D network dataset. The ID field identifying the network edge must be set, and it supports 16-bit integer and 32-bit integer.
  258. </summary>
  259. <value>The default value is SmID.</value>
  260. </member>
  261. <member name="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.FNodeIDField">
  262. <summary>
  263. Gets or sets the field that identifies the start node ID in the 3D network dataset. The ID field identifying the start node must be correctly set, and it supports 16-bit integer and 32-bit integer.
  264. </summary>
  265. <value>The default value is SmFNode.</value>
  266. </member>
  267. <member name="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.TNodeIDField">
  268. <summary>
  269. Gets or sets the field that identifies the end node ID in the 3D network dataset. The ID field identifying the end node must be correctly set, and it supports 16-bit integer and 32-bit integer.
  270. </summary>
  271. <value>The default value is SmTNode.</value>
  272. </member>
  273. <member name="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.WeightFieldInfos">
  274. <summary>
  275. Gets or sets the WeightFieldInfos object.
  276. </summary>
  277. <value>The default value contains the WeightFieldInfos3D object of an element. The Name of the element is "Length". Both FTWeightField and TFWeightField are "SmLength".</value>
  278. </member>
  279. <member name="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.Tolerance">
  280. <summary>
  281. Gets or sets the distance tolerance from the point to the edge. The unit is meter.
  282. </summary>
  283. <value>The default value is 0.0.</value>
  284. </member>
  285. <member name="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.BarrierNodes">
  286. <summary>
  287. Gets or sets the ID list of the barrier nodes, and it is optional.
  288. </summary>
  289. <value>The default value is null.</value>
  290. </member>
  291. <member name="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.BarrierEdges">
  292. <summary>
  293. Gets or sets the ID list of the barrier nodes, and it is optional.
  294. </summary>
  295. <value>The default value is null.</value>
  296. </member>
  297. <member name="P:SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D.DirectionField">
  298. <summary>
  299. Gets or sets the direction field of the 3D network dataset. If it is not specified, the default direction value is 0 which is in the same direction with the digitization. You must set the property when creating the direction.
  300. </summary>
  301. <value>The default value is null.</value>
  302. </member>
  303. <member name="T:SuperMap.Realspace.NetworkAnalyst.NetworkBuilder3D">
  304. <summary>
  305. The NetworkBuilder3D class provides the functions such as creating the 3D network dataset and creating the flow direction for the 3D network dataset.
  306. </summary>
  307. </member>
  308. <member name="M:SuperMap.Realspace.NetworkAnalyst.NetworkBuilder3D.BuildNetwork(SuperMap.Data.DatasetVector,SuperMap.Data.DatasetVector,System.String,System.String,System.String,System.String,SuperMap.Data.Datasource,System.String)">
  309. <summary>
  310. Builds the 3D network dataset according to the 3D point/line data and the existing field that represents the topological relationship between the edges and nodes.
  311. </summary>
  312. <param name="line3D">The specified 3D line dataset to build the 3D network dataset.</param>
  313. <param name="point3D">The specified 3D point dataset to build the 3D network dataset.</param>
  314. <param name="edgeIDField">The field that denotes the edge ID in the specified line dataset. If it is null or null string, or the specified field doesn't exist, then it will automatically use SMID as the edge ID. It supports 16-bit integer and 32-bit integer.</param>
  315. <param name="fromNodeField">The field that denotes the start node ID in the specified line dataset. It supports 16-bit integer and 32-bit integer.</param>
  316. <param name="toNodeField">The field that denotes the end node ID in the specified line dataset. It supports 16-bit integer and 32-bit integer.</param>
  317. <param name="nodeIDField">The field that denotes the node ID in the specified point dataset. It supports 16-bit integer and 32-bit integer.</param>
  318. <param name="outputDatasource">Datasource for storing the output datasets.</param>
  319. <param name="networkDatasetName">The specified name of the result 3D network dataset.</param>
  320. <returns>The created 3D network dataset.</returns>
  321. <exception cref="T:System.ArgumentException">The dataset type specified by the lineDataset parameter is not Line3D, or the dataset type specified by the pointDataset parameter is not Point3D.</exception>
  322. <exception cref="T:System.ArgumentException">The field types specified by the edgeIDField, nodeIDField, fromNodeField and toNodeField parameters are not Int16 or Int32.</exception>
  323. <exception cref="T:System.ArgumentException">The field specified by the nodeIDField, fromNodeField and toNodeField parameters doesn't exist.</exception>
  324. </member>
  325. <member name="M:SuperMap.Realspace.NetworkAnalyst.NetworkBuilder3D.BuildNetwork(SuperMap.Data.DatasetVector,System.String[],SuperMap.Data.Datasource,System.String,SuperMap.Realspace.NetworkAnalyst.NetworkSplitMode3D,System.Double)">
  326. <summary>
  327. Creates the 3D network dataset by the 3D line data. It can set the saved non-system field and the split mode.
  328. </summary>
  329. <param name="line3D">The specified 3D line dataset to build the 3D network dataset.</param>
  330. <param name="lineFieldNames">The specified array to store the non-system field name of the line dataset in the output network dataset.</param>
  331. <param name="outputDatasource">The specified datasource for storing the output 3D network dataset.</param>
  332. <param name="networkDatasetName">The specified name of the result 3D network dataset.</param>
  333. <param name="networkSplitMode">The specified split mode. But note that it doesn't support the <see cref="F:SuperMap.Realspace.NetworkAnalyst.NetworkSplitMode3D.LineSplitByPoint">LineSplitByPoint</see> mode.</param>
  334. <param name="tolerance">The specified split tolerance which is used for judging whether the two lines intersect. The unit is meter. If the distance from the node of a line to the line is less than the tolerance, the point will be as a node of the network dataset.</param>
  335. <returns>The created 3D network dataset.</returns>
  336. <exception cref="T:System.ArgumentException">The type of the dataset specified by the lineDataset parameter is not Line3D.</exception>
  337. <exception cref="T:System.ArgumentException">Specified the networkSplitMode parameter as NetworkSplitMode3D.LineSplitByPoint.</exception>
  338. <exception cref="T:System.ArgumentException">The tolerance is less than 0.</exception>
  339. </member>
  340. <member name="M:SuperMap.Realspace.NetworkAnalyst.NetworkBuilder3D.BuildNetwork(SuperMap.Data.DatasetVector,SuperMap.Data.DatasetVector,System.String[],System.String[],SuperMap.Data.Datasource,System.String,SuperMap.Realspace.NetworkAnalyst.NetworkSplitMode3D,System.Double)">
  341. <summary>
  342. Creates the 3D network dataset by the 3D point data (optional) and 3D line data. It can set the saved non-system field and the split mode.
  343. </summary>
  344. <param name="line3D">The specified 3D line dataset to build the 3D network dataset.</param>
  345. <param name="point3D">The specified 3D point dataset to build the 3D network dataset. It is optional.</param>
  346. <param name="lineFieldNames">The specified array to store the non-system field name of the 3D line dataset in the output network dataset.</param>
  347. <param name="pointFieldNames">The specified array to store the non-system field name of the 3D point dataset in the output network dataset.</param>
  348. <param name="outputDatasource">The specified datasource for storing the output 3D network dataset.</param>
  349. <param name="networkDatasetName">The specified name of the result 3D network dataset.</param>
  350. <param name="networkSplitMode">The specified split mode.</param>
  351. <param name="tolerance">The specified split tolerance which is used for judging whether the points are the nodes of the network dataset. The unit is meter. If the distance from the point to the line is less than the tolerance, the point will be as a node of the network dataset.</param>
  352. <returns>The created 3D network dataset.</returns>
  353. <exception cref="T:System.ArgumentException">The dataset type specified by the lineDataset parameter is not Line3D, or the dataset type specified by the pointDataset parameter is not Point3D.</exception>
  354. <exception cref="T:System.ArgumentException">The tolerance is less than 0.</exception>
  355. </member>
  356. <member name="M:SuperMap.Realspace.NetworkAnalyst.NetworkBuilder3D.BuildFacilityNetworkDirections(SuperMap.Realspace.NetworkAnalyst.FacilityAnalystSetting3D,System.Int32[],System.Int32[],System.String)">
  357. <summary>
  358. Builds the direction for the 3D network dataset according to the locations of the specified source and sink. Only the 3D network dataset that has created the direction can perform the facility network analysis.
  359. </summary>
  360. <param name="facilityAnalystSetting">The specified FacilityAnalystSetting3D object. Note that when building the direction for the facility network, the settings of the BarrierEdges or BarrierNodes properties of the facilityAnalystSetting parameter will be invalid. The settings of the BarrierEdges and BarrierNodes are only valid in the facility analysis, irrespective of the topological structure.</param>
  361. <param name="sourceIDs">The network node ID array corresponding to the specified source. The source-node array and sink-node array cannot be simultaneously empty.</param>
  362. <param name="sinkIDs">The network node ID array corresponding to the specified sink. The source-node array and sink-node array cannot be simultaneously empty.</param>
  363. <param name="nodeTypeField">The field name of the specified node type which is the field of the network node dataset. If it doesn't exist, then you need to create this field. See note for the field value and its meaning.</param>
  364. <returns>A boolean value denotes whether the creation of the direction is successful. True if successful; otherwise, false.</returns>
  365. </member>
  366. <member name="E:SuperMap.Realspace.NetworkAnalyst.NetworkBuilder3D.Stepped">
  367. <summary>
  368. The event is trigged when the process bar is activated.
  369. </summary>
  370. </member>
  371. <member name="T:SuperMap.Realspace.NetworkAnalyst.NetworkSplitMode3D">
  372. <summary>
  373. The enumeration defines the constant of the split mode type used to create the 3D network dataset.
  374. </summary>
  375. </member>
  376. <member name="F:SuperMap.Realspace.NetworkAnalyst.NetworkSplitMode3D.None">
  377. <summary>
  378. Do not split lines.
  379. </summary>
  380. </member>
  381. <member name="F:SuperMap.Realspace.NetworkAnalyst.NetworkSplitMode3D.LineSplitByPoint">
  382. <summary>
  383. Splits the lines at the intersection of points and lines.
  384. </summary>
  385. </member>
  386. <member name="F:SuperMap.Realspace.NetworkAnalyst.NetworkSplitMode3D.LineSplitByPointAndLine">
  387. <summary>
  388. Splits the lines at the intersection of lines and splits the lines at the intersection of points and lines.
  389. </summary>
  390. </member>
  391. <member name="T:SuperMap.Realspace.NetworkAnalyst.TransportationAnalyst3D">
  392. <summary>
  393. The TransportationAnalyst3D class is used to provide the transportation analyst function based on the 3D network dataset. Currently, it only supports the optimal path analysis.
  394. </summary>
  395. </member>
  396. <member name="M:SuperMap.Realspace.NetworkAnalyst.TransportationAnalyst3D.#ctor">
  397. <summary>
  398. Constructs a new TransportationAnalyst3D object.
  399. </summary>
  400. <value>The default value is an initialized <see cref="T:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D">TransportationAnalystSetting3D</see> object.</value>
  401. </member>
  402. <member name="M:SuperMap.Realspace.NetworkAnalyst.TransportationAnalyst3D.Load">
  403. <summary>
  404. Loads the network model according to the TransportationAnalyst3D settings.
  405. </summary>
  406. <returns>A boolean value denotes whether the network model loads successfully or not. True if successful; otherwise, false.</returns>
  407. </member>
  408. <member name="M:SuperMap.Realspace.NetworkAnalyst.TransportationAnalyst3D.Check">
  409. <summary>
  410. Checks the data for the 3D transportation network dataset, and returns the results object of the Check class.
  411. </summary>
  412. <returns>The data check result of the 3D transportation network analysis.</returns>
  413. </member>
  414. <member name="M:SuperMap.Realspace.NetworkAnalyst.TransportationAnalyst3D.FindPath(SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D)">
  415. <summary>
  416. Optimal path analysis.
  417. </summary>
  418. <param name="parameter">The specified environmental settings of the 3D transportation network analysis.</param>
  419. <returns>The results of the 3D transportation network analysis.</returns>
  420. </member>
  421. <member name="M:SuperMap.Realspace.NetworkAnalyst.TransportationAnalyst3D.Dispose">
  422. <summary>
  423. Disposes the resources occupied by the TransportationAnalyst object.
  424. </summary>
  425. </member>
  426. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalyst3D.AnalystSetting">
  427. <summary>
  428. Gets or sets the 3D transportation network analysis environment.
  429. </summary>
  430. </member>
  431. <member name="T:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystCheckResult3D">
  432. <summary>
  433. The TransportationAnalystCheckResult3D class provides the check result of the network dataset of the 3D facility network analysis, including the edge error information and node error information.
  434. </summary>
  435. </member>
  436. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystCheckResult3D.NodeErrorInfos">
  437. <summary>
  438. Gets the node error information. The key is the SMID of the error node, and the value is the error type. For more information about the error type, see the <see cref="M:SuperMap.Realspace.NetworkAnalyst.TransportationAnalyst3D.Check">Check</see> method of the TransportationAnalyst3D class.
  439. </summary>
  440. </member>
  441. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystCheckResult3D.ArcErrorInfos">
  442. <summary>
  443. Gets the edge error information. The key is the SMID of the edge node, and the value is the error type. For more information about the error type, see the <see cref="M:SuperMap.Realspace.NetworkAnalyst.TransportationAnalyst3D.Check">Check</see> method of the TransportationAnalyst3D class.
  444. </summary>
  445. </member>
  446. <member name="T:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D">
  447. <summary>
  448. The TransportationAnalystParameter3D class is used to set all the parameters of the 3D transportation network analysis, such as the nodes (or arbitrary points) dataset passed by the analysis, weight information, obstacle points/edges, whether the analysis results contain the analyzed nodes/edges dataset and the route objects, etc.
  449. </summary>
  450. </member>
  451. <member name="M:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.#ctor">
  452. <summary>
  453. Constructs a new TransportationAnalystParameter3D object.
  454. </summary>
  455. </member>
  456. <member name="M:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.#ctor(SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D)">
  457. <summary>
  458. Initializes a new instance of the TransportationAnalystParameter3D class which is identical with the specified TransportationAnalystParameter3D.
  459. </summary>
  460. <param name="transportationAnalystParameter">The specified TransportationAnalystParameter3D object.</param>
  461. </member>
  462. <member name="M:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.Dispose">
  463. <summary>
  464. Disposes the resources occupied by TransportationAnalystParameter3D.
  465. </summary>
  466. </member>
  467. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.WeightName">
  468. <summary>
  469. Gets or sets the name of the Weight field information. It is the Name value of a certain WeightFieldInfos3D object in the TransportationAnalystSetting3D class. The default value is the Name value of the first WeightFieldInfo3D object if you don't set it in the analysis.
  470. </summary>
  471. <value>The default is a null string.</value>
  472. </member>
  473. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.Nodes">
  474. <summary>
  475. Sets the node ID dataset passed by the analysis. It is required, but it is exclusive with the <see cref="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.Points">Points</see> property. If you set them at the same time, only the last set before the analysis is valid. For example, firstly you specify the nodes data and then the coordinates dataset, then it will only analyze the coordinate points.
  476. </summary>
  477. <value>The default value is null.</value>
  478. </member>
  479. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.Points">
  480. <summary>
  481. Gets or sets the points dataset passed by the analysis. It is required, but it is exclusive with the <see cref="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.Nodes">Points</see> property. If you set them at the same time, only the last set before the analysis is valid. For example, firstly you specify the nodes data and then the coordinates dataset, then it will only analyze the coordinate points.
  482. </summary>
  483. <value>The default value is null.</value>
  484. </member>
  485. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.BarrierNodes">
  486. <summary>
  487. Gets or sets the ID list of the obstacle nodes. It is optional. The specified obstacle nodes here and the obstacle nodes specified by <see cref="T:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D">TransportationAnalystSetting3D</see> will be used together in the 3D transportation network analysis.
  488. </summary>
  489. <value>The default value is null.</value>
  490. </member>
  491. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.BarrierEdges">
  492. <summary>
  493. Gets or sets the ID list of the obstacle edges. It is optional. The specified obstacle edges here and the obstacle edges specified by <see cref="T:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D">TransportationAnalystSetting3D</see> will be used together in the 3D transportation network analysis.
  494. </summary>
  495. <value>The default value is null.</value>
  496. </member>
  497. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.BarrierPoints">
  498. <summary>
  499. Gets or sets the coordinate list of the obstacle points. It is optional. The specified obstacle point may not be on the network (neither on the edge nor on the node), then the obstacle point will be classified to the closest network according to the distance tolerance (<see cref="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.Tolerance">Tolerance</see>).
  500. </summary>
  501. <value>The default value is null.</value>
  502. </member>
  503. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.IsNodesReturn">
  504. <summary>
  505. Gets or sets whether to keep the passed nodes in the analysis result. If true, after the analysis is successful, you will get the passed nodes from the <see cref="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystResult3D.Nodes">Nodes</see> property of the <see cref="T:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystResult3D">TransportationAnalystResult3D</see> object; and if false, you will get a null array.
  506. </summary>
  507. <value>The default value is false.</value>
  508. </member>
  509. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.IsEdgesReturn">
  510. <summary>
  511. Gets or sets whether to keep the passed edges in the analysis result. If true, after the analysis is successful, you will get the passed edges from the <see cref="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystResult3D.Edges">Edges</see> property of the <see cref="T:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystResult3D">TransportationAnalystResult3D</see> object; and if false, you will get a null array.
  512. </summary>
  513. <value>The default value is false.</value>
  514. </member>
  515. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.IsRoutesReturn">
  516. <summary>
  517. Gets or sets whether to keep the route objects (<see cref="T:SuperMap.Data.GeoLineM">GeoLineM</see>) in the analysis result. If true, after the analysis is successful, you will get the route dataset from the <see cref="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystResult3D.Routes">Routes</see> property of the <see cref="T:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystResult3D">TransportationAnalystResult3D</see> object; and if false, you will get a null array.
  518. </summary>
  519. <value>The default value is false.</value>
  520. </member>
  521. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.IsStopIndexesReturn">
  522. <summary>
  523. Gets or sets whether to keep the stop-index dataset in the analysis result. If true, after the analysis is successful, you will get the stop-index dataset from the <see cref="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystResult3D.StopIndexes">StopIndexes</see> property of the <see cref="T:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystResult3D">TransportationAnalystResult3D</see> object; and if false, you will get a null array.
  524. </summary>
  525. <value>The default value is false.</value>
  526. </member>
  527. <member name="T:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystResult3D">
  528. <summary>
  529. The TransportationAnalystResult3D class is used to get the results of various 3D transportation network analyses, including the route dataset, the node/edge ID dataset, the stop ID dataset, the weight dataset, the cost of each stop, etc.
  530. </summary>
  531. </member>
  532. <member name="M:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystResult3D.Dispose">
  533. <summary>
  534. Releases the resources occupied by TransportationAnalystResult3D.
  535. </summary>
  536. </member>
  537. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystResult3D.Routes">
  538. <summary>
  539. Gets the route dataset of the analysis result that is the dataset of the <see cref="T:SuperMap.Data.GeoLine3D">GeoLine3D</see> object. Note: The <see cref="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.IsRoutesReturn"> IsRoutesReturn</see> property of the <see cref="T:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D">TransportationAnalystParameter3D</see> class must be set as true so that the analysis results can contain the route dataset; otherwise, it is a null array.
  540. </summary>
  541. </member>
  542. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystResult3D.Nodes">
  543. <summary>
  544. Gets the nodes dataset of the analysis result. Note: The <see cref="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.IsNodesReturn">IsNodesReturn</see> property of the <see cref="T:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D">TransportationAnalystParameter3D</see> object must be set as true so that the analysis results can contain the nodes dataset; otherwise, it is a null array.
  545. </summary>
  546. </member>
  547. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystResult3D.Edges">
  548. <summary>
  549. Gets the edges dataset of the analysis result. Note: The <see cref="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.IsEdgesReturn">IsEdgesReturn</see> property of the <see cref="T:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D">TransportationAnalystParameter3D</see> object must be set as true so that the analysis results can contain the edges dataset; otherwise, it is a null array.
  550. </summary>
  551. </member>
  552. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystResult3D.StopIndexes">
  553. <summary>
  554. Gets the two-dimensional array of the stop indexes which reflects the order of the stops after analysis. Note: The <see cref="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.IsStopIndexesReturn">IsStopIndexesReturn</see> property of the <see cref="T:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D">TransportationAnalystParameter3D</see> object must be set as true so that the analysis results can contain the stop-index dataset; otherwise, it is a null array.
  555. </summary>
  556. </member>
  557. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystResult3D.Weights">
  558. <summary>
  559. Gets the weight array represented the cost. It has the same unit with the weight field of the <see cref="T:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D">WeightFieldInfo3D</see> object specified the <see cref="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.WeightName">WeightName</see> property of the <see cref="T:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D">TransportationAnalystParameter3D</see> object.
  560. </summary>
  561. </member>
  562. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystResult3D.StopWeights">
  563. <summary>
  564. Gets the values of the weights passed by the analysis. It has the same unit with the weight field of the <see cref="T:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D">WeightFieldInfo3D</see> object specified the <see cref="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.WeightName">WeightName</see> property of the <see cref="T:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D">TransportationAnalystParameter3D</see> object.
  565. </summary>
  566. </member>
  567. <member name="T:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D">
  568. <summary>
  569. The TransportationAnalystSetting3D class provides all the required parameters for the 3D transportation network analysis, including 3D network dataset, barrier edges, barrier nodes, weight field, etc. The settings of these parameters will directly influence the final analysis result.
  570. </summary>
  571. </member>
  572. <member name="M:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.#ctor">
  573. <summary>
  574. Constructs a new TransportationAnalystSetting3D object.
  575. </summary>
  576. </member>
  577. <member name="M:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.#ctor(SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D)">
  578. <summary>
  579. Constructs a new object identical to the given TransportationAnalystSetting3D object.
  580. </summary>
  581. <param name="transportationAnalystSetting">The specified TransportationAnalystSetting3D object.</param>
  582. </member>
  583. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.NetworkDataset">
  584. <summary>
  585. Gets or sets the 3D network dataset to be analyzed. It is required.
  586. </summary>
  587. <value>The default value is null.</value>
  588. </member>
  589. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.NodeIDField">
  590. <summary>
  591. Gets or sets the field that identifies the node ID in the 3D network dataset. The ID field identifying the network node must be set, and it supports 16-bit integer and 32-bit integer.
  592. </summary>
  593. <value>The default value is SmNodeID.</value>
  594. </member>
  595. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.EdgeIDField">
  596. <summary>
  597. Gets or sets the field that identifies the edge ID in the 3D network dataset. The ID field identifying the network edge must be set, and it supports 16-bit integer and 32-bit integer.
  598. </summary>
  599. <value>The default value is SmEdgeID.</value>
  600. </member>
  601. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.FNodeIDField">
  602. <summary>
  603. Gets or sets the field that identifies the start node ID in the 3D network dataset. The ID field identifying the start node must be correctly set, and it supports 16-bit integer and 32-bit integer.
  604. </summary>
  605. <value>The default value is SmFNode.</value>
  606. </member>
  607. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.TNodeIDField">
  608. <summary>
  609. Gets or sets the field that identifies the end node ID in the 3D network dataset. The ID field identifying the end node must be correctly set, and it supports 16-bit integer and 32-bit integer.
  610. </summary>
  611. <value>The default value is SmTNode.</value>
  612. </member>
  613. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.WeightFieldInfos">
  614. <summary>
  615. Gets or sets the WeightFieldInfos object.
  616. </summary>
  617. <value>The default value contains the WeightFieldInfos3D object of an element. The Name of the element is "Length". Both FTWeightField and TFWeightField are "SmLength".</value>
  618. </member>
  619. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.Tolerance">
  620. <summary>
  621. Gets or sets the distance tolerance from the point to the edge. The unit is meter. Note: When using the coordinate point mode (<see cref="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.Points">Points</see>, i.e., the specified analysis point is the coordinate point ID, not the node ID) or the specified barrier coordinate point (<see cref="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystParameter3D.BarrierPoints">BarrierPoints</see>) in the analysis, you need to set an appropriate distance tolerance to avoid the incorrect analysis result due to that the selected analysis points or barrier points can not be adjusted into the network.
  622. </summary>
  623. <value>The default value is 0.0.</value>
  624. </member>
  625. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.BarrierNodes">
  626. <summary>
  627. Gets or sets the ID list of the barrier nodes, and it is optional.
  628. </summary>
  629. <value>The default value is null.</value>
  630. </member>
  631. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.BarrierEdges">
  632. <summary>
  633. Gets or sets the ID list of the barrier nodes, and it is optional.
  634. </summary>
  635. <value>The default value is null.</value>
  636. </member>
  637. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.NodeNameField">
  638. <summary>
  639. Gets or sets the field of the node name. It is optional.
  640. </summary>
  641. <value>The default is a null string.</value>
  642. </member>
  643. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.EdgeNameField">
  644. <summary>
  645. Gets or sets the field of the edge name. It is optional.
  646. </summary>
  647. <value>The default is a null string.</value>
  648. </member>
  649. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.RuleField">
  650. <summary>
  651. Gets or sets the traffic rule field of the network edge in the network dataset. The field type must be text. It is optional.
  652. </summary>
  653. <value>The default is a null string.</value>
  654. </member>
  655. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.FTSingleWayRuleValues">
  656. <summary>
  657. Gets or sets the string array which represents the from-to oneway line. It is optional.
  658. </summary>
  659. <value>The default value is null.</value>
  660. </member>
  661. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.TFSingleWayRuleValues">
  662. <summary>
  663. Gets or sets the string array which represents the to-from oneway line. It is optional.
  664. </summary>
  665. <value>The default value is null.</value>
  666. </member>
  667. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.ProhibitedWayRuleValues">
  668. <summary>
  669. Gets or sets the string array which represents the forbidden line. It is optional.
  670. </summary>
  671. <value>The default value is null.</value>
  672. </member>
  673. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.TwoWayRuleValues">
  674. <summary>
  675. Gets or sets the string array which represents the two-way traffic line. It is optional.
  676. </summary>
  677. <value>The default value is null.</value>
  678. </member>
  679. <member name="P:SuperMap.Realspace.NetworkAnalyst.TransportationAnalystSetting3D.EdgeFilter">
  680. <summary>
  681. Gets or sets the edge filter expression. It is optional.
  682. </summary>
  683. <value>The default value is String.Empty.</value>
  684. <value>The default is a null string.</value>
  685. </member>
  686. <member name="T:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D">
  687. <summary>
  688. The WeightFieldInfo3D class is used to get or set the information of the weight field in the 3D network analysis including the FTWeightField property and TFWeightField property.
  689. </summary>
  690. </member>
  691. <member name="M:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D.#ctor">
  692. <summary>
  693. Initializes a new instance of WeightFieldInfo3D.
  694. </summary>
  695. </member>
  696. <member name="M:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D.#ctor(SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D)">
  697. <summary>
  698. Constructs a new object identical to the given WeightFieldInfo3D object.
  699. </summary>
  700. <param name="WeightFieldInfo">The specified WeightFieldInfo3D object.</param>
  701. </member>
  702. <member name="P:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D.Name">
  703. <summary>
  704. Gets or sets the name of the WeightFieldInfo object.
  705. </summary>
  706. <value>The default value is "UntitledWeightFieldInfo3D".</value>
  707. </member>
  708. <member name="P:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D.FTWeightField">
  709. <summary>
  710. Gets or sets the forward weight fields or expressions.
  711. </summary>
  712. <value>The default is a null string.</value>
  713. </member>
  714. <member name="P:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D.TFWeightField">
  715. <summary>
  716. Gets or sets the reverse weight fields or expressions.
  717. </summary>
  718. <value>The default is a null string.</value>
  719. </member>
  720. <member name="T:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfos3D">
  721. <summary>
  722. The <see cref="T:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D">WeightFieldInfo3D</see> class is the collection of the weight field information objects, which is used to manage the weight field information such as Add, Delete, getting the weight filed information of the specified name and index.
  723. </summary>
  724. </member>
  725. <member name="M:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfos3D.#ctor">
  726. <summary>
  727. Creates a new WeightFieldInfos3D object.
  728. </summary>
  729. </member>
  730. <member name="M:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfos3D.#ctor(SuperMap.Realspace.NetworkAnalyst.WeightFieldInfos3D)">
  731. <summary>
  732. Constructs a new object identical to the given WeightFieldInfos3D object.
  733. </summary>
  734. <param name="weightFieldInfos">The specified WeightFieldInfos3D object.</param>
  735. </member>
  736. <member name="M:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfos3D.Add(SuperMap.Realspace.NetworkAnalyst.WeightFieldInfo3D)">
  737. <summary>
  738. Adds the specified WeightFieldInfo object in the WeightFieldInfos object.
  739. </summary>
  740. <param name="weightFieldInfo">The specified WeightFieldInfo object.</param>
  741. <returns>Returns the index of the added object in the WeightFieldInfos3D object.</returns>
  742. </member>
  743. <member name="M:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfos3D.IndexOf(System.String)">
  744. <summary>
  745. Gets the index of the specified WeightFieldInfo3D.Name object in the WeightFieldInfos3D object.
  746. </summary>
  747. <param name="name">The name of the specified WeightFieldInfo3D object.</param>
  748. <returns>Returns the index of the WeightFieldInfo3D object that has been specified the name in the WeightFieldInfos3D object.</returns>
  749. </member>
  750. <member name="M:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfos3D.Remove(System.String)">
  751. <summary>
  752. Removes the WeightFieldInfo3D object that has been specified the name from the WeightFieldInfos3D object.
  753. </summary>
  754. <param name="name">The specified name of the WeightFieldInfo3D to be removed.</param>
  755. <returns>A boolean value denotes whether the Delete is successful. True if successful; otherwise, false.</returns>
  756. </member>
  757. <member name="M:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfos3D.Remove(System.Int32)">
  758. <summary>
  759. Removes the WeightFieldInfo3D object that has been indexed from the WeightFieldInfos3D object.
  760. </summary>
  761. <param name="index">The index of the specified WeightFieldInfo3D to be removed.</param>
  762. <returns>A boolean value denotes whether the Delete is successful. True if successful; otherwise, false.</returns>
  763. </member>
  764. <member name="M:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfos3D.Clear">
  765. <summary>
  766. Empties the WeightFieldInfo3D objects in the WeightFieldInfos3D object.
  767. </summary>
  768. </member>
  769. <member name="M:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfos3D.GetEnumerator">
  770. <summary>
  771. Returns an enumerator that can iterate through the collection.
  772. </summary>
  773. <returns>An IEnumerator object used to iterate through a collection.</returns>
  774. </member>
  775. <member name="P:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfos3D.Count">
  776. <summary>
  777. Gets the count of the elements in the WeightFieldInfos3D object.
  778. </summary>
  779. </member>
  780. <member name="P:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfos3D.Item(System.Int32)">
  781. <summary>
  782. Gets the WeightFieldInfo3D object that has been indexed from the WeightFieldInfos3D object.
  783. </summary>
  784. <param name="index">The specified index, which begins with 0.</param>
  785. <returns>The WeightFieldInfo3D object that has been specified the index.</returns>
  786. </member>
  787. <member name="P:SuperMap.Realspace.NetworkAnalyst.WeightFieldInfos3D.Item(System.String)">
  788. <summary>
  789. Gets the specified WeightFieldInfo3D.Name object in the WeightFieldInfos3D object.
  790. </summary>
  791. <param name="name">The name of the specified WeightFieldInfo3D object.</param>
  792. <returns>The WeightFieldInfo3D object that has been specified the name.</returns>
  793. </member>
  794. </members>
  795. </doc>