SuperMap.Analyst.NetworkAnalyst

This enumeration defines the analysis mode in the logical analysis.

Least cost mode.

Average cost mode.

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

Gets the critical facility points. It contains two types: 1. The facility points which affect the burst position on the upper stream.2. The facility points which are directly affected by the burst position and have outflow (that is, the outflow is greater than 0) on the downstream.

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

There are three types of common facility points: 1. The ones which are directly affected by the burst position and don't have outflow.2. All facility points A (except all critical facility points) which are directly affected by outflow arcs of each upper stream critical facility point, and A must meet the condition that there are common parts between the affected arcs from the upper stream critical facility point to A and the affected arcs of all the critical facility points. 3. The facility point A on the downstream which is directly affected by the burst position(critical facility point 2 and common facility point 1), the facility point B on upper stream of A which directly affects A (except all critical facility points), B must meet the condition that there are common parts between the affected arcs from A to B and the affected arcs of all the critical facility points.

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.

Center point information class.

Initializes a new instance of the CenterPointInfo class.

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

The specified CenterPointInfo object.

Gets or sets the center point ID.

The default value is -1.0.

Gets or sets the center point coordinates.

The default value is (0.0).

Demand point information class.

Initializes a new instance of the DemandPointInfo class.

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

The specified DemandPointInfo object.

Gets or sets the demand point ID.

The default value is -1.0.

Gets or sets the demand point coordinates.

The default value is (0.0).

Gets or sets the demand amount of the demand point.

The default value is -1.0.

Get or set the demand for the demand point. The demand can be multidimensional, and its dimensions must be the same as the vehicle load dimension and meaning.

Gets or sets the time to unload the goods, indicating the time that the vehicle needs to stay at that point.

Gets or sets the earliest time to get to the point.

Gets or sets the latest time to get to the point.

The DemandResult class. This class is used to return the related information of the demand result, including the ID of the demand node, and the ID of the supply center.

Releases all resources that the object occupies.

When IsEdge is true, it is the edge ID; when IsEdge is fales, it is the node ID.

Gets the ID of the supply center.

Gets the actual allocated resource value.

Gets whether the demand result is edge. If not, the demand result is node.

The enum defines the direction type constant, and the enum is used in the TransferGuideItem class.

No direction.

The east.

The south.

The west.

The north.

The FacilityAnalyst class is used for the facility analysis. It is a kind of network analyst. It mainly processes the connectivity analysis and the tracing analysis.

Creates a new FacilityAnalyst object.

Loads the facility network model according to the FacilityAnalystSetting settings.

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

Finds all the loops joined with the specified nodes according to the given array of the node IDs. The result is the array of the edge IDs that form the loops.

The specified array of the node IDs. The edge ID array of loops connected with the specified nodes.

Finds all the loops connected with the specified edges according to the given array of the edge IDs. The result is the array of edge IDs that form the loops.

The specified array of the edge IDs. The edge ID array of loops connected with the specified edges.

Finds all the edges connected with the specified nodes according to the given array of the node IDs. The result is the array of edge IDs.

The specified array of the node IDs. The array of the edge IDs.

Finds all the edges connected with the specified edges according to the given array of the edge IDs. The result is the array of the edge IDs.

The specified array of the edge IDs. The array of the edge IDs.

Finds all the edges unconnected with the specified nodes according to the given array of the node IDs. The result is the array of edge IDs.

The specified array of the node IDs. The array of the edge IDs.

Finds all the edges not connected with the specified edges according to the given array of the edge IDs. The result is the array of the edge IDs.

The specified array of the edge IDs. The array of the edge IDs.

Checks the loops of the network and returns the array of the edge IDs that form the loops.

Returns the array of the edge IDs that form the loops.

The find path analysis. Find the path which has the least edges between the specified start node and the end node. The loops are invalid in this analysis. Returns edges, nodes and cost of this path.

The specified start Node ID. The specified end Node ID. The name of the specified WeightFieldInfo object. i.e., the Name value of a certain WeightFieldInfo 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.

The find path analysis. Find the path which has the least edges between the specified start node and the end node. The loops are invalid in this analysis. Returns edges, nodes and cost of this path.

The specified start edge ID. The specified end edge ID. The name of the specified WeightFieldInfo object. i.e., the Name value of a certain WeightFieldInfo 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.

FindPathUpFromEdge. Finds the least cost upstream path of the specified node and returns edges, nodes and cost o the path.

The specified Node ID. The name of the specified WeightFieldInfo object. i.e., the Name value of a certain WeightFieldInfo 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. The results of transportation analysis. Returns null if the analysis is failed or no path is found.

