Interface BlockingRegionDefinition

All Known Subinterfaces:
JmodelBlockingRegionDefinition
All Known Implementing Classes:
CommonModel, JSimGraphModel, JSIMModel
public interface BlockingRegionDefinition

Title: Blocking Region Definition Interface

Description: This interface will enumerate methods used to specify a blocking region on the queue network.

Author:
Bertoli Marco Date: 26-gen-2006 Time: 16.21.26

  • Method Details

    • addBlockingRegion

      Object addBlockingRegion(String name, String type)
      Adds a new blocking region to the model
      Parameters:
      name - name of the new region
      type - type of the new region
      Returns:
      search's key for new region

    • deleteBlockingRegion

      void deleteBlockingRegion(Object key)
      Deletes a blocking region from the model
      Parameters:
      key - search's key for region

    • getRegionKeys

      Vector<Object> getRegionKeys()
      Returns the entire set of blocking region keys
      Returns:
      the entire set of blocking region keys

    • getRegionName

      String getRegionName(Object regionKey)
      Gets the name of a blocking region
      Parameters:
      regionKey - search's key for region
      Returns:
      name of the region

    • setRegionName

      void setRegionName(Object regionKey, String name)
      Sets the name of a blocking region
      Parameters:
      regionKey - search's key for region
      name - name of the region

    • getRegionType

      String getRegionType(Object regionKey)
      Gets the type of a blocking region
      Parameters:
      regionKey - search's key for region
      Returns:
      type of the region

    • setRegionType

      void setRegionType(Object regionKey, String type)
      Sets the type of a blocking region
      Parameters:
      regionKey - search's key for region
      type - type of the region

    • getRegionCustomerConstraint

      Integer getRegionCustomerConstraint(Object regionKey)
      Gets the global customer number constraint for a blocking region
      Parameters:
      regionKey - search's key for region
      Returns:
      maximum number of allowed customers (-1 means infinity)

    • setRegionCustomerConstraint

      void setRegionCustomerConstraint(Object regionKey, Integer maxJobs)
      Sets the global customer number constraint for a blocking region
      Parameters:
      regionKey - search's key for region
      maxJobs - maximum number of allowed customers (-1 means infinity)

    • getRegionMemorySize

      Integer getRegionMemorySize(Object regionKey)
      Gets the global memory size constraint for a blocking region
      Parameters:
      regionKey - search's key for region
      Returns:
      maximum size of allowed memory (-1 means infinity)

    • setRegionMemorySize

      void setRegionMemorySize(Object regionKey, Integer maxMemory)
      Sets the global memory size constraint for a blocking region
      Parameters:
      regionKey - search's key for region
      maxMemory - maximum size of allowed memory (-1 means infinity)

    • getRegionClassCustomerConstraint

      Integer getRegionClassCustomerConstraint(Object regionKey, Object classKey)
      Gets the customer number constraint for a blocking region and a class
      Parameters:
      regionKey - search's key for region
      classKey - search's key for class
      Returns:
      maximum number of allowed customers for specified class (-1 means infinity)

    • setRegionClassCustomerConstraint

      void setRegionClassCustomerConstraint(Object regionKey, Object classKey, Integer maxJobs)
      Sets the customer number constraint for a blocking region and a class
      Parameters:
      regionKey - search's key for region
      classKey - search's key for class
      maxJobs - maximum number of allowed customers for specified class (-1 means infinity)

    • getRegionClassMemorySize

      Integer getRegionClassMemorySize(Object regionKey, Object classKey)
      Gets the memory size constraint for a blocking region and a class
      Parameters:
      regionKey - search's key for region
      classKey - search's key for class
      Returns:
      maximum size of allowed memory for specified class (-1 means infinity)

    • setRegionClassMemorySize

      void setRegionClassMemorySize(Object regionKey, Object classKey, Integer maxMemory)
      Sets the memory size constraint for a blocking region and a class
      Parameters:
      regionKey - search's key for region
      classKey - search's key for class
      maxMemory - maximum size of allowed memory for specified class (-1 means infinity)

    • getRegionClassDropRule

      Boolean getRegionClassDropRule(Object regionKey, Object classKey)
      Gets the drop rule for a blocking region and a class
      Parameters:
      regionKey - search's key for region
      classKey - search's key for class
      Returns:
      true if jobs of specified class can be dropped, false otherwise

    • setRegionClassDropRule

      void setRegionClassDropRule(Object regionKey, Object classKey, Boolean drop)
      Sets the drop rule for a blocking region and a class
      Parameters:
      regionKey - search's key for region
      classKey - search's key for class
      drop - true if jobs of specified class can be dropped, false otherwise

    • getRegionClassWeight

      Integer getRegionClassWeight(Object regionKey, Object classKey)
      Gets the weight of each job for a blocking region and a class
      Parameters:
      regionKey - search's key for region
      classKey - search's key for class
      Returns:
      weight of each job for specified class

    • setRegionClassWeight

      void setRegionClassWeight(Object regionKey, Object classKey, Integer weight)
      Sets the weight of each job for a blocking region and a class
      Parameters:
      regionKey - search's key for region
      classKey - search's key for class
      weight - weight of each job for specified class

    • getRegionClassSize

      Integer getRegionClassSize(Object regionKey, Object classKey)
      Gets the size of each job for a blocking region and a class
      Parameters:
      regionKey - search's key for region
      classKey - search's key for class
      Returns:
      size of each job for specified class

    • setRegionClassSize

      void setRegionClassSize(Object regionKey, Object classKey, Integer size)
      Sets the size of each job for a blocking region and a class
      Parameters:
      regionKey - search's key for region
      classKey - search's key for class
      size - size of each job for specified class

    • getRegionClassSoftDeadline

      Double getRegionClassSoftDeadline(Object regionKey, Object classKey)
      Gets the soft deadline of each job for a blocking region and a class
      Parameters:
      regionKey - search's key for region
      classKey - search's key for class
      Returns:
      soft deadline of each job for specified class

    • setRegionClassSoftDeadline

      void setRegionClassSoftDeadline(Object regionKey, Object classKey, Double softDeadline)
      Sets the soft deadline of each job for a blocking region and a class
      Parameters:
      regionKey - search's key for region
      classKey - search's key for class
      softDeadline - soft deadline of each job for specified class

    • canRegionStationBeAdded

      boolean canRegionStationBeAdded(Object regionKey, Object stationKey)
      Tells if a station can be added to a blocking region (all the stations that create or destroy jobs cannot be added)
      Parameters:
      regionKey - search's key for region
      stationKey - search's key for station
      Returns:
      true if the station can be added to specified region

    • addRegionStation

      boolean addRegionStation(Object regionKey, Object stationKey)
      Adds a station to a blocking region
      Parameters:
      regionKey - search's key for region
      stationKey - search's key for station
      Returns:
      true if the station has been added to specified region

    • removeRegionStation

      void removeRegionStation(Object regionKey, Object stationKey)
      Removes a station from a blocking region
      Parameters:
      regionKey - search's key for region
      stationKey - search's key for station

    • getBlockingRegionStations

      Set<Object> getBlockingRegionStations(Object regionKey)
      Returns a set of all the stations in a blocking region
      Parameters:
      regionKey - search's key for region
      Returns:
      a set of all the stations in specified region

    • getStationBlockingRegion

      Object getStationBlockingRegion(Object stationKey)
      Gets the blocking region of a station
      Parameters:
      stationKey - search's key for station
      Returns:
      search's key for region or null if it is undefined

    • getBlockableStationKeys

      Vector<Object> getBlockableStationKeys()
      Gets a vector of stations that can be added to a blocking region
      Returns:
      a vector of stations that can be added to a blocking region

    • addRegionGroup

      void addRegionGroup(Object regionKey, String name)
      Adds a new group to a blocking region
      Parameters:
      regionKey - search's key for region
      name - name of the new group

    • deleteRegionGroup

      void deleteRegionGroup(Object regionKey, int index)
      Deletes a group from a blocking region
      Parameters:
      regionKey - search's key for region
      index - indexing number for group

    • deleteAllRegionGroups

      void deleteAllRegionGroups(Object regionKey)
      Deletes all the groups from a blocking region
      Parameters:
      regionKey - search's key for region

    • getRegionGroupList

      List<CommonModel.BlockingGroupData> getRegionGroupList(Object regionKey)
      Returns a list of the group data for a blocking region
      Parameters:
      regionKey - search's key for region
      Returns:
      a list of the group data for specified region

    • getRegionGroupName

      String getRegionGroupName(Object regionKey, int index)
      Gets the name of a group for a blocking region
      Parameters:
      regionKey - search's key for region
      index - indexing number for group
      Returns:
      name of the group

    • setRegionGroupName

      void setRegionGroupName(Object regionKey, int index, String name)
      Sets the name of a group for a blocking region
      Parameters:
      regionKey - search's key for region
      index - indexing number for group
      name - name of the group

    • getRegionGroupCustomerConstraint

      Integer getRegionGroupCustomerConstraint(Object regionKey, int index)
      Gets the customer number constraint for a blocking region and a group
      Parameters:
      regionKey - search's key for region
      index - indexing number for group
      Returns:
      maximum number of allowed customers for specified group (-1 means infinity)

    • setRegionGroupCustomerConstraint

      void setRegionGroupCustomerConstraint(Object regionKey, int index, Integer maxJobs)
      Sets the customer number constraint for a blocking region and a group
      Parameters:
      regionKey - search's key for region
      index - indexing number for group
      maxJobs - maximum number of allowed customers for specified group (-1 means infinity)

    • getRegionGroupMemorySize

      Integer getRegionGroupMemorySize(Object regionKey, int index)
      Gets the memory size constraint for a blocking region and a group
      Parameters:
      regionKey - search's key for region
      index - indexing number for group
      Returns:
      maximum size of allowed memory for specified group (-1 means infinity)

    • setRegionGroupMemorySize

      void setRegionGroupMemorySize(Object regionKey, int index, Integer maxMemory)
      Sets the memory size constraint for a blocking region and a group
      Parameters:
      regionKey - search's key for region
      index - indexing number for group
      maxMemory - maximum size of allowed memory for specified group (-1 means infinity)

    • addClassIntoRegionGroup

      void addClassIntoRegionGroup(Object regionKey, int index, Object classKey)
      Adds a class to a group for a blocking region
      Parameters:
      regionKey - search's key for region
      index - indexing number for group
      classKey - search's key for class

    • removeClassFromRegionGroup

      void removeClassFromRegionGroup(Object regionKey, int index, Object classKey)
      Removes a class from a group for a blocking region
      Parameters:
      regionKey - search's key for region
      index - indexing number for group
      classKey - search's key for class

    • removeAllClassesFromRegionGroup

      void removeAllClassesFromRegionGroup(Object regionKey, int index)
      Removes all the classes from a group for a blocking region
      Parameters:
      regionKey - search's key for region
      index - indexing number for group

    • getRegionGroupClassList

      List<Object> getRegionGroupClassList(Object regionKey, int index)
      Returns a list of classes in a group for a blocking region
      Parameters:
      regionKey - search's key for region
      index - indexing number for group
      Returns:
      a list of classes in specified group