Skip navigation links
com.supermap.analyst.networkanalyst

Class SupplyCenter

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

  • public class SupplyCenter
extends java.lang.Object
    The SupplyCenter class stores the supply center information including Supply Center ID, MaxWeight and Type.

    • Constructor Summary

      Constructors 
      Constructor and Description
      SupplyCenter()
      Creates a new instance of the SupplyCenter.
      SupplyCenter(SupplyCenter supplyCenter)
      Initializes a new instance according to the specified SupplyCenter object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      int getID()
      Gets the ID of the supply center.
      double getMaxWeight()
      Returns the maximum cost (impedance) of the supply center.
      double getResourceValue()
      Gets the amount of the resource of the supply center.
      SupplyCenterType getType()
      Gets the type of SupplyCenter.
      void setID(int value)
      Sets the ID of SupplyCenter.
      void setMaxWeight(double value)
      Sets the maximum cost (impedance) of the supply center.
      void setResourceValue(double value)
      Sets the amount of the resource of the supply center.
      void setType(SupplyCenterType type)
      Sets the type of SupplyCenter.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • SupplyCenter

        public SupplyCenter()
        Creates a new instance of the SupplyCenter.

      • SupplyCenter

        public SupplyCenter(SupplyCenter supplyCenter)
        Initializes a new instance according to the specified SupplyCenter object.
        Parameters:
        supplyCenter - The specified SupplyCenter objects.

    • Method Detail

      • getType

        public SupplyCenterType getType()
        Gets the type of SupplyCenter. See the type of SupplyCenter in SupplyCenterType class.

        The type of the resource supply center can be FIXEDCENTER, OPTIONALCENTER, and NONE. The allocation analysis employes the FIXEDCENTER type; The location analysis employs the FIXEDCENTER and OPTIONALCENTER types. NONE is employed by neither location analysis nor allocation analysis.

        Returns:
        The supply center type.
        See Also:
        SupplyCenterType
        Default:
        The default value is null.

      • setType

        public void setType(SupplyCenterType type)
        Sets the type of SupplyCenter. See the type of SupplyCenter in SupplyCenterType class.

        The type of the resource supply center can be FIXEDCENTER, OPTIONALCENTER, and NONE. The allocation analysis employes the FIXEDCENTER type; The location analysis employs the FIXEDCENTER and OPTIONALCENTER types. NONE is employed by neither location analysis nor allocation analysis.

        Parameters:
        type - The supply center type.
        See Also:
        SupplyCenterType

      • getID

        public int getID()
        Gets the ID of the supply center.
        Returns:
        The supply center ID.
        Default:
        The default value is -1.

      • setID

        public void setID(int value)
        Sets the ID of SupplyCenter.
        Parameters:
        value - The supply center ID.

      • getMaxWeight

        public double getMaxWeight()
        Returns the maximum cost (impedance) of the supply center. It has the same unit with the weight field of the object that is specified by the property of the object.

        Maximum Impedance is used to restrict the costs from the demand points to the center. If the costs from the demand points, including edges and nodes, to the centers are higher than the maximum impedance, the demand points are filtered out. The maximum impedance can be edited.

        Returns:
        The impedance of the supply center.
        Default:
        The default value is 0.

      • setMaxWeight

        public void setMaxWeight(double value)
        Sets the maximum cost (impedance) of the supply center. It has the same unit with the weight field of the object that is specified by the property of the object.

        Maximum Impedance is used to restrict the costs from the demand points to the center. If the costs from the demand points, including edges and nodes, to the centers are higher than the maximum impedance, the demand points are filtered out. The maximum impedance can be edited.

        Parameters:
        value - The impedance of the supply center.

      • getResourceValue

        public double getResourceValue()
        Gets the amount of the resource of the supply center.
        Returns:
        The amount of the resource of the supply center.
        Default:
        The default value is 0.

      • setResourceValue

        public void setResourceValue(double value)
        Sets the amount of the resource of the supply center.
        Parameters:
        value - The amount of the resource of the supply center.
Skip navigation links