SuperMap.Realspace.NetworkAnalyst

The pipe-broken analysis result class. The result of pipe-broken returns the crucial facility nodes, common facility nodes and arcs.

Obtain the key facilities in the burst analysis to influence the upstream and downstream of the burst position. Key facilities include two facilities: 1. The location of the pipe in the upper part of the pipe directly affect the location of the facilities.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).

Gets the common facility nodes that are affected by the pipe-broken position.

Ordinary facilities include three types: 1. Allowed by the location of the pipe directly affected and no outflow (out of 0) facilities.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.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.

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.

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.

Creates a new FacilityAnalyst3D object.

loads the network model according to the environment parameters of the FacilityAnalystSetting3D class.

A boolean value denotes whether the network model loads successfully or not. True if successful; otherwise, false. Please refer to FindSourceFromEdge, TraceUpFromEdge and FindCriticalFacilitiesUpFromEdge.

Checks the data for the 3D facility network dataset, and returns the results object of the Check class.

The data check result of the 3D facility network analysis.

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.

The specified edge ID. The name of the specified WeightFieldInfo object. i.e., the Name value of a certain WeightFieldInfo3D object of the WeightFieldInfos object specified by the TransportationAnalystSetting class. 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 BuildFacilityNetworkDirections for more information. Facility Analysis Result.

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.

The specified Node ID. The name of the specified WeightFieldInfo object. i.e., the Name value of a certain WeightFieldInfo3D object of the WeightFieldInfos object specified by the TransportationAnalystSetting class. 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 BuildFacilityNetworkDirections for more information. Facility Analysis Result.

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.

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.

According to the given arc ID, perform the tracing upstream. Namely, finding the arcs, nodes and cost of the upstream.

According to the given node ID, perform the tracing upstream. Namely, finding the arcs, nodes and cost of the upstream.

According to the given arc ID, perform the tracing downstream. Namely, finding the arcs, nodes and cost of the downstream.

According to the given node ID, perform the tracing downstream. Namely, finding the arcs, nodes and cost of the downstream.

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.

The specified facility node ID array which can not be null. The specified analysis arc ID. 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 BuildFacilityNetworkDirections for more information. The facility analysis result. Returns null if it doesn't search the crucial facility node.

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.

The specified facility node ID array which can not be null. The specified analysis node ID. 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 BuildFacilityNetworkDirections for more information. The facility analysis result. Returns null if it doesn't search the crucial facility node.

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.

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.

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.

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.

Releases all resources that the object occupies.

Gets or sets the environment of the 3D facility network analysis.

The default value is an initialized FacilityAnalystSetting3D object. Please refer to FindSourceFromEdge, TraceUpFromEdge and FindCriticalFacilitiesUpFromEdge.

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.

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 Check method of the TransportationAnalyst3D class.

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 Check method of the TransportationAnalyst3D class.

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.

Gets the edge ID array in the facility network analysis results.

Gets the node ID array in the facility network analysis results.

Gets the cost in the facility network analysis results.

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.

Creates a new FacilityAnalystSetting3D object.

Creates a new FacilityAnalystSetting3D object which is the same with the specified FacilityAnalystSetting3D object.

The specifped FacilityAnalystSetting3D object.

Gets or sets the 3D network dataset to be analyzed. It is required.

The default value is null.

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.

The default value is SmNodeID.

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.

The default value is SmID.

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.

The default value is SmFNode.

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.

The default value is SmTNode.

Gets or sets the WeightFieldInfos object.

The default value contains the WeightFieldInfos3D object of an element. The Name of the element is "Length". Both FTWeightField and TFWeightField are "SmLength".

Gets or sets the distance tolerance from the point to the edge. The unit is meter.

The default value is 0.0.

Gets or sets the ID list of the barrier nodes, and it is optional.

The default value is null.

Gets or sets the ID list of the barrier nodes, and it is optional.

The default value is null.

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.

The default value is null.

The NetworkBuilder3D class provides the functions such as creating the 3D network dataset and creating the flow direction for the 3D network dataset.

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.

The specified 3D line dataset to build the 3D network dataset. The specified 3D point dataset to build the 3D network dataset. 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. The field that denotes the start node ID in the specified line dataset. It supports 16-bit integer and 32-bit integer. The field that denotes the end node ID in the specified line dataset. It supports 16-bit integer and 32-bit integer. The field that denotes the node ID in the specified point dataset. It supports 16-bit integer and 32-bit integer. Datasource for storing the output datasets. The specified name of the result 3D network dataset. The created 3D network dataset. The dataset type specified by the lineDataset parameter is not Line3D, or the dataset type specified by the pointDataset parameter is not Point3D. The field types specified by the edgeIDField, nodeIDField, fromNodeField and toNodeField parameters are not Int16 or Int32. The field specified by the nodeIDField, fromNodeField and toNodeField parameters doesn't exist.