FindPathUpFromEdge. Finds the least cost upstream path of the specified edge and returns edges, nodes and cost of the path.

The specified edge ID. The name of the specified WeightFieldInfo object. i.e., the Name value of a certain WeightFieldInfo 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. The results of transportation analysis. Returns null if the analysis is failed or no path is found.

FindPathUpFromEdge. Finds the least cost downstream path of the specified node and returns edges, nodes and cost o the path.

The find downstream path analysis. Find the path which has the least cost by tracing the downstream of the specified node. The loops are invalid in this analysis.

Finds the common upstream edges of those edges according to the given array of the edge IDs. The result is the array of the edge IDs.

The specified array of the edge IDs. 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 common upstream edges ID array of the given edge.

Finds the common upstream edges of those nodes according to the given array of the node IDs. The result is the array of edge IDs.

The specified array of the node IDs. 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 common upstream edges ID array of the given node.

Finds the common downstream edges of those edges according to the given array of the edge IDs. The result is the array of the edge IDs.

Finds the common downstream edges of those nodes according to the given array of the node IDs. The result is the array of edge IDs.

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.

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.

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 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 upstream. Namely, finding the arcs, nodes and cost of the upstream.

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

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

Two-way pipeline burst analysis. After specifying the burst point, search the nodes upstream and downstream which directly affect the burst point or are affected by the burst point.

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 pipe-broken analysis result

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.

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 pipe-broken analysis result

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

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.

Releases all resources that the object occupies.

Gets or sets the environment settings of the facility analysis.

The default value is a new established FacilityAnalystSetting object.

The FacilityAnalystResult class. This class is used to get the analysis results of finding source and sink, tracing upstream and downstream, and path query including edge ID array, result node ID array and the cost.

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

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

Gets the cost in the facility network analysis results.

This class provides all the parameter information in facility analysis. The settings of the parameters will affect the analysis result.

Initializes a new instance of the FacilityAnalystSetting class.

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

The specified FacilityAnalystSetting object.

Gets or sets the network dataset, required.

The default value is null.

Gets or sets the field that identifies the node ID in the network dataset. The ID field identify 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 arc ID in the network dataset. The ID field identify the network arc 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 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 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 WeightFieldInfos object of an element. The element Name is Length. The FTWeightField and TFWeightField are SmLength.

Gets and sets the distance tolerance from a node to an edge. The unit is the same as network dataset specified by the NetworkDataset property.

The default value is 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. 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 group analysis parameters setting class.

Constructs a new GroupAnalystParameter object.

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

The given GroupAnalystParameter object.

Releases the GroupAnalystParameter resources.

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

The default value is null.

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

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

The default value is null.

Gets or sets the turn weight field, and it is optional.

The default value is String.Empty.

Gets or sets the name of the Weight field information. It is the Name value of a certain WeightFieldInfo object of the WeightFieldInfos object in the TransportationAnalystSetting class. The default value is the Name value of the first WeightFieldInfo in the WeightFieldInfos if you don't set it in the analysis.

The default value is String.Empty.

Gets or sets the analysis mode.

The default value is LeastCost.

Gets or sets the optional centers collection, required.

The default value is null.

The result class of group analysis.

Disposes the resources occupied by the object. After calling this method, this object will not be usable.

Returns unallocated allocation points collection.

Returns the analysis result item collection.

The result item class of group analysis.

Gets the center point index of the group result.

Gets the allocation points index collection of the group result.

Gets the total cost of the group result.

Gets the route collection between allocation point to the center of the group result.

Gets the total load amount of the group result.

Allocation points information class in group analysis.

Constructs a new GroupPointInfo object.

Initializes a new instance of the TGroupPointInfo class which is a copy of the specified GroupPointInfo object.

Specific GroupPointInfo object.

Gets or sets the load amount of current allocation point.

The default value is -1.

Gets or sets the coordinates of current allocation point.

The default value is (0.0).

The LocationAnalystParameter class provides the required parameters for the location-allocation analysis including whether to allocate resources from the supply center, supply centers, the weight field name, the turn weight field, the expected number of supply centers, etc.

Initializes a new instance of the LocationAnalystParameter class.

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

Specified LocationAnalystParameter.

Releases all resources that the object occupies.

Gets or sets the collection of SupplyCenter.

The default value is a new SuppplyCenters object.

Gets or sets the number of the supply centers which will be used to build some establishments. If the parameter is set to zero, the minimal number of required supply centers will be computed to cover the whole analysis area.

