Constructor Detail

• FacilityAnalystSetting

  public FacilityAnalystSetting()

  Initializes a new instance of the FacilityAnalystSetting class.

• FacilityAnalystSetting

  public FacilityAnalystSetting(FacilityAnalystSetting facilityAnalystSetting)

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

  Parameters:

  facilityAnalystSetting - The specified FacilityAnalystSetting object.

Method Detail

• getBarrierEdges

  public int[] getBarrierEdges()

  Gets the ID list of the barrier edges.

  Once an edge is set as a barrier, it is forbidden to pass in analysis. Users can also set the barrier edges dynamically during analysis,Does not affect efficiency.

  Returns:

  The ID list of barrier edges.

  Default:

  The default value is null.

• setBarrierEdges

  public void setBarrierEdges(int[] value)

  Sets the ID list of the barrier edges, and it is optional.

  Once an edge is set as a barrier, it is forbidden to pass in analysis. Users can also set the barrier edges dynamically during analysis,Does not affect efficiency.

  Parameters:

  value - The ID list of barrier edges.

• getBarrierNodes

  public int[] getBarrierNodes()

  Gets the ID list of the barrier nodes.

  The barrier node is similar to barrier edges in definition except that the barrier is network nodes. Barrier nodes are the nodes that are forbidden to pass in analysis and they also can be the destination in network, e.g. it can be the destinations of transportation or travel.

  Returns:

  The ID list of the barrier nodes.

  Default:

  The default value is null.

• setBarrierNodes

  public void setBarrierNodes(int[] value)

  Sets the ID list of the barrier nodes, and it is optional.

  The barrier node is similar to barrier edges in definition except that the barrier is network nodes. Barrier nodes are the nodes that are forbidden to pass in analysis and they also can be the destination in network, e.g. it can be the destinations of transportation or travel.

  Parameters:

  value - The ID list of barrier edges.

• getNetworkDataset

  public DatasetVector getNetworkDataset()

  Get the network dataset.

  Returns:

  The network dataset.

  Default:

  The default value is null.

• setNetworkDataset

  public void setNetworkDataset(DatasetVector value)

  Sets the network dataset, required.

  Note if using network dataset for facility network analysis:

  1. While using methods of the FacilityAnalyst class to provide facility network analysis, the network dataset specified for facility network analysis should already process flow direction.To create a flow, see the SuperMap iDesktop Help documentation for the facility network analysis.

  Parameters:

  value - The network dataset.

  Default:

  The default value is null.

• getDirectionField

  public java.lang.String getDirectionField()

  Gets the direction field.

  Returns:

  Direction field.

  Default:

  The default value is null.

• setDirectionField

  public void setDirectionField(java.lang.String value)

  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.

  Parameters:

  value - Direction field.

• getEdgeIDField

  public java.lang.String getEdgeIDField()

  Returns the field that identifies the edge ID in the network dataset.

  Returns:

  The field that identifies the edge ID in the network dataset.

  Default:

  The default value is"SmID".

• setEdgeIDField

  public void setEdgeIDField(java.lang.String value)

  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.

  Parameters:

  value - The field that identifies the edge ID in the network dataset.

• getFNodeIDField

  public java.lang.String getFNodeIDField()

  Returns the field that identifies the edge start node ID in the network dataset.

  Returns:

  The field that identifies the ID of the start node in the network dataset.

  Default:

  The default value is "SmFNode".

• setFNodeIDField

  public void setFNodeIDField(java.lang.String value)

  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.

  Parameters:

  value - The field that identifies the ID of the start node in the network dataset.

• getNodeIDField

  public java.lang.String getNodeIDField()

  Returns the field that identifies the node ID in the network dataset.

  Returns:

  The field that identifies the node ID in the network dataset.

  Default:

  The default value is "SmNodeID".

• setNodeIDField

  public void setNodeIDField(java.lang.String value)

  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.

  Parameters:

  value - The field that identifies the edge ID in the network dataset.

• getTNodeIDField

  public java.lang.String getTNodeIDField()

  Returns the field that identifies the edge end node ID in the network dataset.

  Returns:

  The field that identifies the ID of the end node in the network dataset.

  Default:

  The default value is "SmTNode".

• setTNodeIDField

  public void setTNodeIDField(java.lang.String value)

  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.

  Parameters:

  value - The field that identifies the ID of the end node in the network dataset.

  Default:

  The default value is "SmTNode".

• getTolerance

  public double getTolerance()

  Returns the distance tolerance from the point to the edge. The unit is meter. It has the same unit with the network dataset specified by the setNetworkDataset method.

  For the distance tolerance between the point to the edge, see setTolerance method of introduction.

  Returns:

  The distance tolerance between the node and the edge.

  Default:

  The default value is null.

• setTolerance

  public void setTolerance(double value)

  Sets the distance tolerance from the point to the edge. The unit is meter. It has the same unit with the network dataset specified by the setNetworkDataset method.

  In principle, any point in the network can be specified as a stop in path analysis, and the stop should be adjacent to the network. If the point is not in network (neither in edge nor in node), it would be adjusted into network in terms of the tolerance.

  The illustration below demonstrates the tolerance mentioned in this interface. Where, the orange is the network nodes, the blue is the edges, the gray is the stop, the red is the distance between the stop and the edge AB. If the distance is in the tolerance, this stop will adjust to the edge AB.

  

  In order to perform the transportation analyst correctly, you need to set the proper tolerance value. The recommended calculation method is as follows:

  1. Calculating the minimum bounding box of the network dataset;
  2. Calculating the height and the width of the minimum bounding box of the network dataset.
  3. Getting the smaller value and diving it by 40 to get the distance tolerance.

  Parameters:

  value - The distance tolerance between the node and the edge.

• getWeightFieldInfos

  public WeightFieldInfos getWeightFieldInfos()

  Returns the object of weight field information collection.

  WeightFieldInfos is a collection of WeightFieldInfo.. You can set the weight fileds in WeightFieldInfo, which represents the cost in the analysis, in the WeightFieldInfo. Two weight fields are provided in the WeightFieldInfo, they are FTWeightField and the TFWeightField. The FTWeightField represents the cost from the start to the end of the edge while the TFWeightField indicates the cost from the end to the start of the edge.

  Returns:

  The object of weight field information collection.

  Default:

  The default value is the default value of the WeightFieldInfos object.

• setWeightFieldInfos

  public void setWeightFieldInfos(WeightFieldInfos weightFieldInfos)

  The object of weight field information collection.

  WeightFieldInfos is a collection of WeightFieldInfo.. You can set the weight fileds in WeightFieldInfo, which represents the cost in the analysis, in the WeightFieldInfo. Two weight fields are provided in the WeightFieldInfo, they are FTWeightField and the TFWeightField. The FTWeightField represents the cost from the start to the end of the edge while the TFWeightField indicates the cost from the end to the start of the edge.

  Parameters:

  weightFieldInfos - The object of weight field information collection.