Skip navigation links
com.supermap.analyst.networkanalyst3d

Class FacilityAnalystSetting3D

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

  • public class FacilityAnalystSetting3D
extends java.lang.Object
    The FacilityAnalystSetting class. This class provides all the parameter information in facility analysis. The settings of the parameters will affect the 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 getDirectionField()
      Gets the direction field list.
      java.lang.String getEdgeIDField()
      Returns the field for the edge ID.
      java.lang.String getFNodeIDField()
      Returns The name of the field identifying the from node ID of the edge.
      DatasetVector getNetworkDataset()
      Get the network dataset.
      java.lang.String getNodeIDField()
      Returns the ID filed of the node.
      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.
      WeightFieldInfos3D getWeightFieldInfos()
      Returns weight information collection object, the type is WeightFieldInfos, which is for supporting multi threads in the analysis.
      void setBarrierEdges(int[] edges)
      Sets the ID list of barrier edges.
      void setBarrierNodes(int[] nodes)
      Sets the ID list of the barrier nodes.
      void setDirectionField(java.lang.String directionField)
      Sets the direction field list.
      void setEdgeIDField(java.lang.String edgeIDfield)
      Sets the field for the edge ID.
      void setFNodeIDField(java.lang.String fNodeIDField)
      Sets The name of the field identifying the from node ID of the edge.
      void setNetworkDataset(DatasetVector datasetVector)
      Set the network dataset.
      void setNodeIDField(java.lang.String nodeIDField)
      Sets the ID filed of the node.
      void setTNodeIDField(java.lang.String tNodeIDField)
      Sets The name of the field identifying the end node ID of the edge.
      void setTolerance(double tolerance)
      Sets the distance tolerance between the point and the edge.
      void setWeightFieldInfos(WeightFieldInfos3D weightFieldInfos)
      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

      • FacilityAnalystSetting3D

        public FacilityAnalystSetting3D()
        Initializes a new instance of the FacilityAnalystSetting class.

      • FacilityAnalystSetting3D

        public FacilityAnalystSetting3D(FacilityAnalystSetting3D facilityAnalystSetting)
        Initializes a new instance of the FacilityAnalystSetting class which is identical with the specified FacilityAnalystSetting object.
        Parameters:
        facilityAnalystSetting - Facility network analysis environment settings

    • Method Detail

      • getBarrierEdges

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

      • setBarrierEdges

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

      • 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[] nodes)
        Sets the ID list of the barrier nodes.
        Parameters:
        nodes - array of barrier nodes

      • getNetworkDataset

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

      • setNetworkDataset

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

      • getDirectionField

        public java.lang.String getDirectionField()
        Gets the direction field list.
        Returns:
        The direction field list.

      • setDirectionField

        public void setDirectionField(java.lang.String directionField)
        Sets the direction field list.
        Parameters:
        directionField - The direction field list.

      • getEdgeIDField

        public java.lang.String getEdgeIDField()
        Returns the field for the edge ID.
        Returns:
        The field for the edge ID.

      • setEdgeIDField

        public void setEdgeIDField(java.lang.String edgeIDfield)
        Sets the field for the edge ID.
        Parameters:
        edgeIDfield - The field for the edge ID.

      • 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 fNodeIDField)
        Sets The name of the field identifying the from node ID of the edge.
        Parameters:
        fNodeIDField - The name of the field identifying the from node ID of the edge.

      • 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 nodeIDField)
        Sets the ID filed of the node.
        Parameters:
        nodeIDField - The ID filed of the node.Sets the ID filed of the node.

      • 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 tNodeIDField)
        Sets The name of the field identifying the end node ID of the edge.
        Parameters:
        tNodeIDField - The name of the field identifying the end node ID of the edge.

      • getTolerance

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

      • setTolerance

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

      • getWeightFieldInfos

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

      • setWeightFieldInfos

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