1 files changed, 325 insertions, 0 deletions
diff --git a/kplato/kptschedule.h b/kplato/kptschedule.h
new file mode 100644
index 00000000..29cb135d
--- /dev/null
+++ b/kplato/kptschedule.h
@@ -0,0 +1,325 @@
+/* This file is part of the KDE project
+   Copyright (C) 2005 Dag Andersen <[email protected]>
+
+   This library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Library General Public
+   License as published by the Free Software Foundation;
+   version 2 of the License.
+
+   This library is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   Library General Public License for more details.
+
+   You should have received a copy of the GNU Library General Public License
+   along with this library; see the file COPYING.LIB.  If not, write to
+   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+   Boston, MA 02110-1301, USA.
+*/
+
+#ifndef KPTSCHEDULE_H
+#define KPTSCHEDULE_H
+
+#include "kpteffortcostmap.h"
+#include "kptresource.h"
+
+#include <qintdict.h>
+#include <qptrlist.h>
+#include <qstring.h>
+
+class QDomElement;
+class QStringList;
+
+namespace KPlato
+{
+
+class Appointment;
+class DateTime;
+class Duration;
+class Node;
+class Task;
+
+/**
+ * The Schedule class holds data calculated during project
+ * calculation and scheduling, eg start- and end-times and
+ * appointments.
+ * There is one schedule per node and one per resource.
+ * Schedules can be of type Expected, Optimistic or Pessimistic
+ * refering to which estimate is used for the calculation.
+ * Schedule is subclassed into:
+ * MainSchedule     Used by the main project.
+ * NodeSchedule     Used by all other nodes (tasks).
+ * ResourceSchedule Used by resources.
+ */
+class Schedule
+{
+public:
+    //NOTE: Must match Effort::Use atm.
+    enum Type { Expected=0, //Effort::Use_Expected
+                Optimistic=1, //Effort::Use_Optimistic
+                Pessimistic=2 //Effort::Use_Pessimistic
+    };
+    
+    Schedule();
+    Schedule(Schedule *parent);
+    Schedule(QString name, Type type, long id);
+    ~Schedule();
+    
+    QString name() const { return m_name; }
+    void setName(QString name) { m_name = name; }
+    Type type() const { return m_type; }
+    void setType(Type type) { m_type = type; }
+    void setType(QString type);
+    QString typeToString(bool translate=false) const;
+    long id() const { return m_id; }
+    void setId(long id) { m_id = id; }
+    void setParent(Schedule *parent);
+    Schedule *parent() const { return m_parent; }
+    virtual bool isDeleted() const;
+    virtual void setDeleted(bool on);
+    
+    virtual Resource *resource() const { return 0; }
+    virtual Node *node() const { return 0; }
+    
+    virtual bool loadXML(const QDomElement &element);
+    virtual void saveXML(QDomElement &element) const;
+    void saveCommonXML(QDomElement &element) const;
+    void saveAppointments(QDomElement &element) const;
+    
+    /// Return the list of appointments
+    QPtrList<Appointment> &appointments() { return m_appointments; }
+    /// Adds appointment to this schedule only
+    virtual bool add(Appointment *appointment);
+    /// Adds appointment to both this resource schedule and node schedule
+    virtual void addAppointment(Schedule */*other*/, DateTime &/*start*/, DateTime &/*end*/, double /*load*/=100) {}
+    /// removes appointment and deletes it (independent of setAutoDelete)
+    void removeAppointment(Appointment *appointment);
+    /// removes appointment without deleting it (independent of setAutoDelete)
+    void takeAppointment(Appointment *appointment);
+    Appointment *findAppointment(Schedule *resource, Schedule *node);
+    
+    Appointment appointmentIntervals() const;
+    
+    virtual bool isOverbooked() const { return false; }
+    virtual bool isOverbooked(const DateTime &/*start*/, const DateTime &/*end*/) const { return false; }
+    virtual QStringList overbookedResources() const;
+    
+    virtual EffortCostMap plannedEffortCostPrDay(const QDate &start, const QDate &end) const;
+        
+    /// Returns the total planned effort for this task (or subtasks) 
+    virtual Duration plannedEffort() const;
+    /// Returns the total planned effort for this task (or subtasks) on date
+    virtual Duration plannedEffort(const QDate &date) const;
+    /// Returns the planned effort up to and including date
+    virtual Duration plannedEffortTo(const QDate &date) const;
+    
+    /// Returns the total actual effort for this task (or subtasks) 
+    virtual Duration actualEffort() const;
+    /// Returns the total actual effort for this task (or subtasks) on date
+    virtual Duration actualEffort(const QDate &date) const;
+    /// Returns the total actual effort for this task (or subtasks) up to and including date
+    virtual Duration actualEffortTo(const QDate &date) const;
+    
+    /**
+     * Planned cost is the sum total of all resources and other costs
+     * planned for this node.
+     */
+    virtual double plannedCost() const; 
+    
+    /// Planned cost on date
+    virtual double plannedCost(const QDate &date) const;
+    /**
+     * Planned cost from start of activity up to and including date
+     * is the sum of all resource costs and other costs planned for this node.
+     */
+    virtual double plannedCostTo(const QDate &date) const;
+    /**
+     * Actual cost is the sum total of the reported costs actually used
+     * for this node.
+     */
+    virtual double actualCost() const;
+    /// Actual cost on date
+    virtual double actualCost(const QDate &date) const;
+    /// Actual cost up to and including date
+    virtual double actualCostTo(const QDate &date) const;
+    
+    /// Effort based performance index
+    double effortPerformanceIndex(const QDate &/*date*/, bool */*error=0*/) { return 0.0; }
+    /// Cost performance index
+    double costPerformanceIndex(const QDate &/*date*/, bool */*error=0*/) { return 0.0; }
+
+    virtual double normalRatePrHour() const { return 0.0; }
+
+    void setEarliestStart(DateTime &dt) { earliestStart = dt; }
+    void setLatestFinish(DateTime &dt) { latestFinish = dt; }
+
+    virtual void initiateCalculation();
+    virtual void calcResourceOverbooked();
+
+    void setScheduled(bool on) { notScheduled = !on; }
+    bool isScheduled() const { return !notScheduled; }
+    
+    DateTime start() const { return startTime; }
+    DateTime end() const { return endTime; }
+    
+protected:
+    QString m_name;
+    Type m_type;
+    long m_id;
+    bool m_deleted;
+
+    QPtrList<Appointment> m_appointments;
+    Schedule *m_parent;
+    
+    friend class Node;
+    friend class Task;
+    friend class Project;
+    friend class Resource;
+    friend class RecalculateProjectCmd;
+    /** 
+      * earliestStart is calculated by PERT/CPM.
+      * A task may be scheduled to start later because of constraints
+      * or resource availability etc.
+      */
+    DateTime earliestStart;
+    /** 
+      * latestFinish is calculated by PERT/CPM.
+      * A task may be scheduled to finish earlier because of constraints
+      * or resource availability etc.
+      */
+    DateTime latestFinish;
+    /**  startTime is the scheduled start time.
+      *  It depends on constraints (i.e. ASAP/ALAP) and resource availability.
+      *  It will always be later or equal to @ref earliestStart
+      */
+    DateTime startTime;
+    /**  
+      *  m_endTime is the scheduled finish time.
+      *  It depends on constraints (i.e. ASAP/ALAP) and resource availability.
+      *  It will always be earlier or equal to @ref latestFinish
+      */
+    DateTime endTime;
+    /**  
+      *  duration is the scheduled duration which depends on
+      *  e.g. estimated effort, allocated resources and risk
+      */
+    Duration duration;
+
+    /// Set if EffortType == Effort, but no resource is requested
+    bool resourceError;
+    /// Set if the assigned resource is overbooked
+    bool resourceOverbooked;
+    /// Set if the requested resource is not available
+    bool resourceNotAvailable;
+    /// Set if the task cannot be scheduled to fullfill all the constraints
+    bool schedulingError;
+    /// Set if the node has not been scheduled
+    bool notScheduled;
+
+    DateTime workStartTime;
+    DateTime workEndTime;
+    bool inCriticalPath;
+
+#ifndef NDEBUG
+public:
+    virtual void printDebug(QString ident);
+#endif
+};
+
+/**
+ * NodeSchedule holds scheduling information for a node (task).
+ * 
+ */
+class NodeSchedule : public Schedule
+{
+public:
+    NodeSchedule();
+    NodeSchedule(Node *node, QString name, Schedule::Type type, long id);
+    NodeSchedule(Schedule *parent, Node *node);
+    ~NodeSchedule();
+    
+    virtual bool isDeleted() const 
+        { return m_parent == 0 ? true : m_parent->isDeleted(); }
+    void setDeleted(bool on);
+    
+    virtual bool loadXML(const QDomElement &element);
+    virtual void saveXML(QDomElement &element) const;
+
+// tasks------------>
+    virtual void addAppointment(Schedule *resource, DateTime &start, DateTime &end, double load=100);
+    
+    virtual Node *node() const { return m_node; }
+    virtual void setNode(Node *n) { m_node = n; }
+    
+protected:
+    void init();
+
+private:
+    Node *m_node;
+    
+#ifndef NDEBUG
+public:
+    virtual void printDebug(QString ident);
+#endif
+};
+
+/**
+ * ResourceSchedule holds scheduling information for a resource.
+ * 
+ */
+class ResourceSchedule : public Schedule
+{
+public:
+    ResourceSchedule();
+    ResourceSchedule(Resource *Resource, QString name, Schedule::Type type, long id);
+    ResourceSchedule(Schedule *parent, Resource *Resource);
+    ~ResourceSchedule();
+    
+    virtual bool isDeleted() const 
+        { return m_parent == 0 ? true : m_parent->isDeleted(); }
+    virtual void addAppointment(Schedule *node, DateTime &start, DateTime &end, double load=100);
+    
+    virtual bool isOverbooked() const;
+    virtual bool isOverbooked(const DateTime &start, const DateTime &end) const;
+    Appointment appointmentIntervals() const;
+    
+    virtual Resource *resource() const { return m_resource; }
+    virtual double normalRatePrHour() const;
+    
+private:
+    Resource *m_resource;
+    Schedule *m_parent;
+
+#ifndef NDEBUG
+public:
+    virtual void printDebug(QString ident);
+#endif
+};
+
+/**
+ * MainSchedule holds scheduling information for the main project node.
+ * 
+ */
+class MainSchedule : public NodeSchedule
+{
+public:
+    MainSchedule();
+    MainSchedule(Node *node, QString name, Schedule::Type type, long id);
+    ~MainSchedule();
+    virtual bool isDeleted() const { return m_deleted; }
+
+    virtual bool loadXML(const QDomElement &element, Project &project);
+    virtual void saveXML(QDomElement &element) const;
+
+private:
+
+#ifndef NDEBUG
+public:
+    virtual void printDebug(QString ident);
+#endif
+};
+
+
+} //namespace KPlato
+
+#endif