Skip navigation links
com.supermap.analyst.networkanalyst3d

Class TransportationAnalystSetting3D

  • java.lang.Object
    • com.supermap.analyst.networkanalyst3d.TransportationAnalystSetting3D

  • public class TransportationAnalystSetting3D
extends java.lang.Object
    The 3D transportation analyst environment setting. 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.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      int[] getBarrierEdges()
      Gets the ID list of barrier edges.
      int[] getBarrierNodes()
      Returns the ID list of the barrier nodes.
      java.lang.String getEdgeFilter()
      Returns edge filter expression.
      java.lang.String getEdgeIDField()
      Returns the iD filed of the edge.
      java.lang.String getEdgeNameField()
      Returns the Name field name of the edge.
      java.lang.String getFNodeIDField()
      Returns The name of the field identifying the from node ID of the edge.
      java.lang.String[] getFTSingleWayRuleValues()
      Returns an array of strings that are used to represent forward lines, that is, when the value of the RuleField field is one of the values of the array, it represents a forward line.
      DatasetVector getNetworkDataset()
      Get the network dataset.
      java.lang.String getNodeIDField()
      Returns the ID filed of the node.
      java.lang.String getNodeNameField()
      Returns the Name field name of the node.
      java.lang.String[] getProhibitedWayRuleValues()
      Returns an array of strings that are used to represent forbidden lines, that is, when the value of the RuleField field is one of the values of the array, it represents a forbidden line.
      java.lang.String getRuleField()
      Returns the transportation rule filed name.
      java.lang.String[] getTFSingleWayRuleValues()
      Returns an array of strings that are used to represent backward lines, that is, when the value of the RuleField field is one of the values of the array, it represents a backward line.
      java.lang.String getTNodeIDField()
      Returns The name of the field identifying the end node ID of the edge.
      double getTolerance()
      The distance tolerance between the point and the edge.
      java.lang.String[] getTwoWayRuleValues()
      Returns an array of strings that are used to represent two-way lines, that is, when the value of the RuleField field is one of the values of the array, it represents a two-way line.
      WeightFieldInfos3D getWeightFieldInfos()
      Returns weight information set object, the type is WeightFieldInfos, which is for supporting multi threads in the anaylysis.
      void setBarrierEdges(int[] value)
      Sets the ID list of barrier edges.
      void setBarrierNodes(int[] value)
      Sets the ID list of the barrier nodes.
      void setEdgeFilter(java.lang.String filter)
      Sets edge filter expression.
      void setEdgeIDField(java.lang.String value)
      Sets the iD filed of the edge.
      void setEdgeNameField(java.lang.String value)
      Sets the Name field name of the edge.
      void setFNodeIDField(java.lang.String value)
      Sets The name of the field identifying the from node ID of the edge.
      void setFTSingleWayRuleValues(java.lang.String[] values)
      Sets an array of strings that are used to represent forward lines, that is, when the value of the RuleField field is one of the values of the array, it represents a forward line.
      void setNetworkDataset(DatasetVector value)
      Set the network dataset.
      void setNodeIDField(java.lang.String value)
      Sets the ID filed of the node.
      void setNodeNameField(java.lang.String value)
      Sets the Name field name of the node.
      void setProhibitedWayRuleValues(java.lang.String[] values)
      Sets an array of strings that are used to represent forbidden lines, that is, when the value of the RuleField field is one of the values of the array, it represents a forbidden line.
      void setRuleField(java.lang.String value)
      Sets the transportation rule filed name.
      void setTFSingleWayRuleValues(java.lang.String[] values)
      Sets an array of strings that are used to represent backward lines, that is, when the value of the RuleField field is one of the values of the array, it represents a backward line.
      void setTNodeIDField(java.lang.String value)
      Sets The name of the field identifying the end node ID of the edge.
      void setTolerance(double value)
      Sets the distance tolerance between the point and the edge.
      void setTwoWayRuleValues(java.lang.String[] values)
      Sets an array of strings that are used to represent two-way lines, that is, when the value of the RuleField field is one of the values of the array, it represents a two-way line.
      void setWeightFieldInfos(WeightFieldInfos3D value)
      Sets weight information set object, the type is WeightFieldInfos, which is for supporting multi threads in the analysis.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • TransportationAnalystSetting3D

        public TransportationAnalystSetting3D()
        Constructs a new TransportationAnalystSetting3D object.

      • TransportationAnalystSetting3D

        public TransportationAnalystSetting3D(TransportationAnalystSetting3D networkAnalystSetting)
        Constructs a new object identical to the given TransportationAnalystSetting3D object.
        Parameters:
        networkAnalystSetting - The specified TransportationAnalystSetting3D object.

    • Method Detail

      • getNetworkDataset

        public DatasetVector getNetworkDataset()
        Get the network dataset.
        Returns:
        The network dataset.

      • setNetworkDataset

        public void setNetworkDataset(DatasetVector value)
        Set the network dataset.
        Parameters:
        value - The network dataset.

      • getNodeIDField

        public java.lang.String getNodeIDField()
        Returns the ID filed of the node.
        Returns:
        The ID filed of the node.

      • setNodeIDField

        public void setNodeIDField(java.lang.String value)
        Sets the ID filed of the node.
        Parameters:
        value - The ID filed of the node.

      • getEdgeIDField

        public java.lang.String getEdgeIDField()
        Returns the iD filed of the edge.
        Returns:
        The ID filed of the edge.

      • setEdgeIDField

        public void setEdgeIDField(java.lang.String value)
        Sets the iD filed of the edge.
        Parameters:
        value - The ID filed of the edge.

      • getFNodeIDField

        public java.lang.String getFNodeIDField()
        Returns The name of the field identifying the from node ID of the edge.
        Returns:
        The name of the field identifying the from node ID of the edge.

      • setFNodeIDField

        public void setFNodeIDField(java.lang.String value)
        Sets The name of the field identifying the from node ID of the edge.
        Parameters:
        value - The name of the field identifying the from node ID of the edge.

      • getTNodeIDField

        public java.lang.String getTNodeIDField()
        Returns The name of the field identifying the end node ID of the edge.
        Returns:
        The name of the field identifying the end node ID of the edge.

      • setTNodeIDField

        public void setTNodeIDField(java.lang.String value)
        Sets The name of the field identifying the end node ID of the edge.
        Parameters:
        value - The name of the field identifying the end node ID of the edge.

      • getWeightFieldInfos

        public WeightFieldInfos3D getWeightFieldInfos()
        Returns weight information set object, the type is WeightFieldInfos, which is for supporting multi threads in the anaylysis.
        Returns:
        The weight information set object

      • setWeightFieldInfos

        public void setWeightFieldInfos(WeightFieldInfos3D value)
        Sets weight information set object, the type is WeightFieldInfos, which is for supporting multi threads in the analysis.
        Parameters:
        value - The weight information set object

      • getTolerance

        public double getTolerance()
        The distance tolerance between the point and the edge.
        Returns:
        The distance tolerance between the point and the edge.

      • setTolerance

        public void setTolerance(double value)
        Sets the distance tolerance between the point and the edge.
        Parameters:
        value - The distance tolerance between the node and the edge.

      • getBarrierNodes

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

      • setBarrierNodes

        public void setBarrierNodes(int[] value)
        Sets the ID list of the barrier nodes.
        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.

      • setBarrierEdges

        public void setBarrierEdges(int[] value)
        Sets the ID list of barrier edges.
        Parameters:
        value - The ID list of barrier edges.

      • getNodeNameField

        public java.lang.String getNodeNameField()
        Returns the Name field name of the node.
        Returns:
        The Name field name of the node.

      • setNodeNameField

        public void setNodeNameField(java.lang.String value)
        Sets the Name field name of the node.
        Parameters:
        value - The Name field name of the node.

      • getEdgeNameField

        public java.lang.String getEdgeNameField()
        Returns the Name field name of the edge.
        Returns:
        The Name field name of the edge.

      • setEdgeNameField

        public void setEdgeNameField(java.lang.String value)
        Sets the Name field name of the edge.
        Parameters:
        value - The Name field name of the edge.

      • getRuleField

        public java.lang.String getRuleField()
        Returns the transportation rule filed name.
        Returns:
        The transportation rule filed name.

      • setRuleField

        public void setRuleField(java.lang.String value)
        Sets the transportation rule filed name.
        Parameters:
        value - The transportation rule filed name.

      • getFTSingleWayRuleValues

        public java.lang.String[] getFTSingleWayRuleValues()
        Returns an array of strings that are used to represent forward lines, that is, when the value of the RuleField field is one of the values of the array, it represents a forward line.
        Returns:
        The array of strings indicating the forward single way.

      • setFTSingleWayRuleValues

        public void setFTSingleWayRuleValues(java.lang.String[] values)
        Sets an array of strings that are used to represent forward lines, that is, when the value of the RuleField field is one of the values of the array, it represents a forward line.
        Parameters:
        values - The array of strings indicating the forward single way.

      • getTFSingleWayRuleValues

        public java.lang.String[] getTFSingleWayRuleValues()
        Returns an array of strings that are used to represent backward lines, that is, when the value of the RuleField field is one of the values of the array, it represents a backward line.
        Returns:
        The array of strings indicating the backward single way.

      • setTFSingleWayRuleValues

        public void setTFSingleWayRuleValues(java.lang.String[] values)
        Sets an array of strings that are used to represent backward lines, that is, when the value of the RuleField field is one of the values of the array, it represents a backward line.
        Parameters:
        values - The array of strings indicating the backward single way.

      • getProhibitedWayRuleValues

        public java.lang.String[] getProhibitedWayRuleValues()
        Returns an array of strings that are used to represent forbidden lines, that is, when the value of the RuleField field is one of the values of the array, it represents a forbidden line.
        Returns:
        An array of strings of forbidden lines.

      • setProhibitedWayRuleValues

        public void setProhibitedWayRuleValues(java.lang.String[] values)
        Sets an array of strings that are used to represent forbidden lines, that is, when the value of the RuleField field is one of the values of the array, it represents a forbidden line.
        Parameters:
        values - An array of strings of forbidden lines.

      • getTwoWayRuleValues

        public java.lang.String[] getTwoWayRuleValues()
        Returns an array of strings that are used to represent two-way lines, that is, when the value of the RuleField field is one of the values of the array, it represents a two-way line.
        Returns:
        The array of strings indicating the two-way single way.

      • setTwoWayRuleValues

        public void setTwoWayRuleValues(java.lang.String[] values)
        Sets an array of strings that are used to represent two-way lines, that is, when the value of the RuleField field is one of the values of the array, it represents a two-way line.
        Parameters:
        values - The array of strings indicating the two-way single way.

      • getEdgeFilter

        public java.lang.String getEdgeFilter()
        Returns edge filter expression. The default is an empty string. Please see #setEdgeFilter(String) setEdgeFilter() for details. #setEdgeFilter(String) setEdgeFilter()} Method
        Returns:
        Edge filter expression.

      • setEdgeFilter

        public void setEdgeFilter(java.lang.String filter)
        Sets edge filter expression. Optional. The edges may be classified into several types based on some characteristics in network analysis. Not all of the edges are needed in the practical analysis, so this method can be used to filter the edges not needed in the analysis. It can improve the performance of the analysis.
        Parameters:
        filter - Edge filter expression.
Skip navigation links