---

algorithms/SSchedAlgorithm.h

Go to the documentation of this file.

/* #start# ***********************************************************

           Scheduling Simulator
        Lehrstuhl f"ur Effiziente Algorithmen
           Technische Universit"at M"unchen

 File    : $Id: SSchedAlgorithm.h,v 1.6 2003/03/13 19:23:44 taeubig Exp $

 Purpose : the base class for all scheduling algorithms. implements
           the part of the interface which is visible to the task
           system.

 RCS-Log:
 $Log: SSchedAlgorithm.h,v $
 Revision 1.6  2003/03/13 19:23:44  taeubig
 prob.dists in new dir, other changes, removed log messages

 Revision 1.5  2003/01/08 18:57:11  meierb
 added randomized release times

 Revision 1.1.1.1  2002/12/02 22:26:19  meierb
 my_schedule

 Revision 1.3  2002/11/13 18:18:29  taeubig
 Workarounds for using LEDA 4.4 and also the former releases

 Revision 1.2  2002/11/10 13:32:52  taeubig
 namespace and header include changes

 Revision 1.1  2002/08/29 12:59:58  taeubig
 Added the sources

 Revision 1.22  2001/07/16 12:44:29  taeubig
 Added getNameFromClass()

 Revision 1.21  2001/05/16 13:19:38  taeubig
 QT headers are included last because of "slots" conflict

 Revision 1.20  2000/08/22 01:06:44  taeubig
 Added self description level

 Revision 1.19  2000/07/05 21:51:47  mayerh
 added method getLeaBibEntry and made some changes

 Revision 1.18  2000/06/14 18:58:37  taeubig
 Added support for algorithm runtime comments

 Revision 1.17  2000/05/24 12:21:12  taeubig
 New compiler (gcc-2.95) and new Qt (2.1)
 Replaced "list" by "leda_list" etc.

 Revision 1.16  2000/04/19 20:00:02  mayerh
 deleted _matching attribute and corresponding functions

 Revision 1.15  2000/04/12 20:44:31  mayerh
 added attribute _matching to indicate whether a certain algorithm fits the requirements of a given problem

 Revision 1.14  2000/04/05 21:04:02  mayerh
 declared getName() and getClassification() as virtual (required by some compiler-versions)

 Revision 1.13  2000/03/28 13:03:05  hall
 updated Interface of SClassif and SSchedAlg.

 Revision 1.12  2000/01/12 11:31:34  zoidl
 added javadoc comments and cosmetic changes in getDescription

 Revision 1.11  2000/01/10 02:21:45  taeubig
 Declared clone()

 Revision 1.10  1999/12/21 15:35:38  zoidl
 changed getDescription(), now returning string instead string&

 Revision 1.9  1999/12/21 09:02:32  zoidl
 added getDescription() (info about problem, complexity, ... )

 Revision 1.8  1999/08/05 08:47:46  schickin
 purpose of important classes noted in the header-files

 Revision 1.7  1999/04/27 13:38:42  schickin
 well folks, that's the first demo version that really runs 8-)

 Revision 1.6  1999/02/10 15:05:39  schickin
 model-directory can be compiled now

 Revision 1.5  1999/02/10 10:50:35  schickin
 main loop for simulation added

 Revision 1.4  1999/02/09 17:17:15  schickin
 design changes: event system refined (+ interface of SSchedAlgorithm)

 Revision 1.3  1999/01/29 10:03:27  schickin
 Project-Headers added.


 * #end# ************************************************************* */

#ifndef SSCHEDALGORITHM_H
#define SSCHEDALGORITHM_H

// system header files
#include <LEDA/list.h>

#ifndef leda_list_item
#define leda_list_item list_item
#endif

// project header files
#include "../general/SEvent.h"
#include "../general/SObservable.h"
#include "../model/STaskSystem.h"
#include "../model/STSysSchedEvent.h"
#include "SClassification.h"
#include "SLeaBibEntry.h"

class STaskSystem;

class SAlgEvent: public SEvent {
 public:
  SAlgEvent(short int level) { _level = level; }

  virtual Type getType() const
    { return ALGEVENT; };
  short int getLevel() const
    { return _level; }

 private:
  short int _level;

};

class SSchedAlgorithm: public SObservable {

public:
  virtual ~SSchedAlgorithm() {};
  virtual void startup() {};
  
  virtual double innerLoop(const leda_list<STSysSchedEvent>& rEvents) =0;

  virtual bool isFinished() const;

  virtual const leda_string &getName() const = 0;
  static const leda_string &getNameFromClass();

  virtual const SClassification &getClassification() const = 0;

  virtual SLeaBibEntry &getLeaBibEntry() const = 0;

  virtual const leda_string getDescription() const = 0;
  
  STaskSystem& getTaskSystem()
    { return *_pTaskSys; };

  const STaskSystem& getTaskSystem() const
    { return *_pTaskSys; };

  virtual void setTaskSystem(STaskSystem& rTS)
    { _pTaskSys = &rTS; };
  
  //virtual SSchedAlgorithm* clone()
  //  { assert(false); };

  virtual leda_string getCurrentActionDescription(const int level) const
    { return actionDescription[level]; };

 protected:
  virtual void setCurrentActionDescription(const int level,
             leda_string descr);

 private:
  STaskSystem * _pTaskSys;
  leda_string actionDescription[3];
};

#endif //SSCHEDALGORITHM_H

---