The default value is 0.

Whether to analyze from the supply centers or not.

The default is False.

Gets or sets the name of the weight field information, i.e., the Name value of a certain WeightFieldInfo object of the WeightFieldInfos object specified by the TransportationAnalystSetting class.

The default value is String.Empty .

Gets or sets the turn cost field and this field must be in the collection of turn cost fields which is defined in the transportation network analysis environment settings.

The default value is String.Empty .

The LocationAnalystResult class, which is used for the result of the location-allocation.

Releases all resources that the object occupies.

Gets the array of the SupplyResult objects. For more information, please refer to the SupplyResult class.

Gets the array of the DemandResult objects. For more information, please refer to the DemandResult class.

The NetworkBuilder class. This class provides the flowing functions: building the network dataset with a line dataset or multiple line and point datasets, building facility network direction and hierarchy with the objects of the facility network analysis, etc.

Builds the dataset which represents the network model with the specified line dataset, output datasource and name of new dataset. It is outdated. Now we use BuildNetwork.

The specified line dataset. The output datasource object which stores the new network model dataset. The name of the new vector dataset which represents the network model. The vector dataset which represents the new network model dataset.

Builds the turn dataset.

The specified network dataset. The specified query parameters. Datasource for storing the output datasets. The specified name of the result dataset. Gets the turn table dataset.

Builds the network dataset according to the point/line data and the existing field that represents the topological relationship between the edges and nodes.

The specified line dataset to build the network dataset. The specified point dataset to build the 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 name of the result network dataset. The built network dataset.

builds network dataset based on line dataset. It can saves non-system string.

The specified line dataset to build the network dataset. The specified array to store the non-system field name of the line dataset in the output network dataset. Datasource for storing the output datasets. The name of the result network dataset. The built network dataset.

Builds direction for facility network dataset and writes values into the direction field. The direction field is the property set by FacilityAnalystSetting.DirectionField.

The specified FacilityAnalystSetting object. Note that when building the direction or hierarchies for facility network, the setting of the BarrierEdges or BarrierNodes properties of the facilityAnalystSetting parameter will be invalid. The setting of the BarrierEdges or BarrierNodes is only valid in the facility analysis, and irrespective of the topological structure. The source ID array. The sink ID array. The name of the specified WeightFieldInfo object. The field of node type which is source node, sink node general node, and the field is the field of node dataset in network. The field will be created automatically if it does not exist. True, if successful; otherwise, false.

Builds hierarchy for facility network dataset and writes values into the hierarchy field. The field will be created automatically if it does not exist.

The FacilityAnalystSetting object. Note that when building the direction or hierarchies for facility network, the setting of the BarrierEdges or BarrierNodes properties of the facilityAnalystSetting parameter will be invalid. The setting of the BarrierEdges or BarrierNodes is only valid in the facility analysis, and irrespective of the topological structure. The source ID array. The sink ID array. The name of the specified WeightFieldInfo object. The specified name of hierarchy field. Specifies whether the loop is valid. Returns true, if the loop is valid; false, otherwise. True, if successful; otherwise, false.

Builds the dataset which represents the network model with the specified array of the line dataset and the array of the point dataset. It is outdated, now we use BuildNetwork.

The specified array of the line dataset. The specified array of the point dataset. The specified output datasource. The specified output datasource. The specified split mode. For more information, please refer to the NetworkSplitMode class. The specified tolerance between the point and its nearest line. Returns the vector dataset which represents the new network model dataset.

Builds network dataset based on line dataset and point dataset (option). It can save non-system string and the aplit mode.

The specified line dataset array to build the network dataset. The specified point dataset array to build the network dataset, optional. The specified array to store the non-system field name of the line dataset in the output network dataset. The specified array to store the non-system field name of the point dataset in the output network dataset. Datasource for storing the output datasets. The name of the result network dataset. The specified split mode. Determines whether the point is the tolerance (i.e., the split tolerance). If the split mode is topology (i.e., NetworkSplitMode.TopologyProcessing), the value is the tolerance in the topology operations. It has the same unit with point or line datasets used to build the network dataset. The built network dataset. lineDatasets is null. The length of lineDatasets is 0. The tolerance is less than 0.

Appends data to the existing network dataset, which can be points, lines or network.

The specified network dataset to be appended. The specified data to append, which can be points, lines or network. The specified appended network dataset. The boolean value denotes whether the appending is successful. True if successful; otherwise, false.

The event is trigged when the process bar is activated.

The enum defines the split modes type constant, which is used for line-line split or point-line split.

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 topology method will firstly perform topology operations for line dataset including Clean Duplicated Lines, Extend Undershoots, Intersect Arcs, Clean Short Overshoots, Clean Redundant Vertices, Merge Adjacent Endpoints, Clean Fake Nodes, etc., and then build the network dataset.

The PathGuide class.

Gets the count of the PathGuideItem objects in the PathGuide.

Gets the PathGuideItem object according to the specified index.

The specified index which starts with 0. The path guide item object.

The path guide item class.

Gets the range of this path guide item. If this item is line (IsEdge is true), it is the enclosing rectangle. If this item is point (IsEdge is false), it is the point itself.

Gets the direction of the path guide item. It is valid only when the path guide item is line (IsEdge is true). They can be east, south, west, north.

Gets the distance from a stop to the network, and it is supported only when the path table item is the stop. The unit is in meters.

Gets the ID of the path guide item.

Gets the number of the path guide item.

Gets whether the path guide item is a line or point. If it is true, representing the line, such as the road segment, line and so on. If it is false, representing the point.

Gets whether the path guide item is a stop, or the corresponding point added to the network.

Gets the corresponding path guide line segment length when the item is line (IsEdge is true). The unit is in meters.

Gets the name of the path guide item.

Get whether the stop is left side, right side or on the road when this path guide item is stop.

When the path guide item is the point (IsEdge is false), get the nest turning angle of the point. The unit is in degrees and accurate to 0.1 degree.

When the path guide item is the point (IsEdge is false), get the nest turning direction of the point.

Gets the weight of the path guide item. The unit is the same as that of weight field information (WeightFieldInfo), which is specified by the WeightName attribute of the TransportationAnalystParameter object.

Gets the corresponding path guide line segment when the item is line (IsEdge is true).

The ServiceAreaResult class. It is Inherited from the TransportationAnalystResult class.

The TransportationAnalystResult class. Through this class you can get the Route set, node ID set, edge set, path table set, stop ID set, weight set or cost of each stop. Using these settings, you can get the analysis result of the optimal path, traveling salesmen, logistics and closest facility.

Releases the resources.

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 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 path guides. Note: The IsPathGuidesReturn property of the TransportationAnalystParameter object must be set as true so that the analysis results can contain the path guides; otherwise, it is a null array.

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

Gets the 2D array of the stop indexes which reflects the order of the stops after analysis. Note: The IsStopIndexesReturn property of the TransportationAnalystParameter 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 cost (weight) between the stops after sorting the stops according to the index. It has the same unit with the weight field of the WeightFieldInfo object specified the WeightName property of the TransportationAnalystParameter object.

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

Gets the set of the service region objects.

Gets the route count array of each service region in the ServiceAreaResult class. The order of the array element is identical to the specified order of the center points.

It is not supported in this class.

Gets the cost of each service region from the service area analysis result. It has the same unit with the weight field of the WeightFieldInfo object that is specified by the WeightName property of the TransportationAnalystParameter object.

This enumeration defines the service area type in service area analysis.

Simple service area.

Complex service area.

The SideType class. Specifies a constant that defines the road side. Three types are provided, they are on the middle of the road, on the left side of the road, on the right side of the road.

On the left side of the road.

On the road.

The right of the road.

The invalid value.

The SupplyCenter class stores the supply center information in the location-allocation analysis (FindLocation) including Supply Center ID, MaxWeight and Type.

Creates a new instance of the SupplyCenter.

Initializes a new instance according to the specified SupplyCenter object.

The specified SupplyCenter objects.

Gets or sets the type of SupplyCenter.See the type of SupplyCenter in SupplyCenterType class.

The default value is Null.

Gets or sets the ID of SupplyCenter.

The default value is -1.

Gets or sets the maximum cost (impedance) of the supply center. It has the same unit with the weight field of the WeightFieldInfo object that is specified by the WeightName property of the LocationAnalystParameter object.

The default value is 0.

The resource supply center collection class. This class is the collection of the SupplyCenter. This class provides the methods of adding and removing the SupplyCenter objects, and also provides the method of converting the SupplyCenters object to a SupplyCenter array. You can get the count of the SupplyCenter objects, and get or set the SupplyCenter object with the specified index through this class.

Creates a new instance of the SupplyCenters.

Initializes a new instance according to the specified SupplyCenters object.

The specified SupplyCenters objects.

Adds the SupplyCenter object to this SupplyCenters object. Return the index of the newly added object if added successfully.

The SupplyCenter object to be added. The index of the object to be added.

Adds the SupplyCenter objects to the SupplyCenters in the form of an array. Return the count of the newly added SupplyCenter objects if added successfully.

The SupplyCenter objects to be added. The count of the added SupplyCenter objects.

Removes the SupplyCenter object with the specified index.

The specified index. true if it is removed successfully; false otherwise.

Removes the specified count of the SupplyCenter objects starting from the specified index.

The specified index. The count of the SupplyCenter objects to be removed. The count of the object deleted successfully.

Clears all the objects in the SupplyCenters.

Converts the current SupplyCenters object to a SupplyCenter array.

The array of the SupplyCenter objects.

Returns an enumerator that can iterate through the collection.

Returns an enumerator that iterates through a collection.

Gets the count of the SupplyCenters object.

Gets or sets the specified index of the SupplyCenter object from the SupplyCenters.

Defines the types of supply centers,which are used in locations analysis.

Non Center, doesn't take into consideration in location analysis.

OPTIONALCENTER, which is used for location analysis.

FIXEDCENTER, which is used for location analysis.

Gets the result of resource supply,including type,ID,maximum impedance and so on.

Releases all resources that the object occupies.

Gets the type of the supply center.

Gets the ID of the supply center.

Gets the maximum cost (impedance) of the supply center. It has the same unit with the weight field of the WeightFieldInfo object that is specified by the WeightName property of the LocationAnalystParameter object.

Gets the total cost. It has the same unit with the weight field of the WeightFieldInfo object that is specified by the WeightName property of the LocationAnalystParameter object.

Gets the count of demand points that the supply center serves for.

Gets the average cost, i.e., the total cost is divided by the number of the demand nodes. It has the same unit with the weight field of the WeightFieldInfo object that is specified by the WeightName property of the LocationAnalystParameter object.

The transportation analyst class. This class is used to provide the path analysis, traveling salesmen analysis, service area analysis, logistics analysis, closest facility and location-allocation analysis, etc.

Initializes a new instance of the TransportationAnalyst class.

Checks the network dataset and turn table, which is out of date. You can replace it by Check.

Stores errors of the network dataset. Stores errors of the turn table dataset. True, if successful; false, otherwise.

Checks the transportation network dataset and the turn table, and return the result object.

The result.

Conducts the closest facility analysis according to the given parameters, and the event point is the coordinate point.

The TransportationAnalystParameter object. The coordinate of the event. The count of the facilities. Whether to search from the events to the facilities. Searching radius. The unit is the same as the weight filed set in the NetworkAnalystSetting class. If searching the whole network, this value is set 0. The TransportationAnalystResult object.

Closest Facility Analysis

Conducts the closest facility analysis according to the given parameters, and the event point is the node ID.

The TransportationAnalystParameter object. The ID of the event. The count of the facilities. Whether to search from the events to the facilities. Searching radius. The unit is the same as the weight filed set in the NetworkAnalystSetting class. If searching the whole network, this value is set 0. The TransportationAnalystResult object.

Optimal path analysis.

The TransportationAnalystParameter object. Whether have the least edges or not. True indicates the result path has the least edges. In this case, the result path may not be the shortest path as the number of the edges is not equal to the length of the edge. Takes the following illustration as an example, there are two paths connected AB and the number of edges in the green path is less than the yellow one. If this parameter is set to true, the result path is the green one; and the result path is the yellow one if this parameter is set to false. The TransportationAnalystResult object.

Analyzes the Service area with specified parameters.

The TransportationAnalystParameter object. The radius array of the service area. The length of the array should be consistent with the number of the specified service center points. The radius has the same unit with the from-to weight field and the to-from weight field of the specified weight information. Whether analyzing from the centers. Whether to perform the mutually exclusive process. Yes if True; no if false. The ServiceAreaResult object.

The travelling salesmen analysis.

The TransportationAnalystParameter object. Whether to specify the end node. Yes if true when the last node in the nodes set is the end node; no if false. The TransportationAnalystResult object.

Loads the network model.

True if successful; otherwise, false.

This method is used to update the edge weight filed with specified parameters.

The ID of the edge to be updated. The start node ID of the refreshed edge. The end node ID of the refreshed edge. The name of the updated weight field. It is the value of the Name property of the WeightFieldInfo object of the WeightFieldInfos object in the TransportationAnalystSetting class. The weight is used to update the old value. It has the same unit with the weight field specified by the weightName property. Returns the weight value before updating if successful; otherwise returns Double.MinValue.

This method is used to update the weight value of turn node with specified paramters.

