schedulable.h

Go to the documentation of this file.

#ifndef SCHEDULABLE_CLASS
#define SCHEDULABLE_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : schedulable                                                       *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 1991-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/

#include "item_statistics.h"
#include "periodicity.h"

#include <data_struct/unique_id.h>
#include <mechanisms/heartbeat.h>
#include <nodes/safe_node.h>


class scheduling_id : public unique_int
{
public:
  inline scheduling_id(int initial) : unique_int(initial) {}
};



class SCHEDULING_CLASS_STYLE schedulable
: public nodes::safe_node,
  public periodicity,
  public virtual object_base
{
public:
  schedulable(const scheduling_id &item_id, int actor_id,
          const periodicity &when_to_schedule);

  virtual ~schedulable();

  IMPLEMENT_CLASS_NAME("schedulable");

  const scheduling_id &item_id() const { return _sched_id; }

  int actor_id() const { return _actor_id; }

  virtual int weight() const;

//deprecate this.  it's really the object base text form.
  virtual istring schedulable_text_form() const;

  const heartbeat &expiration() const { return _expiration_timer; }
  heartbeat &expiration() { return _expiration_timer; }

  const item_statistics &stats() const { return _stats; }
  item_statistics &stats() { return _stats; }

  bool preprocessed() const { return _preprocessed; }
  void preprocessed(bool state) { _preprocessed = state; }

private:
  int _actor_id;  
  scheduling_id _sched_id;  
  item_statistics _stats;  
  heartbeat _expiration_timer;

  bool _preprocessed;  
};

#endif

---