Back to index

fet  5.18.0
Public Member Functions | Public Attributes
ConstraintTeacherNotAvailableTimes Class Reference

#include <timeconstraint.h>

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

List of all members.

Public Member Functions

 ConstraintTeacherNotAvailableTimes ()
 ConstraintTeacherNotAvailableTimes (double wp, const QString &tn, QList< int > d, QList< int > h)
bool computeInternalStructure (QWidget *parent, Rules &r)
 Computes the internal structure for this constraint.
bool hasInactiveActivities (Rules &r)
QString getXmlDescription (Rules &r)
 Returns an XML description of this constraint.
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

QList< int > days
QList< int > hours
QString teacher
 The teacher's name.
int teacher_ID
 The teacher's id, or index in the rules.
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

Definition at line 279 of file timeconstraint.h.


Constructor & Destructor Documentation

ConstraintTeacherNotAvailableTimes::ConstraintTeacherNotAvailableTimes ( double  wp,
const QString &  tn,
QList< int >  d,
QList< int >  h 
)

Definition at line 517 of file timeconstraint.cpp.

       : TimeConstraint(wp)
{
       this->teacher=tn;
       assert(d.count()==h.count());
       this->days=d;
       this->hours=h;
       this->type=CONSTRAINT_TEACHER_NOT_AVAILABLE_TIMES;
}

Member Function Documentation

Implements TimeConstraint.

Definition at line 760 of file timeconstraint.cpp.

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

Here is the call graph for this function:

bool ConstraintTeacherNotAvailableTimes::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 614 of file timeconstraint.cpp.

                                                                                          {
       this->teacher_ID=r.searchTeacher(this->teacher);

       if(this->teacher_ID<0){
              QMessageBox::warning(parent, tr("FET warning"),
               tr("Constraint teacher not available times is wrong because it refers to inexistent teacher."
               " Please correct it (removing it might be a solution). Please report potential bug. Constraint is:\n%1").arg(this->getDetailedDescription(r)));
               
              return false;
       }      

       assert(days.count()==hours.count());
       for(int k=0; k<days.count(); k++){
              if(this->days.at(k) >= r.nDaysPerWeek){
                     QMessageBox::information(parent, tr("FET information"),
                      tr("Constraint teacher not available times is wrong because it refers to removed day. Please correct"
                      " and try again. Correcting means editing the constraint and updating information. Constraint is:\n%1").arg(this->getDetailedDescription(r)));
               
                     return false;
              }             
              if(this->hours.at(k) >= r.nHoursPerDay){
                     QMessageBox::information(parent, tr("FET information"),
                      tr("Constraint teacher not available times is wrong because an hour is too late (after the last acceptable slot). Please correct"
                      " and try again. Correcting means editing the constraint and updating information. Constraint is:\n%1").arg(this->getDetailedDescription(r)));
               
                     return false;
              }
       }

       assert(this->teacher_ID>=0);
       return true;
}

Here is the call graph for this function:

double ConstraintTeacherNotAvailableTimes::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 653 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;
       }

       //Calculates the number of hours when the teacher is supposed to be teaching, but he is not available
       //This function consideres all the hours, I mean if there are for example 5 weekly courses
       //scheduled on that hour (which is already a broken compulsory restriction - we only
       //are allowed 1 weekly course for a certain teacher at a certain hour) we calculate
       //5 broken restrictions for that function.
       //TODO: decide if it is better to consider only 2 or 10 as a return value in this particular case
       //(currently it is 10)
       int tch=this->teacher_ID;

       int nbroken;

       nbroken=0;

       assert(days.count()==hours.count());
       for(int k=0; k<days.count(); k++){
              int d=days.at(k);
              int h=hours.at(k);
              
              if(teachersMatrix[tch][d][h]>0){
                     nbroken+=teachersMatrix[tch][d][h];
       
                     if(conflictsString!=NULL){
                            QString s= tr("Time constraint teacher not available");
                            s += " ";
                            s += tr("broken for teacher: %1 on day %2, hour %3")
                             .arg(r.internalTeachersList[tch]->name)
                             .arg(r.daysOfTheWeek[d])
                             .arg(r.hoursOfTheDay[h]);
                            s += ". ";
                            s += tr("This increases the conflicts total by %1")
                             .arg(CustomFETString::number(teachersMatrix[tch][d][h]*weightPercentage/100));
                             
                            dl.append(s);
                            cl.append(teachersMatrix[tch][d][h]*weightPercentage/100);
                     
                            *conflictsString += s+"\n";
                     }
              }
       }

       if(weightPercentage==100.0)
              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 549 of file timeconstraint.cpp.

                                                                  {
       QString begin=QString("");
       if(!active)
              begin="X - ";
              
       QString end=QString("");
       if(!comments.isEmpty())
              end=", "+tr("C: %1", "Comments").arg(comments);
              
       QString s=tr("Teacher not available");s+=", ";
       s+=tr("WP:%1\%", "Weight percentage").arg(CustomFETString::number(this->weightPercentage));s+=", ";
       s+=tr("T:%1", "Teacher").arg(this->teacher);s+=", ";

       s+=tr("NA at:", "Not available at");
       s+=" ";
       assert(days.count()==hours.count());
       for(int i=0; i<days.count(); i++){
              if(this->days.at(i)>=0){
                     s+=r.daysOfTheWeek[this->days.at(i)];
                     s+=" ";
              }
              if(this->hours.at(i)>=0){
                     s+=r.hoursOfTheDay[this->hours.at(i)];
              }
              if(i<days.count()-1)
                     s+="; ";
       }

       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 580 of file timeconstraint.cpp.

                                                                          {
       QString s=tr("Time constraint");s+="\n";
       s+=tr("A teacher is not available");s+="\n";
       s+=tr("Weight (percentage)=%1\%").arg(CustomFETString::number(this->weightPercentage));s+="\n";
       s+=tr("Teacher=%1").arg(this->teacher);s+="\n";

       s+=tr("Not available at:");
       s+="\n";
       assert(days.count()==hours.count());
       for(int i=0; i<days.count(); i++){
              if(this->days.at(i)>=0){
                     s+=r.daysOfTheWeek[this->days.at(i)];
                     s+=" ";
              }
              if(this->hours.at(i)>=0){
                     s+=r.hoursOfTheDay[this->hours.at(i)];
              }
              if(i<days.count()-1)
                     s+="; ";
       }
       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:

Here is the caller graph for this function:

Returns an XML description of this constraint.

Implements TimeConstraint.

Definition at line 527 of file timeconstraint.cpp.

                                                                     {
       QString s="<ConstraintTeacherNotAvailableTimes>\n";
       s+="   <Weight_Percentage>"+CustomFETString::number(weightPercentage)+"</Weight_Percentage>\n";
       s+="   <Teacher>"+protect(this->teacher)+"</Teacher>\n";

       s+="   <Number_of_Not_Available_Times>"+CustomFETString::number(this->days.count())+"</Number_of_Not_Available_Times>\n";
       assert(days.count()==hours.count());
       for(int i=0; i<days.count(); i++){
              s+="   <Not_Available_Time>\n";
              if(this->days.at(i)>=0)
                     s+="          <Day>"+protect(r.daysOfTheWeek[this->days.at(i)])+"</Day>\n";
              if(this->hours.at(i)>=0)
                     s+="          <Hour>"+protect(r.hoursOfTheDay[this->hours.at(i)])+"</Hour>\n";
              s+="   </Not_Available_Time>\n";
       }

       s+="   <Active>"+trueFalse(active)+"</Active>\n";
       s+="   <Comments>"+protect(comments)+"</Comments>\n";
       s+="</ConstraintTeacherNotAvailableTimes>\n";
       return s;
}

Here is the call graph for this function:

Implements TimeConstraint.

Definition at line 647 of file timeconstraint.cpp.

{
       Q_UNUSED(r);
       return false;
}

Implements TimeConstraint.

Definition at line 748 of file timeconstraint.cpp.

{
       assert(days.count()==hours.count());
       
       for(int i=0; i<days.count(); i++)
              if(days.at(i)<0 || days.at(i)>=r.nDaysPerWeek
               || hours.at(i)<0 || hours.at(i)>=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 711 of file timeconstraint.cpp.

{
       Q_UNUSED(a);
       Q_UNUSED(r);

       return false;
}

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

Implements TimeConstraint.

Definition at line 733 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 740 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 726 of file timeconstraint.cpp.

{
       Q_UNUSED(s);

       return false;
}

Returns true if this constraint is related to this teacher.

Implements TimeConstraint.

Definition at line 719 of file timeconstraint.cpp.

{
       if(this->teacher==t->name)
              return true;
       return false;
}

Implements TimeConstraint.

Definition at line 767 of file timeconstraint.cpp.

{
       assert(hasWrongDayOrHour(r));
       
       assert(days.count()==hours.count());
       
       QList<int> newDays;
       QList<int> newHours;
       
       for(int i=0; i<days.count(); i++)
              if(days.at(i)>=0 && days.at(i)<r.nDaysPerWeek
               && hours.at(i)>=0 && hours.at(i)<r.nHoursPerDay){
                     newDays.append(days.at(i));
                     newHours.append(hours.at(i));
              }
       
       days=newDays;
       hours=newHours;
       
       r.internalStructureComputed=false;
       setRulesModifiedAndOtherThings(&r);

       return true;
}

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.

Definition at line 283 of file timeconstraint.h.

Definition at line 284 of file timeconstraint.h.

The teacher's name.

Definition at line 289 of file timeconstraint.h.

The teacher's id, or index in the rules.

Definition at line 294 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: