Back to index

fet  5.18.0
Public Member Functions | Public Attributes
ConstraintActivityPreferredRooms Class Reference

This is a constraint. More...

#include <spaceconstraint.h>

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

List of all members.

Public Member Functions

 ConstraintActivityPreferredRooms ()
 ConstraintActivityPreferredRooms (double wp, int aid, const QStringList &roomsList)
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 (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 isRelatedToRoom (Room *r)
 Returns true if this constraint is related to this room.
bool hasWrongDayOrHour (Rules &r)
bool canRepairWrongDayOrHour (Rules &r)
bool repairWrongDayOrHour (Rules &r)

Public Attributes

int _activity
QList< int > _rooms
int activityId
QStringList roomsNames
double weightPercentage
 The weight (percentage) of this constraint.
bool active
QString comments
int type
 Specifies the type of this constraint (using the above constants).

Detailed Description

This is a constraint.

Its purpose: an activity must take part in the preferred rooms.

Definition at line 352 of file spaceconstraint.h.


Constructor & Destructor Documentation

ConstraintActivityPreferredRooms::ConstraintActivityPreferredRooms ( double  wp,
int  aid,
const QStringList &  roomsList 
)

Definition at line 998 of file spaceconstraint.cpp.

       : SpaceConstraint(wp)
{
       this->type=CONSTRAINT_ACTIVITY_PREFERRED_ROOMS;
       this->activityId=aid;
       this->roomsNames=roomsList;
}

Member Function Documentation

Implements SpaceConstraint.

Definition at line 1222 of file spaceconstraint.cpp.

{
       Q_UNUSED(r);
       assert(0);

       return true;
}
bool ConstraintActivityPreferredRooms::computeInternalStructure ( QWidget *  parent,
Rules r 
) [virtual]

Computes the internal structure for this constraint.

Implements SpaceConstraint.

Definition at line 1006 of file spaceconstraint.cpp.

{
       this->_activity=-1;
       int ac;
       for(ac=0; ac<r.nInternalActivities; ac++)
              if(r.internalActivitiesList[ac].id==this->activityId){
                     assert(this->_activity==-1);
                     this->_activity=ac;
                     break;
              }
              
       if(ac==r.nInternalActivities){
              QMessageBox::warning(parent, tr("FET error in data"), 
                     tr("Following constraint is wrong:\n%1").arg(this->getDetailedDescription(r)));

              return false;
       }
       
       this->_rooms.clear();
       foreach(QString rm, this->roomsNames){
              int t=r.searchRoom(rm);

              if(t<0){
                     QMessageBox::warning(parent, tr("FET error in data"), 
                            tr("Following constraint is wrong:\n%1").arg(this->getDetailedDescription(r)));

                     return false;
              }

              assert(t>=0);
              this->_rooms.append(t);
       }
              
       return true;
}

Here is the call graph for this function:

double ConstraintActivityPreferredRooms::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. We need also the allocation of the activities on days and hours. If conflictsString!=NULL, it will be initialized with a text explaining where this restriction is broken.

Implements SpaceConstraint.

Definition at line 1117 of file spaceconstraint.cpp.

{
       //if the matrix roomsMatrix is already calculated, do not calculate it again!
       if(!c.roomsMatrixReady){
              c.roomsMatrixReady=true;
              rooms_conflicts = c.getRoomsMatrix(r, roomsMatrix);

              c.changedForMatrixCalculation=false;
       }

       //Calculates the number of conflicts

       int nbroken;
       
       bool ok=true;

       nbroken=0;

       int rm=c.rooms[this->_activity];
       if(1 || rm!=UNALLOCATED_SPACE){
              int i;
              for(i=0; i<this->_rooms.count(); i++)
                     if(this->_rooms.at(i)==rm)
                            break;
              if(i==this->_rooms.count()){
                     if(rm!=UNALLOCATED_SPACE){
                            ok=false;
              
                            if(conflictsString!=NULL){
                                   QString s=tr("Space constraint activity preferred rooms broken for activity with id=%1 (%2)"
                                          , "%1 is activity id, %2 is detailed description of activity")
                                          .arg(this->activityId)
                                          .arg(getActivityDetailedDescription(r, this->activityId));
                                   s += ". ";
                                   s += tr("This increases the conflicts total by %1").arg(CustomFETString::number(weightPercentage/100 * 1));
                            
                                   dl.append(s);
                                   cl.append(weightPercentage/100 * 1);
                            
                                   *conflictsString += s+"\n";
                            }

                            nbroken++;
                     }
              }
       }
       
       if(this->weightPercentage==100)
              assert(ok);

       return weightPercentage/100 * nbroken;
}

Here is the call graph for this function:

Returns a small description string for this constraint.

Implements SpaceConstraint.

Definition at line 1067 of file spaceconstraint.cpp.

                                                                {
       QString begin=QString("");
       if(!active)
              begin="X - ";

       QString end=QString("");
       if(!comments.isEmpty())
              end=", "+tr("C: %1", "Comments").arg(comments);

       QString s=tr("Activity preferred rooms"); s+=", ";
       s+=tr("WP:%1\%", "Weight percentage").arg(CustomFETString::number(this->weightPercentage));s+=", ";
       s+=tr("Id:%1 (%2)", "%1 is activity id, %2 is detailed description of activity")
              .arg(this->activityId)
              .arg(getActivityDetailedDescription(r, this->activityId));

       for(QStringList::Iterator it=this->roomsNames.begin(); it!=this->roomsNames.end(); it++){
              s+=", ";
              s+=tr("R:%1", "Room").arg(*it);
       }

       return begin+s+end;
}

Here is the call graph for this function:

Returns a detailed description string for this constraint.

Implements SpaceConstraint.

Definition at line 1090 of file spaceconstraint.cpp.

                                                                        {
       QString s=tr("Space constraint"); s+="\n";
       s+=tr("Activity preferred rooms"); s+="\n";
       s+=tr("Weight (percentage)=%1\%").arg(CustomFETString::number(this->weightPercentage));s+="\n";
       
       s+=tr("Activity id=%1 (%2)", "%1 is activity id, %2 is detailed description of activity")
              .arg(this->activityId)
              .arg(getActivityDetailedDescription(r, this->activityId));
       s+="\n";
       
       for(QStringList::Iterator it=this->roomsNames.begin(); it!=this->roomsNames.end(); it++){
              s+=tr("Room=%1").arg(*it);
              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 SpaceConstraint.

Definition at line 1050 of file spaceconstraint.cpp.

                                                                   {
       Q_UNUSED(r);

       QString s="<ConstraintActivityPreferredRooms>\n";
       s+="   <Weight_Percentage>"+CustomFETString::number(weightPercentage)+"</Weight_Percentage>\n";
       s+="   <Activity_Id>"+CustomFETString::number(this->activityId)+"</Activity_Id>\n";
       s+="   <Number_of_Preferred_Rooms>"+CustomFETString::number(this->roomsNames.count())+"</Number_of_Preferred_Rooms>\n";
       for(QStringList::Iterator it=this->roomsNames.begin(); it!=this->roomsNames.end(); it++)
              s+="   <Preferred_Room>"+protect(*it)+"</Preferred_Room>\n";
              
       s+="   <Active>"+trueFalse(active)+"</Active>\n";
       s+="   <Comments>"+protect(comments)+"</Comments>\n";
       s+="</ConstraintActivityPreferredRooms>\n";

       return s;
}

Here is the call graph for this function:

Implements SpaceConstraint.

Definition at line 1042 of file spaceconstraint.cpp.

{
       if(r.inactiveActivities.contains(this->activityId))
              return true;

       return false;
}

Implements SpaceConstraint.

Definition at line 1216 of file spaceconstraint.cpp.

{
       Q_UNUSED(r);
       return false;
}

Returns true if this constraint is related to this activity.

Implements SpaceConstraint.

Definition at line 1175 of file spaceconstraint.cpp.

{
       if(this->activityId==a->id)
              return true;
       return false;
}

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

Implements SpaceConstraint.

Definition at line 1196 of file spaceconstraint.cpp.

{
       Q_UNUSED(s);

       return false;
}

Returns true if this constraint is related to this room.

Implements SpaceConstraint.

Definition at line 1211 of file spaceconstraint.cpp.

{
       return this->roomsNames.contains(r->name);
}

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

Implements SpaceConstraint.

Definition at line 1203 of file spaceconstraint.cpp.

{
       Q_UNUSED(r);
       Q_UNUSED(s);

       return false;
}

Returns true if this constraint is related to this subject.

Implements SpaceConstraint.

Definition at line 1189 of file spaceconstraint.cpp.

{
       Q_UNUSED(s);

       return false;
}

Returns true if this constraint is related to this teacher.

Implements SpaceConstraint.

Definition at line 1182 of file spaceconstraint.cpp.

{
       Q_UNUSED(t);

       return false;
}

Implements SpaceConstraint.

Definition at line 1230 of file spaceconstraint.cpp.

{
       Q_UNUSED(r);
       assert(0); //should check hasWrongDayOrHour, firstly

       return true;
}

Member Data Documentation

Definition at line 359 of file spaceconstraint.h.

Definition at line 362 of file spaceconstraint.h.

bool SpaceConstraint::active [inherited]

Definition at line 102 of file spaceconstraint.h.

Definition at line 366 of file spaceconstraint.h.

QString SpaceConstraint::comments [inherited]

Definition at line 104 of file spaceconstraint.h.

Definition at line 368 of file spaceconstraint.h.

int SpaceConstraint::type [inherited]

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

Definition at line 109 of file spaceconstraint.h.

The weight (percentage) of this constraint.

Definition at line 100 of file spaceconstraint.h.


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