Skip navigation links
com.supermap.services.networkanalyst

Class AnalystParameter

  • java.lang.Object
    • com.supermap.services.networkanalyst.AnalystParameter

  • public class AnalystParameter
extends java.lang.Object
    Parameter class required for iServer path analysis

    • Constructor Summary

      Constructors 
      Constructor and Description
      AnalystParameter() 

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      int[] getBarrierEdgeIDs()
      Returns a list of obstacle arc IDs.
      int[] getBarrierNodeIDs()
      Returns a list of obstacle node IDs.
      java.lang.String getTurnWeightField()
      Gets the name of the steering weight field
      java.lang.String getWeightFieldName()
      Returns the type of weight field information
      boolean isEndNodeAssigned()
      Returns whether to specify the termination point
      boolean isHasLeastEdgeCount()
      Returns whether the number of arcs is the minimum in path analysis
      boolean isHasLeastTotalCost()
      Returns whether the path analysis is the minimum cost
      boolean isReturnEdgeFeatures()
      Returns whether the analysis result contains the feature set of passing arcs.
      boolean isReturnEdgeGeometry()
      Returns whether the analysis result contains the geometric object collection of the passing arc.
      boolean isReturnEdgeIDs()
      Returns whether the analysis result contains the set of arcs passed.
      boolean isReturnNodeFeatures()
      Returns whether the analysis result contains a collection of node features
      boolean isReturnNodeGeometry()
      Returns whether the analysis result contains a collection of node geometry objects
      boolean isReturnNodeIDs()
      Returns whether the analysis result contains a collection of passing nodes.
      boolean isReturnPathGuides()
      Returns whether the analysis result contains driving guidance collection.
      boolean isReturnRoutes()
      Returns whether the analysis result contains a collection of routing objects.
      void setBarrierEdgeIDs(int[] barrierEdgeIDs)
      Sets the list of obstacle arc IDs. optional.
      void setBarrierNodeIDs(int[] barrierNodeIDs)
      Sets the list of obstacle node IDs. optional.
      void setEndNodeAssigned(boolean value)
      Sets whether to specify the termination point.
      void setHasLeastEdgeCount(boolean value)
      Sets whether the number of arcs is minimum in path analysis
      void setHasLeastTotalCost(boolean value)
      Sets whether the minimum cost in path analysis
      void setReturnEdgeFeatures(boolean value)
      Sets whether to include the feature set of passing arcs in the analysis result.
      void setReturnEdgeGeometry(boolean value)
      Sets whether to include the collection of passing arc geometric objects in the analysis result.
      void setReturnEdgeIDs(boolean value)
      Sets whether to include the set of passing arcs in the analysis result.
      void setReturnNodeFeatures(boolean value)
      Sets whether to include the node feature set in the analysis result
      void setReturnNodeGeometry(boolean value)
      Sets whether to include node geometry object collection in the analysis result
      void setReturnNodeIDs(boolean value)
      Sets whether to include the set of passing nodes in the analysis result.
      void setReturnPathGuides(boolean value)
      Sets whether to include the driving guidance set in the analysis result.
      void setReturnRoutes(boolean value)
      Sets whether to include a collection of routing objects in the analysis results.
      void setTurnWeightField(java.lang.String turnWeightField)
      Sets the name of the steering weight field
      void setWeightFieldName(java.lang.String weightFieldName)
      Sets the type of weight field information (please set the specific value according to the value of weightFieldName on the web page, please do not set it yourself)
      java.lang.String toString() 

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • AnalystParameter

        public AnalystParameter()

    • Method Detail

      • getBarrierEdgeIDs

        public int[] getBarrierEdgeIDs()
        Returns a list of obstacle arc IDs.
        Returns:
        ID list of obstacle arcs

      • setBarrierEdgeIDs

        public void setBarrierEdgeIDs(int[] barrierEdgeIDs)
        Sets the list of obstacle arc IDs. optional.
        Parameters:
        barrierEdgeIDs - list of barrier edge IDs.

      • getBarrierNodeIDs

        public int[] getBarrierNodeIDs()
        Returns a list of obstacle node IDs.
        Returns:
        list of obstacle node IDs

      • setBarrierNodeIDs

        public void setBarrierNodeIDs(int[] barrierNodeIDs)
        Sets the list of obstacle node IDs. optional.
        Parameters:
        barrierNodeIDs - list of barrier node IDs

      • isReturnEdgeIDs

        public boolean isReturnEdgeIDs()
        Returns whether the analysis result contains the set of arcs passed.

      • setReturnEdgeIDs

        public void setReturnEdgeIDs(boolean value)
        Sets whether to include the set of passing arcs in the analysis result.
        Parameters:
        value -

      • isReturnNodeIDs

        public boolean isReturnNodeIDs()
        Returns whether the analysis result contains a collection of passing nodes.

      • setReturnNodeIDs

        public void setReturnNodeIDs(boolean value)
        Sets whether to include the set of passing nodes in the analysis result.
        Parameters:
        value -

      • isReturnPathGuides

        public boolean isReturnPathGuides()
        Returns whether the analysis result contains driving guidance collection.
        Returns:

      • setReturnPathGuides

        public void setReturnPathGuides(boolean value)
        Sets whether to include the driving guidance set in the analysis result.
        Parameters:
        value -

      • isReturnRoutes

        public boolean isReturnRoutes()
        Returns whether the analysis result contains a collection of routing objects.
        Returns:

      • setReturnRoutes

        public void setReturnRoutes(boolean value)
        Sets whether to include a collection of routing objects in the analysis results.
        Parameters:
        value -

      • isReturnEdgeFeatures

        public boolean isReturnEdgeFeatures()
        Returns whether the analysis result contains the feature set of passing arcs.
        Returns:

      • setReturnEdgeFeatures

        public void setReturnEdgeFeatures(boolean value)
        Sets whether to include the feature set of passing arcs in the analysis result.
        Parameters:
        value -

      • isReturnEdgeGeometry

        public boolean isReturnEdgeGeometry()
        Returns whether the analysis result contains the geometric object collection of the passing arc.
        Returns:

      • setReturnEdgeGeometry

        public void setReturnEdgeGeometry(boolean value)
        Sets whether to include the collection of passing arc geometric objects in the analysis result.
        Parameters:
        value -

      • isReturnNodeFeatures

        public boolean isReturnNodeFeatures()
        Returns whether the analysis result contains a collection of node features
        Returns:

      • setReturnNodeFeatures

        public void setReturnNodeFeatures(boolean value)
        Sets whether to include the node feature set in the analysis result
        Parameters:
        value -

      • isReturnNodeGeometry

        public boolean isReturnNodeGeometry()
        Returns whether the analysis result contains a collection of node geometry objects
        Returns:

      • setReturnNodeGeometry

        public void setReturnNodeGeometry(boolean value)
        Sets whether to include node geometry object collection in the analysis result
        Parameters:
        value - specifies whether to include a collection of node geometry objects

      • getWeightFieldName

        public java.lang.String getWeightFieldName()
        Returns the type of weight field information
        Returns:

      • setWeightFieldName

        public void setWeightFieldName(java.lang.String weightFieldName)
        Sets the type of weight field information (please set the specific value according to the value of weightFieldName on the web page, please do not set it yourself)
        Parameters:
        weightFieldName -

      • isEndNodeAssigned

        public boolean isEndNodeAssigned()
        Returns whether to specify the termination point
        Returns:

      • setEndNodeAssigned

        public void setEndNodeAssigned(boolean value)
        Sets whether to specify the termination point.
        Parameters:
        value - true indicates the specified termination point, then the traveling salesman must visit the last termination point, that is, the last point of the specified passing point.

      • isHasLeastTotalCost

        public boolean isHasLeastTotalCost()
        Returns whether the path analysis is the minimum cost
        Returns:

      • setHasLeastTotalCost

        public void setHasLeastTotalCost(boolean value)
        Sets whether the minimum cost in path analysis
        Parameters:
        value -

      • isHasLeastEdgeCount

        public boolean isHasLeastEdgeCount()
        Returns whether the number of arcs is the minimum in path analysis
        Returns:

      • setHasLeastEdgeCount

        public void setHasLeastEdgeCount(boolean value)
        Sets whether the number of arcs is minimum in path analysis
        Parameters:
        value -

      • getTurnWeightField

        public java.lang.String getTurnWeightField()
        Gets the name of the steering weight field
        Returns:

      • setTurnWeightField

        public void setTurnWeightField(java.lang.String turnWeightField)
        Sets the name of the steering weight field
        Parameters:
        turnWeightField -

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
Skip navigation links