Skip navigation links
com.supermap.analyst.networkanalyst

Class LocationAnalystParameter

  • java.lang.Object
    • com.supermap.analyst.networkanalyst.LocationAnalystParameter

  • public class LocationAnalystParameter
extends java.lang.Object
    The location-allocation analysis parameter class.

    Provides the required parameters for the location-allocation analysis including whether to allocate resources from the supply center, supply centers, the weight field name, the turn weight field, the expected number of supply centers, etc.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void dispose()
      Releases the resources that the object occupies.
      int getExpectedSupplyCenterCount()
      Gets the number of the supply centers which will be used to build some establishments.
      java.lang.String getNodeDemandField()
      Gets the field representing the demand of the nodes which are regarded as the demand centers in the network dataset.
      SupplyCenters getSupplyCenters()
      Return the array of the supply center.
      java.lang.String getTurnWeightField()
      Gets the turn cost field and this field must be in the collection of turn cost fields which is defined in the transportation network analysis environment settings.
      java.lang.String getWeightName()
      Returns the name of the weight field information, i.e., the value of the setName() method of a certain WeightFieldInfo object of the WeightFieldInfos object specified by the TransportationAnalystSetting class.
      boolean isFromCenter()
      Gets whether to allocate resources from supply center.
      void setExpectedSupplyCenterCount(int value)
      Sets the number of the supply centers which will be used to build some establishments.
      void setFromCenter(boolean value)
      Sets whether to allocate resources from supply center.
      void setNodeDemandField(java.lang.String value)
      Sets the field representing the demand of the nodes which are regarded as the demand centers in the network dataset.
      void setSupplyCenters(SupplyCenters value)
      Sets the resource supply center collection.
      void setTurnWeightField(java.lang.String value)
      Sets or sets the turn cost field and this field must be in the collection of turn cost fields which is defined in the transportation network analysis environment settings.
      void setWeightName(java.lang.String value)
      Sets the name of the weight field information, i.e., the value of the method of a certain object of the object specified by the TransportationAnalystSetting class.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • LocationAnalystParameter

        public LocationAnalystParameter()
        Initializes a new instance of the LocationAnalystParameter class.

      • LocationAnalystParameter

        public LocationAnalystParameter(LocationAnalystParameter parameter)
        Initializes a new instance of the LocationAnalystParameter class which is identical with the specified LocationAnalystParameter.
        Parameters:
        parameter - Given a site partition to parse the parameter object.

    • Method Detail

      • getSupplyCenters

        public SupplyCenters getSupplyCenters()
        Return the array of the supply center.
        Returns:
        Resource Supply Center Collection.
        See Also:
        SupplyCenters
        Default:
        The default value is a newly constructed object SupplyCenters .

      • setSupplyCenters

        public void setSupplyCenters(SupplyCenters value)
        Sets the resource supply center collection.
        Parameters:
        value - Resource Supply Center Collection.

      • getNodeDemandField

        public java.lang.String getNodeDemandField()
        Gets the field representing the demand of the nodes which are regarded as the demand centers in the network dataset.
        Returns:
        Node requirement field.
        Default:
        The default value is "NodeDemand".

      • setNodeDemandField

        public void setNodeDemandField(java.lang.String value)
        Sets the field representing the demand of the nodes which are regarded as the demand centers in the network dataset.
        Parameters:
        value - Node requirement field.

      • getExpectedSupplyCenterCount

        public int getExpectedSupplyCenterCount()
        Gets the number of the supply centers which will be used to build some establishments. If the parameter is set to zero, the minimal number of required supply centers will be computed to cover the whole analysis area.
        Returns:
        The number of resource supply centers expected for the final facility location.
        Default:
        The default value is 0.

      • setExpectedSupplyCenterCount

        public void setExpectedSupplyCenterCount(int value)
        Sets the number of the supply centers which will be used to build some establishments. If the parameter is set to zero, the minimal number of required supply centers will be computed to cover the whole analysis area.
        Parameters:
        value - The number of resource supply centers expected for the final facility location.
        Default:
        The default value is 0.

      • isFromCenter

        public boolean isFromCenter()
        Gets whether to allocate resources from supply center.

        Since the arc in the network data has positive and negative resistance, that is, the forward resistance value of the arc and its reverse resistance value may be different, so in the analysis, from the resource supply center to allocate resources to the demand point and from the demand point to The results of the analysis will be different if the resource supply centers allocate these two distributions.

        The following two examples of practical application scenarios to help further understand the two forms of difference, assuming that the network data center of the arc of the positive and negative resistance values are different.

        1. From the resource supply center to allocate resources to the demand point:
          2. If you choose the locations for some stores which are regarded as the supply centers and the demand centers are the shops, in the real world the stores need to supply goods for the shops. Therefore, the setFromCenter() method needs to be set to true, namely analyzing from the supply centers.
        2. We do not allocate resources from resource supply center:
          3. If you choose the locations for some post offices or banks which are regarded as the supply centers and the demand centers are the residential areas, in the real world the people in the residential areas need to go to the post offices or banks to deal with affairs. Therefore, the setFromCenter() method needs to be set to false, namely not analyzing from the supply centers.
        Returns:
        Returns true from the resource supply center; false otherwise.
        Default:
        The default value is true.

      • setFromCenter

        public void setFromCenter(boolean value)
        Sets whether to allocate resources from supply center.

        Since the arc in the network data has positive and negative resistance, that is, the forward resistance value of the arc and its reverse resistance value may be different, so in the analysis, from the resource supply center to allocate resources to the demand point and from the demand point to The results of the analysis will be different if the resource supply centers allocate these two distributions.

        The following two examples of practical application scenarios to help further understand the two forms of difference, assuming that the network data center of the arc of the positive and negative resistance values are different.

        1. From the resource supply center to allocate resources to the demand point:
          2. If you choose the locations for some stores which are regarded as the supply centers and the demand centers are the shops, in the real world the stores need to supply goods for the shops. Therefore, the setFromCenter() method needs to be set to true, namely analyzing from the supply centers.
        2. We do not allocate resources from resource supply center:
          3. If you choose the locations for some post offices or banks which are regarded as the supply centers and the demand centers are the residential areas, in the real world the people in the residential areas need to go to the post offices or banks to deal with affairs. Therefore, the setFromCenter() method needs to be set to false, namely not analyzing from the supply centers.
        Parameters:
        value - Specifies whether resources are allocated from the resource supply center.

      • getTurnWeightField

        public java.lang.String getTurnWeightField()
        Gets the turn cost field and this field must be in the collection of turn cost fields which is defined in the transportation network analysis environment settings.
        Returns:
        Turn to the weight field.
        Default:
        The default value is an empty string.

      • setTurnWeightField

        public void setTurnWeightField(java.lang.String value)
        Sets or sets the turn cost field and this field must be in the collection of turn cost fields which is defined in the transportation network analysis environment settings.
        Parameters:
        value - Turn to the weight field.

      • getWeightName

        public java.lang.String getWeightName()
        Returns the name of the weight field information, i.e., the value of the setName() method of a certain WeightFieldInfo object of the WeightFieldInfos object specified by the TransportationAnalystSetting class.
        Returns:
        The name of the weight field information.
        Default:
        The default value is an empty string.

      • setWeightName

        public void setWeightName(java.lang.String value)
        Sets the name of the weight field information, i.e., the value of the method of a certain object of the object specified by the TransportationAnalystSetting class.
        Parameters:
        value - The name of the weight field information.

      • dispose

        public void dispose()
        Releases the resources that the object occupies. This object is no longer available when the method is called.
Skip navigation links