The ID of the turn node to be updated. The start node ID of the refreshed edge. The end node ID of the refreshed edge. The name of the turn weight filed. The weight is used to update the old value. It has the same unit with the turn weight field specified by the turnWeightField property. Returns the weight value before updating if successful; otherwise returns the minimum value of the Double datatype.

The method is used for the MTSP (logistics) which the delivery centers are the node ID array.

The TransportationAnalystParameter object. The ID array of delivery center nodes in network. Whether to use the minimal total cost schema. There are two schemas can be selected in performing Logistics. One is the minimal total cost, in this case, it is possible that some delivery centers may cost more and others cost less. Another is the optimal in each delivery center, but the total cost may not be the minimum. The TransportationAnalystResult object.

The method is used to analyze Multiple TSP which the delivery center points are a series of coordinates.

The TransportationAnalystParameter object. A series of coordinates of delivery center points, which type is Point2Ds. Whether to use the minimal total cost schema. There are two schemas can be selected in performing Logistics. One is the minimal total cost, in this case, it is possible that some delivery centers may cost more and others cost less. Another is the optimal in each delivery center, but the total cost may not be the minimum. The TransportationAnalystResult object.

The Multiple TSP analysis.

Analyzes the location with the specified LocationAnalystParameter object.

The specified location-allocation parameter object. The LocationResult object.

Calculates the cost matrix of the specified point. The matrix is a 2D double array used to store the least cost between any two points.

The specified TransportationAnalystParameter object. Returns a matrix which contains the weight information between every two points or nodes.

Loads the memory file.

The memory file path. The network dataset to use. A bool value, whether to load network model.

Creates the memory file.

Creates the path of the memory file. A boolean, indicates whether the memory file is generated successfully.

Logistics analysis.

Logistics analysis parameter object. The array of the vehicle information. The array of center point information. The array of demand point information. the Path object.

Key node query

Analysis start point. Analyze end point. Crucial node ID array.

Critical edge query.

Analysis start point. Analyze end point. Critical edge ID array.

Resource allocation analysis.

The LocationAnalystParameter object. The resource allocation analysis result object.

Group analysis.

the group analysis parameter object. Allocation points information collection in group analysis. Maximum cost. Maximum load amount. The result object of group analysis.

Releases the resources.

Gets or sets the TransportationAnalystSetting object.

The default value is a non-null TransportationAnalystSetting object

The event is trigged when the process bar is activated.

The TransportationAnalystCheckResult class provides the check result of the network dataset and turn table of the transportation analysis, including the arc error information, node error information and turn table 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 TransportationAnalyst class.

Gets the edge error information. The key is the SMID of the error edge, and the value is the error type. For more information about the error type, see the Check method of the TransportationAnalyst class.

Gets the edge error information. The key is the SMID of the error turn, and the value is the error type. For more information about the error type, see the Check method of the TransportationAnalyst class.

Gets the array of the edge IDs passed by the result path of the facility path analysis.

Initializes a new instance of the TransportationAnalystParameter class.

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

The specified TransportationAnalystParameter object.

Releases the resources.

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

The default value is null.

Gets or sets the coordinate list of the barrier nodes. 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). Currently it supports Optimal Path Analysis, Find Closest Facility, TSP and MTSP.

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

The default value is null.

Gets or sets whether to keep the passed edges in the analysis result. If true, after the analysis is successful, you will get a array of the passed edges from the Edges property of the TransportationAnalystResult object; and if false, you will get a null array.

The default value is false.

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 TransportationAnalystResult object; and if false, you will get a null array.

The default value is false.

Gets or sets whether to keep the path guides in the analysis results. If true, after the analysis is successful, you will get the path guides from the PathGuides property of the TransportationAnalystResult 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 TransportationAnalystResult 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 TransportationAnalystResult object; and if false, you will get a null array.

The default value is false.

Gets or 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 turn weight field, and it is optional.

The default value is String.Empty.

Gets or sets the forbidden condition of the U type road. It's designed for the neighboring three arcs. It means that the result route cannot pass the three arcs in order. It is a two dimensional array, where the first dimension means how many groups of limitations it has, the second dimension means the forbidden arc ID of each group(Note: The forbidden arc ID amount of each group must be 3, otherwise it is invalid). IDs of the three arcs should be adjacent.

Gets or sets the service area type. This setting is used in service area analysis, according to different types of service area to construct different service area. The default value is ServiceType. SimpleArea.

Traffic network analysis environment setting class. This class is used to provide all the parameter information required for traffic network analysis. The traffic network analysis environment sets the parameters of the various parameters of the set of the direct impact analysis results.

Initializes a new instance of the TransportationAnalystSetting class.

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

