Constructor Detail

• TransportationAnalystParameter

  public TransportationAnalystParameter()

  Constructs a new TransportationAnalystParameter object.

• TransportationAnalystParameter

  public TransportationAnalystParameter(TransportationAnalystParameter transportationAnalystParameter)

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

  Parameters:

  transportationAnalystParameter - The specified TransportationAnalystParameter object.

Method Detail

• dispose

  public void dispose()

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

• isRoutesReturn

  public boolean isRoutesReturn()

  Returns whether the returned analysis result includes the route(GeoLineM) object set.

  Returns:

  Boolean, means whether the analysis result contains the route object set. True means it contains, false means not.

  Default:

  The default value is false.

• setRoutesReturn

  public void setRoutesReturn(boolean value)

  Sets whether the returned analysis result includes the route(GeoLineM) object set.

  Parameters:

  value - Specifies whether it contains the route object set. True means that it can return the route array by the getRoutes method of the TransportationAnalystResult object; false means that it will return a null array.

• isNodesReturn

  public boolean isNodesReturn()

  Whether to contain the passed node collection in the returned analyst result.

  Returns:

  Boolean, means whether the analysis result contains the passed node set. True means it contains, false means not.

  Default:

  The default value is false.

• setNodesReturn

  public void setNodesReturn(boolean value)

  Sets whether to contain the node ID collection in the returned analyst result.

  Parameters:

  value - Specifies whether it contains the passed node set. True means that it can return the passed node set by the TransportationAnalystResult method of the TransportationAnalystResult object; false means that it will return a null array.

• isEdgesReturn

  public boolean isEdgesReturn()

  Returns whether the set of the edges passed by is contained in the analysis result.

  Returns:

  Boolean, means whether the analysis result contains the passed edges set. True means it contains, false means not.

  Default:

  The default value is false.

• setEdgesReturn

  public void setEdgesReturn(boolean value)

  Sets whether to contain the edge collection in the returned analyst result.

  Parameters:

  value - Specifies whether it contains the passed edges set. True means that it can return the passed edges set by the TransportationAnalystResult method of the TransportationAnalystResult object; false means that it will return a null array.

• isPathGuidesReturn

  public boolean isPathGuidesReturn()

  Returns whether the path guide collection is contained in the analysis result.

  Returns:

  Boolean, means whether the analysis result contains the navigation guide set. True means it contains, false means not.

  Default:

  The default value is false.

• setPathGuidesReturn

  public void setPathGuidesReturn(boolean value)

  Sets whether the path guide collection is contained in the analysis result.

  Note: Only if you set the method as true and specify the edge name field by the setEdgeNameField method of the TransportationAnalystSetting class, then the analysis result contains the path guides; otherwise, it will not return the path guides but this doesn't affect it to get the other information in the analysis results.

  Parameters:

  value - Specifies whether it contains the navigation guide set. True means that it can return the navigation guide array by the TransportationAnalystResult method of the TransportationAnalystResult object; false means that it will return a null array.

• isStopIndexesReturn

  public boolean isStopIndexesReturn()

  Gets or sets whether it keeps the stop indexes in the analyst result or not.

  Returns:

  Boolean, means whether the analysis result contains the stop index set. True means it contains, false means not.

  Default:

  The default value is false.

• setStopIndexesReturn

  public void setStopIndexesReturn(boolean value)

  Sets whether keep the stop indexes in the analyst result or not.

  Parameters:

  value - Specifies whether it contains the stop index set. True means that it can return the stop index set by the TransportationAnalystResult method of the TransportationAnalystResult object; false means that it will return a null array.

• getNodes

  public int[] getNodes()

  Returns the set of the passed node IDs.

  Returns:

  The ID collection of nodes.

  Default:

  The default value is Null.

• setNodes

  public void setNodes(int[] value)

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

  Parameters:

  value - The ID collection of nodes.

• getPoints

  public Point2Ds getPoints()

  Returns the set of the passed nodes.

  Returns:

  The set of points that on the path.

  Default:

  The default value is Null.

• setPoints

  public void setPoints(Point2Ds value)

  Sets the passed nodes set in the analysis. It is required, but it is exclusive with the setNodesmethod. 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.

  Note: If the points are not in the network dataset, the points will not be participated to analysis.

  Parameters:

  value - The point collection of nodes.

• getWeightName

  public java.lang.String getWeightName()

  Gets the name of WeightFieldInfo.

  Returns:

  The name of WeightFieldInfo.

  Default:

  The default is a null string.

• setWeightName

  public void setWeightName(java.lang.String value)

  Sets the name of the weight field information, i.e., the returned value of the TransportationAnalystSetting method of a certain WeightFieldInfo object(TransportationAnalystSetting) of the WeightFieldInfos(TransportationAnalystSetting) object specified by the TransportationAnalystSetting(TransportationAnalystSetting) class. If not set, the default will use the name of the first weight field information object of the weight field information set.

  Parameters:

  value - The name of WeightFieldInfo.

• getBarrierNodes

  public int[] getBarrierNodes()

  Gets the ID list of the barrier nodes.

  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 obstacle nodes. It is optional. The specified obstacle nodes here and the obstacle nodes specified by TransportationAnalystSetting(TransportationAnalystSetting) will be used together in the transportation network analysis.

  Parameters:

  value - The ID list of the barrier nodes.

• getBarrierEdges

  public int[] getBarrierEdges()

  Gets the ID list of barrier edges.

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

  Parameters:

  value - The ID list of the barrier edges.

• getBarrierPoints

  public Point2Ds getBarrierPoints()

  Returns the coordinate list of the barrier nodes.

  Returns:

  The collection of coordinates of barrier nodes.

• setBarrierPoints

  public void setBarrierPoints(Point2Ds value)

  Sets the coordinate list of the barrier nodes. Optional. The specified nodes could not be on the network (neither on the arc nor on the node), the barrier points will be as the point in closest network according the distance tolerance (setTolerance). Currently supports the best path analysis, recent facility search, travelling salesman analysis and logistics distribution analysis.

  Parameters:

  value - The collection of coordinates of barrier nodes.

• getTurnWeightField

  public java.lang.String getTurnWeightField()

  Returns the turn weight filed.

  See the introduction of setTurnWeightField method.

  Returns:

  The turn weight filed.

  Default:

  The default is a null string.

• setTurnWeightField

  public void setTurnWeightField(java.lang.String value)

  Sets the turn weight filed. Optional.

  The turn weight field is the field that denotes the turn cost. The specified field must be one of TurnWeightFields(setTurnWeightFields) that is specified in the TransportationAnalystSetting(setTurnWeightFields) class.

  For details about the turn table and turn cost, please see the network analysis part in iDesktop Help.

  Parameters:

  value - The turn weight filed.