org.cpsolver.studentsct.report

## Class UnbalancedSectionsTable

- java.lang.Object
- - org.cpsolver.studentsct.report.UnbalancedSectionsTable

- All Implemented Interfaces:
    StudentSectioningReport

      public class UnbalancedSectionsTable
      extends Object
      implements StudentSectioningReport

  This class lists all unbalanced sections. Each line includes the class, its meeting time, number of enrolled students, desired section size, and the limit. The Target column show the ideal number of students the section (if all the sections were filled equally) and the Disbalance shows the % between the target and the current enrollment.
  Usage: new UnbalancedSectionsTable(model),createTable(true, true).save(aFile);
  Version:
    StudentSct 1.3 (Student Sectioning)
    Copyright (C) 2007 - 2014 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/.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `UnbalancedSectionsTable(StudentSectioningModel model)` Constructor

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `CSVFile` | `create(Assignment<Request,Enrollment> assignment, DataProperties properties)`
    `CSVFile` | `createTable(Assignment<Request,Enrollment> assignment, boolean includeLastLikeStudents, boolean includeRealStudents, boolean useAmPm)` Create report
    `StudentSectioningModel` | `getModel()` Return student sectioning model

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

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### UnbalancedSectionsTable

          public UnbalancedSectionsTable(StudentSectioningModel model)

      Constructor
      Parameters:
        `model` - student sectioning model

  - ### Method Detail

    - #### getModel

          public StudentSectioningModel getModel()

      Return student sectioning model
      Returns:
        problem model

    - #### createTable

          public CSVFile createTable(Assignment<Request,Enrollment> assignment,
                                     boolean includeLastLikeStudents,
                                     boolean includeRealStudents,
                                     boolean useAmPm)

      Create report
      Parameters:
        `assignment` - current assignment
        `includeLastLikeStudents` - true, if last-like students should be included (i.e., `Student.isDummy()` is true)
        `includeRealStudents` - true, if real students should be included (i.e., `Student.isDummy()` is false)
        `useAmPm` - use 12-hour format
      Returns:
        report as comma separated text file

    - #### create

          public CSVFile create(Assignment<Request,Enrollment> assignment,
                                DataProperties properties)

      Specified by:
        `create` in interface `StudentSectioningReport`