The specified TransportationAnalystSetting object.

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 that identifies the edge ID in the network dataset. The ID field identify 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 of the edge name. It is optional. Note, if not set it, even you set the IsPathGuidesReturn property as true, the analysis result will not return the path guide.

The default value is String.Empty.

Gets or sets the field that identifies the start node ID in the 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 network dataset, required.

The default value is null.

Gets or sets the field that identifies the node ID in the 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 name of the field which stores the node names, optional.

The default value is String.Empty.

Gets or sets the field that identifies the end node ID in the 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 distance tolerance from the point to the edge. It is obsolete. The unit is meter. It has the same unit with the dataset specified by the NetworkDataset property. 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.

Gets or sets the turn dataset, and it is optional.

The default value is null.

Gets or sets the field of the start turn edge ID. It supports 16-bit integer and 32-bit integer, and it is optional.

The default value is String.Empty.

Gets or sets the field of the turn node ID. It supports 16-bit integer and 32-bit integer, and it is optional.

The default value is String.Empty.

Gets or sets the field of the end turn edge ID. It supports 16-bit integer and 32-bit integer, and it is optional.

The default value is String.Empty.

Gets or sets the turn weight fields collection, and it is optional.

The default value is null.

Gets or sets the WeightFieldInfos object.

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

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 value is String.Empty.

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 in the transportation analysis, optional.

Gets or sets the analysis scope of the path finding analysis. Optional.

The TurnType type constant. It is used in PathGuideItem.

The invalid value.

The end, no turn.

Turns left.

Turns right.

Moves straight ahead.

Turns back.

The class of the vehicle information.

Initializes a new instance of the vehicle information class.

Initializes a new instance which is identical with the specified vehicle information class.

Specific vehicle information object.

Gets or sets the load amount of the vehicle.

The default value is -1.0.

Get or set the load of the vehicle. The load can be multi-dimensional, for example, the maximum load weight and the maximum load capacity can be set simultaneously.

Gets or sets the maximum cost of the vehicle.

The default value is -1.0.

Gets or sets the earliest departure time of the vehicle.

Gets or sets the latest return time of the vehicle.

Logistics analysis parameter setting class, mainly used to set related parameters.

Initializes a new instance of the logistics analysis parameter setting class.

Initializes a new instance of the logistics analysis parameter setting class which is identical with the specified logistics analysis parameter setting.

Specific logistics analysis parameter setting class.

Releases the resources.

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

The default value is null.

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

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

The default value is null.

The default value is false.

Gets or sets the turn weight field, and it is optional.

The default value is String.Empty.

Gets or sets the name of the time field info.

Gets or sets the logistics analysis mode.

The default value is LeastCost.

Get or set the type of logistics analysis route.

默认值为 RoundRoute。

VRP analysis result class. This class is used to obtain the set of routes for the analysis results, the set of nodes through which the analysis passes, the set of arcs, the set of travel guides, the set of sites and the set of weights, and the cost of each site. And the time and cost of the VRP line.

Release the resources used by the TransportationAnalystResult.

Get the set of paths through which the analysis results are obtained. Note that the IsEdgesReturn of the VRPAnalystParameter object must be Set to true to include the set of path segments in the analysis result, otherwise an empty array.

Get the set of waypoints for the analysis results. Note that the IsNodesReturn of the VRPAnalystParameter object must be Set to true to include the set of path nodes in the analysis result, otherwise an empty array.

Get the travel guide collection. Note that IsPathGuidesReturn of the VRPAnalystParameter object must be Set to true to include the travel guide collection in the analysis results, otherwise an empty array.

A collection of route objects that get the result of the analysis (a collection of GeoLineM). Note that the VR's VRPAnalystParameter. Set to true to include the route collection in the analysis result, otherwise an empty array.

Gets a two-dimensional array of site indexes that reflect the order in which the sites are sorted after analysis. Note that the IsStopIndexesReturn of the VRPAnalystParameter object must be Set to true to include the site index collection in the analysis results, otherwise an empty array.

Get the cost (weight) between sites after sorting the sites based on the site index. WeightName of the unit and analysis parameters (VRPAnalystParameter) object See> The weight field information specified by the attribute (WeightFieldInfo) has the same weight field.

Get an array of weights that represent the cost. WeightName of the unit and analysis parameters (VRPAnalystParameter) object See> The weight field information specified by the attribute (WeightFieldInfo) has the same weight field.

Returns the load of each line in the logistics distribution.

Returns the time of arrival in each distribution point in each route in the logistics distribution.