Creates the 3D network dataset by the 3D line data. It can set the saved non-system field and the split mode.

The specified 3D line dataset to build the 3D network dataset. The specified array to store the non-system field name of the line dataset in the output network dataset. The specified datasource for storing the output 3D network dataset. The specified name of the result 3D network dataset. The specified split mode. But note that it doesn't support the LineSplitByPoint mode. 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. The created 3D network dataset. The type of the dataset specified by the lineDataset parameter is not Line3D. Specified the networkSplitMode parameter as NetworkSplitMode3D.LineSplitByPoint. The tolerance is less than 0.

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.

The specified 3D line dataset to build the 3D network dataset. The specified 3D point dataset to build the 3D network dataset. It is optional. The specified array to store the non-system field name of the 3D line dataset in the output network dataset. The specified array to store the non-system field name of the 3D point dataset in the output network dataset. The specified datasource for storing the output 3D network dataset. The specified name of the result 3D network dataset. The specified split mode. 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. The created 3D network dataset. The dataset type specified by the lineDataset parameter is not Line3D, or the dataset type specified by the pointDataset parameter is not Point3D. The tolerance is less than 0.

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.

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. The network node ID array corresponding to the specified source. The source-node array and sink-node array cannot be simultaneously empty. The network node ID array corresponding to the specified sink. The source-node array and sink-node array cannot be simultaneously empty. 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. A boolean value denotes whether the creation of the direction is successful. True if successful; otherwise, false.

The event is trigged when the process bar is activated.

The enumeration defines the constant of the split mode type used to create the 3D network dataset.

Do not split lines.

Splits the lines at the intersection of points and lines.

Splits the lines at the intersection of lines and splits the lines at the intersection of points and lines.

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.

Constructs a new TransportationAnalyst3D object.

The default value is an initialized TransportationAnalystSetting3D object.

Loads the network model according to the TransportationAnalyst3D settings.

A boolean value denotes whether the network model loads successfully or not. True if successful; otherwise, false.

Checks the data for the 3D transportation network dataset, and returns the results object of the Check class.

The data check result of the 3D transportation network analysis.

Optimal path analysis.

The specified environmental settings of the 3D transportation network analysis. The results of the 3D transportation network analysis.

Disposes the resources occupied by the TransportationAnalyst object.

Gets or sets the 3D transportation network analysis environment.

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.

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.

Constructs a new TransportationAnalystParameter3D object.

Initializes a new instance of the TransportationAnalystParameter3D class which is identical with the specified TransportationAnalystParameter3D.

The specified TransportationAnalystParameter3D object.

Disposes the resources occupied by TransportationAnalystParameter3D.

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.

The default is a null string.

Sets the node ID dataset passed by the analysis. It is required, but it is exclusive with the Points 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.

The default value is null.

Gets or sets the points dataset passed by the analysis. It is required, but it is exclusive with the Points 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.

The default value is null.

Gets or sets the ID list of the obstacle nodes. It is optional. The specified obstacle nodes here and the obstacle nodes specified by TransportationAnalystSetting3D will be used together in the 3D transportation network analysis.

The default value is null.

Gets or sets the ID list of the obstacle edges. It is optional. The specified obstacle edges here and the obstacle edges specified by TransportationAnalystSetting3D will be used together in the 3D transportation network analysis.

The default value is null.

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 (Tolerance).

The default value is null.

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 Nodes property of the TransportationAnalystResult3D object; and if false, you will get a null array.

The default value is false.

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 Edges property of the TransportationAnalystResult3D object; and if false, you will get a null array.

The default value is false.

Gets or sets whether to keep the route objects (GeoLineM) in the analysis result. If true, after the analysis is successful, you will get the route dataset from the Routes property of the TransportationAnalystResult3D object; and if false, you will get a null array.

The default value is false.

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 StopIndexes property of the TransportationAnalystResult3D object; and if false, you will get a null array.

The default value is false.

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.

Releases the resources occupied by TransportationAnalystResult3D.

Gets the route dataset of the analysis result that is the dataset of the GeoLine3D object. Note: The IsRoutesReturn property of the TransportationAnalystParameter3D class must be set as true so that the analysis results can contain the route dataset; otherwise, it is a null array.

Gets the nodes dataset of the analysis result. Note: The IsNodesReturn property of the TransportationAnalystParameter3D object must be set as true so that the analysis results can contain the nodes dataset; otherwise, it is a null array.

