Back to index

fet  5.18.0
Public Member Functions | Public Attributes
ConstraintTeachersMaxHoursDaily Class Reference

This is a constraint, aimed at obtaining timetables which do not allow more than X hours in a day for any teacher. More...

#include <timeconstraint.h>

Inheritance diagram for ConstraintTeachersMaxHoursDaily:
Inheritance graph
[legend]
Collaboration diagram for ConstraintTeachersMaxHoursDaily:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ConstraintTeachersMaxHoursDaily ()
 ConstraintTeachersMaxHoursDaily (double wp, int maxhours)
QString getXmlDescription (Rules &r)
 Returns an XML description of this constraint.
bool computeInternalStructure (QWidget *parent, Rules &r)
 Computes the internal structure for this constraint.
bool hasInactiveActivities (Rules &r)
QString getDescription (Rules &r)
 Returns a small description string for this constraint.
QString getDetailedDescription (Rules &r)
 Returns a detailed description string for this constraint.
double fitness (Solution &c, Rules &r, QList< double > &cl, QList< QString > &dl, QString *conflictsString=NULL)
 The function that calculates the fitness of a solution, according to this constraint.
bool isRelatedToActivity (Rules &r, Activity *a)
 Returns true if this constraint is related to this activity.
bool isRelatedToTeacher (Teacher *t)
 Returns true if this constraint is related to this teacher.
bool isRelatedToSubject (Subject *s)
 Returns true if this constraint is related to this subject.
bool isRelatedToActivityTag (ActivityTag *s)
 Returns true if this constraint is related to this activity tag.
bool isRelatedToStudentsSet (Rules &r, StudentsSet *s)
 Returns true if this constraint is related to this students set.
bool hasWrongDayOrHour (Rules &r)
bool canRepairWrongDayOrHour (Rules &r)
bool repairWrongDayOrHour (Rules &r)

Public Attributes

int maxHoursDaily
 The maximum hours daily.
double weightPercentage
 The percentage weight of this constraint, 100% compulsory, 0% non-compulsory.
bool active
QString comments
int type
 Specifies the type of this constraint (using the above constants).

Detailed Description

This is a constraint, aimed at obtaining timetables which do not allow more than X hours in a day for any teacher.

Definition at line 732 of file timeconstraint.h.


Constructor & Destructor Documentation

Definition at line 2706 of file timeconstraint.cpp.

 : TimeConstraint(wp)
 {
       assert(maxhours>0);
       this->maxHoursDaily=maxhours;

       this->type=CONSTRAINT_TEACHERS_MAX_HOURS_DAILY;
}

Member Function Documentation

Implements TimeConstraint.

Definition at line 2895 of file timeconstraint.cpp.

{
       assert(hasWrongDayOrHour(r));
       
       return true;
}

Here is the call graph for this function:

bool ConstraintTeachersMaxHoursDaily::computeInternalStructure ( QWidget *  parent,
Rules r 
) [virtual]

Computes the internal structure for this constraint.

It returns false if the constraint is an activity related one and it depends on only inactive activities.

Implements TimeConstraint.

Definition at line 2715 of file timeconstraint.cpp.

{
       Q_UNUSED(parent);
       Q_UNUSED(r);
       
       return true;
}
double ConstraintTeachersMaxHoursDaily::fitness ( Solution c,
Rules r,
QList< double > &  cl,
QList< QString > &  dl,
QString *  conflictsString = NULL 
) [virtual]

The function that calculates the fitness of a solution, according to this constraint.

We need the rules to compute this fitness factor. If conflictsString!=NULL, it will be initialized with a text explaining where this restriction is broken.

Implements TimeConstraint.

Definition at line 2780 of file timeconstraint.cpp.

{
       //if the matrices subgroupsMatrix and teachersMatrix are already calculated, do not calculate them again!
       if(!c.teachersMatrixReady || !c.subgroupsMatrixReady){
              c.teachersMatrixReady=true;
              c.subgroupsMatrixReady=true;
              subgroups_conflicts = c.getSubgroupsMatrix(r, subgroupsMatrix);
              teachers_conflicts = c.getTeachersMatrix(r, teachersMatrix);

              c.changedForMatrixCalculation=false;
       }

       int nbroken;

       //without logging
       if(conflictsString==NULL){
              nbroken=0;
              for(int i=0; i<r.nInternalTeachers; i++){
                     for(int d=0; d<r.nDaysPerWeek; d++){
                            int n_hours_daily=0;
                            for(int h=0; h<r.nHoursPerDay; h++)
                                   if(teachersMatrix[i][d][h]>0)
                                          n_hours_daily++;

                            if(n_hours_daily>this->maxHoursDaily)
                                   nbroken++;
                     }
              }
       }
       //with logging
       else{
              nbroken=0;
              for(int i=0; i<r.nInternalTeachers; i++){
                     for(int d=0; d<r.nDaysPerWeek; d++){
                            int n_hours_daily=0;
                            for(int h=0; h<r.nHoursPerDay; h++)
                                   if(teachersMatrix[i][d][h]>0)
                                          n_hours_daily++;

                            if(n_hours_daily>this->maxHoursDaily){
                                   nbroken++;

                                   if(conflictsString!=NULL){
                                          QString s=(tr(
                                           "Time constraint teachers max %1 hours daily broken for teacher %2, on day %3, length=%4.")
                                           .arg(CustomFETString::number(this->maxHoursDaily))
                                           .arg(r.internalTeachersList[i]->name)
                                           .arg(r.daysOfTheWeek[d])
                                           .arg(n_hours_daily)
                                           )
                                           +
                                           " "
                                           +
                                           (tr("This increases the conflicts total by %1").arg(CustomFETString::number(weightPercentage/100)));
                                          
                                          dl.append(s);
                                          cl.append(weightPercentage/100);
                                   
                                          *conflictsString+= s+"\n";
                                   }
                            }
                     }
              }
       }

       if(weightPercentage==100)
              assert(nbroken==0);
       return weightPercentage/100 * nbroken;
}