Returns the vehicle index for each line in the logistics distribution.

This enumeration defines the type of VRP analysis route.

Start at the center and return to the center.

Start at the center but don't return to the center.

Do not start from the center but return to the center.

The TransferWeightFieldInfo class. This class contains the information of TransferWeightFieldInfo object and the weight field of the transfer analysis.

Initializes a new instance of the WeightFieldInfo class.

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

The specified WeightFieldInfo object.

Gets or sets the from-to weight field or field expressions.

The default value is String.Empty .

Gets or sets the name of the WeightFieldInfo object.

The default value is UntitledWeightFieldInfo.

Gets or sets the to-from weight field or field expressions.

The default value is String.Empty.

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

Initializes a new instance of WeightFieldInfos.

Constructs a new object identical to the given WeightFieldInfos object.

The specified WeightFieldInfos object.

Adds a new WeightFieldInfo object in the WeightFieldInfos.

The WeightFieldInfo object to be added. The index of the new WeightFieldInfo object.

Clears all the WeightFieldInfo objects in the WeightFieldInfos. The cleared WeightFieldInfo objects are disposed.

Returns an enumerator for iterating through the WeightFieldInfos.

An IEnumerator object used to iterate through a collection.

Gets the index of the WeightFieldInfo according to the given name.

The name of the WeightFieldInfo to index. Returns the index of the WeightFieldInfo in the WeightFieldInfos.

Removes the WeightFieldInfo object from the WeightFieldInfos according to the specified index. The removed WeightFieldInfo object is disposed.

The index of the element to remove. Returns true if successful; otherwise false.

Removes the WeightFieldInfo object from the WeightFieldInfos according to the specified name. The removed WeightFieldInfo object is disposed.

The specified name of the WeightFieldInfo to be removed. Returns true if it is removed successfully, otherwise returns false.

Gets the count of the WeightFieldInfo in the given WeightFieldInfos.

Gets the WeightFieldInfo in the WeightFieldInfos according to the specified name.

The specified name. The value is WeightFieldInfo.Name. It is used to search the WeightFieldInfo object. The WeightFieldInfo object.

Gets the WeightFieldInfo object in the WeightFieldInfos object according to the specified index.

The specified index which starts with 0. The WeightFieldInfo object.

The enumeration defines the resource allocation demand types.

Node demand type. In this mode, the analysis only considers the resource demand of the nodes, not considering the demand of the edges. E.g., on Christmas Day, Santa send gifts to the children, where the location of Santa is the fixed center, the gift number is the resource number, the house addresses of children are demand nodes, the needed gift number of each child is the demand field value of the node. This condition is a node demand type.</p>

edge demand type. In this mode, the analysis only considers the resource demand of the edges, not considering the demand of the nodes. E.g., on Christmas Day, Santa send gifts to the children, where the location of Santa is the fixed center, the oil stock of the car Santa drives is the resource number, the house addresses of children are demand nodes, the needed oil cost to the home of each child is the demand field value of the edge. This condition is an edge demand type.</p>

Node and edge demand type. Consider both the demand of nodes and edges. E.g., on Christmas Day, Santa send gifts to the children, when considering the gifts number and the oil cost, it is a node and edge demand type.

Resource allocation analysis result class.

Releases all resources that the object occupies.

Gets the array of the DemandResult objects. For more information, please refer to the DemandResult class.

Gets the allocation route result of the resource allocation analysis. The array length is the number of the resource centers.

Gets the ID set of nodes passed by the analysis result.

Gets the ID set of edges passed by the analysis result.

Construct a new Resoure allocation analysis parameter class.

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

Specified AllocationAnalystParameter object.

Releases all resources that the object occupies.

Gets or sets the collection of SupplyCenter.

The default value is a new SuppplyCenters object.

Gets or sets the field representing the demand of the nodes which are regarded as the demand centers in the network dataset.

The default value is NodeDemand.

Gets or sets the field representing the demand of the edge which are regarded as the demand centers in the network dataset.

The default value is EdgeDemand.

Whether to analyze from the supply centers or not.

The default value is true.

Gets or sets whether the route generated in the analysis must be connected.

The default value is true.

Gets or sets resource allocation mode.

The default is AllocationDemandType.Both.

Gets or sets the name of the weight field information, i.e., the Name value of a certain WeightFieldInfo object of the WeightFieldInfos object specified by the TransportationAnalystSetting class.

The default value is String.Empty .

Gets or sets the turn cost field and this field must be in the collection of turn cost fields which is defined in the transportation network analysis environment settings.

The default value is String.Empty .