Gets the edges dataset of the analysis result. Note: The IsEdgesReturn property of the TransportationAnalystParameter3D object must be set as true so that the analysis results can contain the edges dataset; otherwise, it is a null array.

Gets the two-dimensional array of the stop indexes which reflects the order of the stops after analysis. Note: The IsStopIndexesReturn property of the TransportationAnalystParameter3D object must be set as true so that the analysis results can contain the stop-index dataset; otherwise, it is a null array.

Gets the weight array represented the cost. It has the same unit with the weight field of the WeightFieldInfo3D object specified the WeightName property of the TransportationAnalystParameter3D object.

Gets the values of the weights passed by the analysis. It has the same unit with the weight field of the WeightFieldInfo3D object specified the WeightName property of the TransportationAnalystParameter3D object.

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.

Constructs a new TransportationAnalystSetting3D object.

Constructs a new object identical to the given TransportationAnalystSetting3D object.

The specified TransportationAnalystSetting3D object.

Gets or sets the 3D network dataset to be analyzed. It is required.

The default value is null.

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.

The default value is SmNodeID.

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.

The default value is SmEdgeID.

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.

The default value is SmFNode.

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.

The default value is SmTNode.

Gets or sets the WeightFieldInfos object.

The default value contains the WeightFieldInfos3D object of an element. The Name of the element is "Length". Both FTWeightField and TFWeightField are "SmLength".

Gets or sets the distance tolerance from the point to the edge. The unit is meter. Note: When using the coordinate point mode (Points, i.e., the specified analysis point is the coordinate point ID, not the node ID) or the specified barrier coordinate point (BarrierPoints) 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.

The default value is 0.0.

Gets or sets the ID list of the barrier nodes, and it is optional.

The default value is null.

Gets or sets the ID list of the barrier nodes, and it is optional.

The default value is null.

Gets or sets the field of the node name. It is optional.

The default is a null string.

Gets or sets the field of the edge name. It is optional.

The default is a null string.

Gets or sets the traffic rule field of the network edge in the network dataset. The field type must be text. It is optional.

The default is a null string.

Gets or sets the string array which represents the from-to oneway line. It is optional.

The default value is null.

Gets or sets the string array which represents the to-from oneway line. It is optional.

The default value is null.

Gets or sets the string array which represents the forbidden line. It is optional.

The default value is null.

Gets or sets the string array which represents the two-way traffic line. It is optional.

The default value is null.

Gets or sets the edge filter expression. It is optional.

The default value is String.Empty. The default is a null string.

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.

Initializes a new instance of WeightFieldInfo3D.

Constructs a new object identical to the given WeightFieldInfo3D object.

The specified WeightFieldInfo3D object.

Gets or sets the name of the WeightFieldInfo object.

The default value is "UntitledWeightFieldInfo3D".

Gets or sets the forward weight fields or expressions.

The default is a null string.

Gets or sets the reverse weight fields or expressions.

The default is a null string.

The WeightFieldInfo3D 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.

Creates a new WeightFieldInfos3D object.

Constructs a new object identical to the given WeightFieldInfos3D object.

The specified WeightFieldInfos3D object.

Adds the specified WeightFieldInfo object in the WeightFieldInfos object.

The specified WeightFieldInfo object. Returns the index of the added object in the WeightFieldInfos3D object.

Gets the index of the specified WeightFieldInfo3D.Name object in the WeightFieldInfos3D object.

The name of the specified WeightFieldInfo3D object. Returns the index of the WeightFieldInfo3D object that has been specified the name in the WeightFieldInfos3D object.

Removes the WeightFieldInfo3D object that has been specified the name from the WeightFieldInfos3D object.

The specified name of the WeightFieldInfo3D to be removed. A boolean value denotes whether the Delete is successful. True if successful; otherwise, false.

Removes the WeightFieldInfo3D object that has been indexed from the WeightFieldInfos3D object.

The index of the specified WeightFieldInfo3D to be removed. A boolean value denotes whether the Delete is successful. True if successful; otherwise, false.

Empties the WeightFieldInfo3D objects in the WeightFieldInfos3D object.

Returns an enumerator that can iterate through the collection.

An IEnumerator object used to iterate through a collection.

Gets the count of the elements in the WeightFieldInfos3D object.

Gets the WeightFieldInfo3D object that has been indexed from the WeightFieldInfos3D object.

The specified index, which begins with 0. The WeightFieldInfo3D object that has been specified the index.

Gets the specified WeightFieldInfo3D.Name object in the WeightFieldInfos3D object.

The name of the specified WeightFieldInfo3D object. The WeightFieldInfo3D object that has been specified the name.