Here is the call graph for this function:

Returns a small description string for this constraint.

Implements TimeConstraint.

Definition at line 2741 of file timeconstraint.cpp.

                                                               {
       Q_UNUSED(r);

       QString begin=QString("");
       if(!active)
              begin="X - ";
              
       QString end=QString("");
       if(!comments.isEmpty())
              end=", "+tr("C: %1", "Comments").arg(comments);
              
       QString s;
       s+=tr("Teachers max hours daily"), s+=", ";
       s+=tr("WP:%1\%", "Weight percentage").arg(CustomFETString::number(this->weightPercentage));s+=", ";
       s+=tr("MH:%1", "Maximum hours (daily)").arg(this->maxHoursDaily);

       return begin+s+end;
}

Here is the call graph for this function:

Returns a detailed description string for this constraint.

Implements TimeConstraint.

Definition at line 2760 of file timeconstraint.cpp.

                                                                       {
       Q_UNUSED(r);

       QString s=tr("Time constraint");s+="\n";
       s+=tr("All teachers must respect the maximum number of hours daily");s+="\n";
       s+=tr("Weight (percentage)=%1\%").arg(CustomFETString::number(this->weightPercentage));s+="\n";
       s+=tr("Maximum hours daily=%1").arg(this->maxHoursDaily);s+="\n";

       if(!active){
              s+=tr("Active=%1", "Refers to a constraint").arg(yesNoTranslated(active));
              s+="\n";
       }
       if(!comments.isEmpty()){
              s+=tr("Comments=%1").arg(comments);
              s+="\n";
       }

       return s;
}

Here is the call graph for this function:

Returns an XML description of this constraint.

Implements TimeConstraint.

Definition at line 2729 of file timeconstraint.cpp.

                                                                  {
       Q_UNUSED(r);

       QString s="<ConstraintTeachersMaxHoursDaily>\n";
       s+="   <Weight_Percentage>"+CustomFETString::number(this->weightPercentage)+"</Weight_Percentage>\n";
       s+="   <Maximum_Hours_Daily>"+CustomFETString::number(this->maxHoursDaily)+"</Maximum_Hours_Daily>\n";
       s+="   <Active>"+trueFalse(active)+"</Active>\n";
       s+="   <Comments>"+protect(comments)+"</Comments>\n";
       s+="</ConstraintTeachersMaxHoursDaily>\n";
       return s;
}

Here is the call graph for this function:

Implements TimeConstraint.

Definition at line 2723 of file timeconstraint.cpp.

{
       Q_UNUSED(r);
       return false;
}

Implements TimeConstraint.

Definition at line 2887 of file timeconstraint.cpp.

{
       if(maxHoursDaily>r.nHoursPerDay)
              return true;
              
       return false;
}

Here is the caller graph for this function:

Returns true if this constraint is related to this activity.

Implements TimeConstraint.

Definition at line 2850 of file timeconstraint.cpp.

{
       Q_UNUSED(r);
       Q_UNUSED(a);

       return false;
}

Returns true if this constraint is related to this activity tag.

Implements TimeConstraint.

Definition at line 2872 of file timeconstraint.cpp.

{
       Q_UNUSED(s);

       return false;
}

Returns true if this constraint is related to this students set.

Implements TimeConstraint.

Definition at line 2879 of file timeconstraint.cpp.

{
       Q_UNUSED(r);
       Q_UNUSED(s);

       return false;
}

Returns true if this constraint is related to this subject.

Implements TimeConstraint.

Definition at line 2865 of file timeconstraint.cpp.

{
       Q_UNUSED(s);

       return false;
}

Returns true if this constraint is related to this teacher.

Implements TimeConstraint.

Definition at line 2858 of file timeconstraint.cpp.

{
       Q_UNUSED(t);

       return true;
}

Implements TimeConstraint.

Definition at line 2902 of file timeconstraint.cpp.

Here is the call graph for this function:


Member Data Documentation

bool TimeConstraint::active [inherited]

Definition at line 146 of file timeconstraint.h.

QString TimeConstraint::comments [inherited]

Definition at line 148 of file timeconstraint.h.

The maximum hours daily.

Definition at line 739 of file timeconstraint.h.

int TimeConstraint::type [inherited]

Specifies the type of this constraint (using the above constants).

Definition at line 153 of file timeconstraint.h.

The percentage weight of this constraint, 100% compulsory, 0% non-compulsory.

Definition at line 144 of file timeconstraint.h.


The documentation for this class was generated from the following files: