F:/KPlato/koffice/kplato/kptschedule.h

Aller à la documentation de ce fichier.

/* This file is part of the KDE project
 Copyright (C) 2005 Dag Andersen <danders@get2net.dk>

 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 <QString>

class QDomElement;
class QStringList;

namespace KPlato
{

class Appointment;
class DateTime;
class Duration;
class Node;
class Task;

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 );
    virtual ~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;

    QList<Appointment*> &appointments() { return m_appointments; }
    virtual bool add( Appointment *appointment );
    virtual void addAppointment( Schedule * /*other*/, DateTime & /*start*/, DateTime & /*end*/, double /*load*/ = 100 ) {}
    void removeAppointment( Appointment *appointment );
    virtual 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;

    virtual Duration plannedEffort() const;
    virtual Duration plannedEffort( const QDate &date ) const;
    virtual Duration plannedEffortTo( const QDate &date ) const;

    virtual Duration actualEffort() const;
    virtual Duration actualEffort( const QDate &date ) const;
    virtual Duration actualEffortTo( const QDate &date ) const;

    virtual double plannedCost() const;

    virtual double plannedCost( const QDate &date ) const;
    virtual double plannedCostTo( const QDate &date ) const;
    virtual double actualCost() const;
    virtual double actualCost( const QDate &date ) const;
    virtual double actualCostTo( const QDate &date ) const;

    double effortPerformanceIndex( const QDate & /*date*/, bool * /*error=0*/ ) { return 0.0; }
    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;

    QList<Appointment*> m_appointments;
    Schedule *m_parent;

    friend class Node;
    friend class Task;
    friend class Project;
    friend class Resource;
    friend class RecalculateProjectCmd;
    DateTime earliestStart;
    DateTime latestFinish;
    DateTime startTime;
    DateTime endTime;
    Duration duration;

    bool resourceError;
    bool resourceOverbooked;
    bool resourceNotAvailable;
    bool schedulingError;
    bool notScheduled;

    DateTime workStartTime;
    DateTime workEndTime;
    bool inCriticalPath;

#ifndef NDEBUG
public:
    virtual void printDebug( QString ident );
#endif
};

class NodeSchedule : public Schedule
{
public:
    NodeSchedule();
    NodeSchedule( Node *node, QString name, Schedule::Type type, long id );
    NodeSchedule( Schedule *parent, Node *node );
    virtual ~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 void takeAppointment( Appointment *appointment );

    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
};

class ResourceSchedule : public Schedule
{
public:
    ResourceSchedule();
    ResourceSchedule( Resource *Resource, QString name, Schedule::Type type, long id );
    ResourceSchedule( Schedule *parent, Resource *Resource );
    virtual ~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 void takeAppointment( Appointment *appointment );

    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
};

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

---