Skip navigation links
com.supermap.analyst.networkanalyst3d

Class TransportationAnalystParameter3D


  • public class TransportationAnalystParameter3D
extends InternalHandleDisposable
    The parameter class of the 3D transportation network analysis. 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.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void dispose()
      Disposes the resources occupied by the object.
      int[] getBarrierEdges()
      Returns the ID list of the barrier edges.
      int[] getBarrierNodes()
      Returns the ID list of the barrier nodes.
      Point3Ds getBarrierPoints()
      Returns the coordinates list of the barrier nodes.
      int[] getNodes()
      Returns the set of the passed node IDs.
      Point3Ds getPoints()
      Returns the set of the passed nodes.
      java.lang.String getWeightName()
      Returns the name of the weight field information.
      boolean isEdgesReturn()
      Returns whether the analysis result includes the passed edges set.
      boolean isNodesReturn()
      Returns whether the analysis result includes the passed nodes set.
      boolean isRoutesReturn()
      Returns whether the returned analysis result includes the route(GeoLineM) object set.
      boolean isStopIndexesReturn()
      Gets or sets whether it keeps the stop indexes in the analyst result or not.
      void setBarrierEdges(int[] value)
      Sets the ID list of the obstacle edges.
      void setBarrierNodes(int[] value)
      Sets the ID list of the obstacle nodes.
      void setBarrierPoints(Point3Ds value)
      Sets the coordinate list of the obstacle points.
      void setEdgesReturn(boolean value)
      Sets whether to contain the edge collection in the returned analyst result.
      void setNodes(int[] value)
      Sets the node ID dataset passed by the analysis.
      void setNodesReturn(boolean value)
      Sets whether to contain the passed node collection in the analyst result.
      void setPoints(Point3Ds value)
      Sets the passed nodes set in the analysis.
      void setRoutesReturn(boolean value)
      Sets whether the returned analysis result includes the route(GeoLineM) object set.
      void setStopIndexesReturn(boolean value)
      Sets whether keep the stop indexes in the analyst result or not.
      void setWeightName(java.lang.String value)
      Sets the name of the Weight field information.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • TransportationAnalystParameter3D

        public TransportationAnalystParameter3D()
        Constructs a new TransportationAnalystParameter3D object.

      • TransportationAnalystParameter3D

        public TransportationAnalystParameter3D(TransportationAnalystParameter3D transportationAnalystParameter)
        Initializes a new instance of the TransportationAnalystParameter3D class which is identical with the specified TransportationAnalystParameter3D.
        Parameters:
        transportationAnalystParameter - The specified TransportationAnalystParameter3D 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. The default is false.
        Returns:
        Specifies whether it contains the route object set. True means it contains, false means not.

      • 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 set by the TransportationAnalystResult3D getRoutes method of the TransportationAnalystResult3D object; false means that it will return a null array.

      • isNodesReturn

        public boolean isNodesReturn()
        Returns whether the analysis result includes the passed nodes set. The default is false.
        Returns:
        Boolean, means whether the analysis result contains the passed node set. True means it contains, false means not.

      • setNodesReturn

        public void setNodesReturn(boolean value)
        Sets whether to contain the passed node collection in the analyst result.
        Parameters:
        value - Specifies whether it contains the passed node set. True means that it can return the passed node set by the TransportationAnalystResult3D method of the TransportationAnalystResult3D object; false means that it will return a null array.

      • isEdgesReturn

        public boolean isEdgesReturn()
        Returns whether the analysis result includes the passed edges set. The default is false.
        Returns:
        Boolean, means whether the analysis result contains the passed edges set. True means it contains, false means not.

      • 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 TransportationAnalystResult3D method of the TransportationAnalystResult3D 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:
        Specifies whether the analysis result contains the stop index set. True means it contains, false means not.

      • 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 TransportationAnalystResult3D method of the TransportationAnalystResult3D object; false means that it will return a null array.

      • getNodes

        public int[] getNodes()
        Returns the set of the passed node IDs. The default is null.
        Returns:
        The ID collection of nodes.

      • setNodes

        public void setNodes(int[] value)
        Sets the node ID dataset passed by the analysis. It is required, but it is exclusive with the setPoints()method. 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 Point3Ds getPoints()
        Returns the set of the passed nodes. The default is null.
        Returns:
        The set of points that on the path.

      • setPoints

        public void setPoints(Point3Ds value)
        Sets the passed nodes set in the analysis. It is required, but it is exclusive with the setNodes()method. 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.

      • getWeightName

        public java.lang.String getWeightName()
        Returns the name of the weight field information. The default is an empty string.
        Returns:
        value The name of WeightFieldInfo.

      • setWeightName

        public void setWeightName(java.lang.String value)
        Sets the name of the Weight field information. It is the returned value of the TransportationAnalystSetting3D method of a certain WeightFieldInfos3D object in the TransportationAnalystSetting3D(TransportationAnalystSetting3D) class. The default value is the Name value of the first WeightFieldInfo3D object if you don't set it in the analysis.
        Parameters:
        value - The name of WeightFieldInfo.

      • getBarrierNodes

        public int[] getBarrierNodes()
        Returns the ID list of the barrier nodes. The default is null.
        Returns:
        The ID list of the barrier nodes.

      • 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 TransportationAnalystSetting3D(TransportationAnalystSetting3D) will be used together in the 3D transportation network analysis.
        Parameters:
        value - The ID list of the barrier nodes.

      • getBarrierEdges

        public int[] getBarrierEdges()
        Returns the ID list of the barrier edges. The default is null.
        Returns:
        The ID list of barrier edges.

      • getBarrierPoints

        public Point3Ds getBarrierPoints()
        Returns the coordinates list of the barrier nodes. The default is null.
        Returns:
        The collection of coordinates of barrier nodes.

      • setBarrierPoints

        public void setBarrierPoints(Point3Ds value)
        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 (setTolerance()).
        Parameters:
        value - The collection of coordinates of barrier nodes.

      • 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 TransportationAnalystSetting3D() will be used together in the 3D transportation network analysis.
        Parameters:
        value - The ID list of the barrier edges.
Skip navigation links