net.sf.cpsolver.coursett.constraint

## Class RoomConstraint

- java.lang.Object
- - net.sf.cpsolver.ifs.model.Constraint<Lecture,Placement>
  - - net.sf.cpsolver.coursett.constraint.RoomConstraint

- All Implemented Interfaces:
    Comparable<Constraint<Lecture,Placement>>
  Direct Known Subclasses:
    DiscouragedRoomConstraint

      public class RoomConstraint
      extends Constraint<Lecture,Placement>

  Room constraint.
  Classes with the same room can not overlap in time.
  Version:
    CourseTT 1.2 (University Course Timetabling)
    Copyright (C) 2006 - 2010 Tomáš Müller
    muller@unitime.org
    http://muller.unitime.org
    This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
    This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
    You should have received a copy of the GNU Lesser General Public License along with this library; if not see http://www.gnu.org/licenses/.

- - ### Field Summary

    - ### Fields inherited from class net.sf.cpsolver.ifs.model.Constraint

      `iAssignedVariables, iConstraintListeners, iId`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `RoomConstraint(Long id, String name, Long buildingId, int capacity, RoomSharingModel roomSharingModel, Double x, Double y, boolean ignoreTooFar, boolean constraint)` Constructor

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `assigned(long iteration, Placement placement)` Given value is to be assigned to its varable.
    `void` | `computeConflicts(Placement placement, Set<Placement> conflicts)` The only method which has to be implemented by any constraint.
    `List<Placement>[]` | `getAvailableArray()`
    `Long` | `getBuildingId()` Building id
    `int` | `getCapacity()` Capacity
    `boolean` | `getConstraint()`
    `boolean` | `getIgnoreTooFar()`
    `String` | `getName()` Room name
    `Placement` | `getPlacement(int slot, int day)`
    `Double` | `getPosX()` X-position of the building
    `Double` | `getPosY()` Y-position of the building
    `List<Placement>` | `getResource(int slot)` Lookup table getResource()[slot] -> lecture using this room placed in the given time slot (null if empty)
    `Long` | `getResourceId()` Room id
    `Placement[]` | `getResourceOfWeek(int startDay)`
    `String` | `getRoomName()`
    `RoomSharingModel` | `getSharingModel()`
    `Long` | `getType()`
    `boolean` | `inConflict(Placement placement)` Returns true if the given assignment is inconsistent with the existing assignments respecting this constraint.
    `boolean` | `isAvailable(int slot)`
    `boolean` | `isAvailable(Lecture lecture, TimeLocation time, Long scheduler)`
    `boolean` | `isConsistent(Placement p1, Placement p2)` Returns true if the given assignments are consistent respecting this constraint.
    `protected void` | `printUsage(StringBuffer sb)` Room usage
    `void` | `setCoordinates(Double x, Double y)` Position of the building
    `void` | `setNotAvailable(Placement placement)`
    `void` | `setType(Long type)`
    `String` | `toString()`
    `void` | `unassigned(long iteration, Placement placement)` Given value is unassigned from its variable.

    - ### Methods inherited from class net.sf.cpsolver.ifs.model.Constraint

      `addConstraintListener, addVariable, assignedVariables, compareTo, constraintListeners, countAssignedVariables, countVariables, equals, getDescription, getId, getModel, hashCode, isHard, removeConstraintListener, removeVariable, setModel, variables`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### RoomConstraint

          public RoomConstraint(Long id,
                                String name,
                                Long buildingId,
                                int capacity,
                                RoomSharingModel roomSharingModel,
                                Double x,
                                Double y,
                                boolean ignoreTooFar,
                                boolean constraint)

      Constructor

  - ### Method Detail

    - #### setNotAvailable

          public void setNotAvailable(Placement placement)

    - #### isAvailable

          public boolean isAvailable(int slot)

    - #### isAvailable

          public boolean isAvailable(Lecture lecture,
                                     TimeLocation time,
                                     Long scheduler)

    - #### getAvailableArray

          public List<Placement>[] getAvailableArray()

    - #### getSharingModel

          public RoomSharingModel getSharingModel()

    - #### getResourceId

          public Long getResourceId()

      Room id

    - #### getBuildingId

          public Long getBuildingId()

      Building id

    - #### getName

          public String getName()

      Room name
      Overrides:
        `getName` in class `Constraint<Lecture,Placement>`

    - #### getRoomName

          public String getRoomName()

    - #### getCapacity

          public int getCapacity()

      Capacity

    - #### getPlacement

          public Placement getPlacement(int slot,
                                        int day)

    - #### computeConflicts

          public void computeConflicts(Placement placement,
                                       Set<Placement> conflicts)

      Description copied from class: `Constraint`
      The only method which has to be implemented by any constraint. It returns the values which needs to be unassigned in order to make this constraint consistent with the given value if it is assigned to its variable. The computed list of conflicting values is added to the given set of conflicts.
      Specified by:
        `computeConflicts` in class `Constraint<Lecture,Placement>`
      Parameters:
        `placement` - value to be assigned to its varaible
        `conflicts` - resultant set of conflicting values

    - #### inConflict

          public boolean inConflict(Placement placement)

      Description copied from class: `Constraint`
      Returns true if the given assignment is inconsistent with the existing assignments respecting this constraint. This method is used by MAC (see `MacPropagation`).
      Overrides:
        `inConflict` in class `Constraint<Lecture,Placement>`

    - #### isConsistent

          public boolean isConsistent(Placement p1,
                                      Placement p2)

      Description copied from class: `Constraint`
      Returns true if the given assignments are consistent respecting this constraint. This method is used by MAC (see `MacPropagation`).
      Overrides:
        `isConsistent` in class `Constraint<Lecture,Placement>`

    - #### assigned

          public void assigned(long iteration,
                               Placement placement)

      Description copied from class: `Constraint`
      Given value is to be assigned to its varable. In this method, the constraint should unassigns all varaibles which are in conflict with the given assignment because of this constraint.
      Overrides:
        `assigned` in class `Constraint<Lecture,Placement>`

    - #### unassigned

          public void unassigned(long iteration,
                                 Placement placement)

      Description copied from class: `Constraint`
      Given value is unassigned from its variable.
      Overrides:
        `unassigned` in class `Constraint<Lecture,Placement>`

    - #### getResource

          public List<Placement> getResource(int slot)

      Lookup table getResource()[slot] -> lecture using this room placed in the given time slot (null if empty)

    - #### getResourceOfWeek

          public Placement[] getResourceOfWeek(int startDay)

    - #### printUsage

          protected void printUsage(StringBuffer sb)

      Room usage

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

    - #### setCoordinates

          public void setCoordinates(Double x,
                                     Double y)

      Position of the building

    - #### getPosX

          public Double getPosX()

      X-position of the building

    - #### getPosY

          public Double getPosY()

      Y-position of the building

    - #### getIgnoreTooFar

          public boolean getIgnoreTooFar()

    - #### getConstraint

          public boolean getConstraint()

    - #### getType

          public Long getType()

    - #### setType

          public void setType(Long type)