KPlato::Schedule Class Reference

#include <kptschedule.h>

Inherited by KPlato::NodeSchedule, and KPlato::ResourceSchedule.

Inheritance diagram for KPlato::Schedule:


Public Types
enum	Type { Expected = 0, Optimistic = 1, Pessimistic = 2 }
Public Member Functions
	Schedule ()
	Schedule (Schedule *parent)
	Schedule (QString name, Type type, long id)
virtual	~Schedule ()
QString	name () const
void	setName (QString name)
Type	type () const
void	setType (Type type)
void	setType (QString type)
QString	typeToString (bool translate=false) const
long	id () const
void	setId (long id)
void	setParent (Schedule *parent)
Schedule *	parent () const
virtual bool	isDeleted () const
virtual void	setDeleted (bool on)
virtual Resource *	resource () const
virtual Node *	node () const
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 the list of appointments.
virtual bool	add (Appointment *appointment)
	Adds appointment to this schedule only.
virtual void	addAppointment (Schedule *, DateTime &, DateTime &, double=100)
	Adds appointment to both this resource schedule and node schedule.
void	removeAppointment (Appointment *appointment)
	removes appointment and deletes it.
virtual void	takeAppointment (Appointment *appointment)
	removes appointment without deleting it.
Appointment *	findAppointment (Schedule resource, Schedule node)
Appointment	appointmentIntervals () const
virtual bool	isOverbooked () const
virtual bool	isOverbooked (const DateTime &, const DateTime &) const
virtual QStringList	overbookedResources () const
virtual EffortCostMap	plannedEffortCostPrDay (const QDate &start, const QDate &end) const
virtual Duration	plannedEffort () const
	Returns the total planned effort for this task (or subtasks).
virtual Duration	plannedEffort (const QDate &date) const
	Returns the total planned effort for this task (or subtasks) on date.
virtual Duration	plannedEffortTo (const QDate &date) const
	Returns the planned effort up to and including date.
virtual Duration	actualEffort () const
	Returns the total actual effort for this task (or subtasks).
virtual Duration	actualEffort (const QDate &date) const
	Returns the total actual effort for this task (or subtasks) on date.
virtual Duration	actualEffortTo (const QDate &date) const
	Returns the total actual effort for this task (or subtasks) up to and including date.
virtual double	plannedCost () const
virtual double	plannedCost (const QDate &date) const
	Planned cost on date.
virtual double	plannedCostTo (const QDate &date) const
virtual double	actualCost () const
virtual double	actualCost (const QDate &date) const
	Actual cost on date.
virtual double	actualCostTo (const QDate &date) const
	Actual cost up to and including date.
double	effortPerformanceIndex (const QDate &, bool *)
	Effort based performance index.
double	costPerformanceIndex (const QDate &, bool *)
	Cost performance index.
virtual double	normalRatePrHour () const
void	setEarliestStart (DateTime &dt)
void	setLatestFinish (DateTime &dt)
virtual void	initiateCalculation ()
virtual void	calcResourceOverbooked ()
void	setScheduled (bool on)
bool	isScheduled () const
DateTime	start () const
DateTime	end () const
virtual void	printDebug (QString ident)
Protected Attributes
QString	m_name
Type	m_type
long	m_id
bool	m_deleted
QList< Appointment * >	m_appointments
Schedule *	m_parent
DateTime	earliestStart
DateTime	latestFinish
DateTime	startTime
DateTime	endTime
Duration	duration
bool	resourceError
	Set if EffortType == Effort, but no resource is requested.
bool	resourceOverbooked
	Set if the assigned resource is overbooked.
bool	resourceNotAvailable
	Set if the requested resource is not available.
bool	schedulingError
	Set if the task cannot be scheduled to fullfill all the constraints.
bool	notScheduled
	Set if the node has not been scheduled.
DateTime	workStartTime
DateTime	workEndTime
bool	inCriticalPath
Friends
class	Node
class	Task
class	Project
class	Resource
class	RecalculateProjectCmd

Detailed Description

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.

Definition at line 52 of file kptschedule.h.

Member Enumeration Documentation

enum KPlato::Schedule::Type

Enumerator:

Expected
Optimistic
Pessimistic

Definition at line 56 of file kptschedule.h.

Constructor & Destructor Documentation

KPlato::Schedule::Schedule ( )

Definition at line 37 of file kptschedule.cc.

KPlato::Schedule::Schedule ( Schedule * parent )

Definition at line 44 of file kptschedule.cc.

References id(), m_id, m_name, m_type, name(), parent(), and type().

KPlato::Schedule::Schedule	(	QString	name,
		Type	type,
		long	id
	)

Definition at line 60 of file kptschedule.cc.

KPlato::Schedule::~Schedule ( ) [virtual]

Definition at line 72 of file kptschedule.cc.

References m_appointments.

Member Function Documentation

QString KPlato::Schedule::name ( ) const [inline]

Definition at line 66 of file kptschedule.h.

References m_name.

Referenced by KPlato::RecalculateProjectCmd::execute(), KPlato::Node::findSchedule(), KPlato::Appointment::loadXML(), KPlato::Node::printDebug(), KPlato::Appointment::printDebug(), and Schedule().

void KPlato::Schedule::setName ( QString name ) [inline]

Definition at line 67 of file kptschedule.h.

References m_name.

Type KPlato::Schedule::type ( ) const [inline]

Definition at line 68 of file kptschedule.h.

References m_type.

Referenced by KPlato::Project::calculate(), KPlato::Task::effortMetError(), KPlato::RecalculateProjectCmd::execute(), KPlato::Node::findSchedule(), KPlato::Node::printDebug(), KPlato::Appointment::printDebug(), Schedule(), and KPlato::View::setScheduleActionsEnabled().

void KPlato::Schedule::setType ( Type type ) [inline]

Definition at line 69 of file kptschedule.h.

References m_type.

Referenced by loadXML().

void KPlato::Schedule::setType ( QString type )

Definition at line 95 of file kptschedule.cc.

References Expected, m_type, Optimistic, and Pessimistic.

QString KPlato::Schedule::typeToString ( bool translate = false ) const

Definition at line 106 of file kptschedule.cc.

References Expected, m_type, Optimistic, and Pessimistic.

Referenced by KPlato::MainProjectPanel::MainProjectPanel(), printDebug(), and saveCommonXML().

long KPlato::Schedule::id ( ) const [inline]

void KPlato::Schedule::setId ( long id ) [inline]

Definition at line 73 of file kptschedule.h.

References m_id.

void KPlato::Schedule::setParent ( Schedule * parent )

Definition at line 79 of file kptschedule.cc.

References m_parent, and parent().

Referenced by KPlato::Node::setParentSchedule().

Schedule* KPlato::Schedule::parent ( ) const [inline]

Definition at line 75 of file kptschedule.h.

References m_parent.

Referenced by KPlato::Resource::addAppointment(), KPlato::Node::addAppointment(), Schedule(), and setParent().

bool KPlato::Schedule::isDeleted ( ) const [virtual]

Reimplemented in KPlato::NodeSchedule, KPlato::ResourceSchedule, and KPlato::MainSchedule.

Definition at line 90 of file kptschedule.cc.

References isDeleted(), m_deleted, and m_parent.

Referenced by KPlato::NamedCommand::addSchDeleted(), KPlato::Node::findSchedule(), KPlato::ResourceSchedule::isDeleted(), KPlato::NodeSchedule::isDeleted(), isDeleted(), KPlato::Node::notScheduled(), printDebug(), KPlato::Task::save(), and KPlato::Project::save().

void KPlato::Schedule::setDeleted ( bool on ) [virtual]

Reimplemented in KPlato::NodeSchedule.

Definition at line 84 of file kptschedule.cc.

References m_deleted.

Referenced by KPlato::RecalculateProjectCmd::execute(), KPlato::CalculateProjectCmd::execute(), KPlato::Node::setScheduleDeleted(), KPlato::RecalculateProjectCmd::unexecute(), and KPlato::CalculateProjectCmd::unexecute().

virtual Resource* KPlato::Schedule::resource ( ) const [inline, virtual]

Reimplemented in KPlato::ResourceSchedule.

Definition at line 79 of file kptschedule.h.

Referenced by KPlato::Appointment::actualCost(), KPlato::Appointment::actualCostTo(), KPlato::NodeSchedule::addAppointment(), findAppointment(), KPlato::GanttView::modifyTask(), KPlato::Appointment::plannedCost(), KPlato::Appointment::plannedCostTo(), KPlato::Appointment::printDebug(), and KPlato::Appointment::saveXML().

virtual Node* KPlato::Schedule::node ( ) const [inline, virtual]

Reimplemented in KPlato::NodeSchedule.

Definition at line 80 of file kptschedule.h.

Referenced by KPlato::ResourceSchedule::addAppointment(), KPlato::ResourceAppointmentsView::draw(), findAppointment(), KPlato::Appointment::printDebug(), and KPlato::Appointment::saveXML().

bool KPlato::Schedule::loadXML ( const QDomElement & element ) [virtual]

Reimplemented in KPlato::NodeSchedule.

Definition at line 162 of file kptschedule.cc.

References m_id, m_name, and setType().

Referenced by KPlato::MainSchedule::loadXML(), and KPlato::NodeSchedule::loadXML().

void KPlato::Schedule::saveXML ( QDomElement & element ) const [virtual]

Reimplemented in KPlato::NodeSchedule, and KPlato::MainSchedule.

Definition at line 171 of file kptschedule.cc.

References saveCommonXML().

Referenced by KPlato::Task::save(), and KPlato::Project::save().

void KPlato::Schedule::saveCommonXML ( QDomElement & element ) const

Definition at line 178 of file kptschedule.cc.

References m_id, m_name, and typeToString().

Referenced by KPlato::MainSchedule::saveXML(), KPlato::NodeSchedule::saveXML(), and saveXML().

void KPlato::Schedule::saveAppointments ( QDomElement & element ) const

Definition at line 186 of file kptschedule.cc.

References m_appointments.

Referenced by KPlato::Task::saveAppointments().

QList<Appointment*>& KPlato::Schedule::appointments ( ) [inline]

Return the list of appointments.

Definition at line 88 of file kptschedule.h.

References m_appointments.

Referenced by KPlato::NamedCommand::addSchDeleted(), KPlato::NamedCommand::addSchScheduled(), KPlato::Resource::appointmentIntervals(), KPlato::Resource::appointments(), and KPlato::Node::appointments().

bool KPlato::Schedule::add ( Appointment * appointment ) [virtual]

Adds appointment to this schedule only.

Definition at line 195 of file kptschedule.cc.

References m_appointments.

Referenced by KPlato::ResourceSchedule::addAppointment(), KPlato::NodeSchedule::addAppointment(), KPlato::Resource::addAppointment(), KPlato::Node::addAppointment(), and KPlato::Appointment::attach().

virtual void KPlato::Schedule::addAppointment	(	Schedule *	,
		DateTime &	,
		DateTime &	,
		double	= `100`
	)			`[inline, virtual]`

Adds appointment to both this resource schedule and node schedule.

Reimplemented in KPlato::NodeSchedule, and KPlato::ResourceSchedule.

Definition at line 92 of file kptschedule.h.

Referenced by KPlato::Resource::addAppointment(), KPlato::Node::addAppointment(), and KPlato::Appointment::loadXML().

void KPlato::Schedule::removeAppointment ( Appointment * appointment )

removes appointment and deletes it.

Definition at line 207 of file kptschedule.cc.

References takeAppointment().

void KPlato::Schedule::takeAppointment ( Appointment * appointment ) [virtual]

removes appointment without deleting it.

Reimplemented in KPlato::NodeSchedule, and KPlato::ResourceSchedule.

Definition at line 213 of file kptschedule.cc.

Referenced by KPlato::Appointment::detach(), KPlato::Appointment::loadXML(), removeAppointment(), KPlato::ResourceSchedule::takeAppointment(), and KPlato::NodeSchedule::takeAppointment().

Appointment * KPlato::Schedule::findAppointment	(	Schedule *	resource,
		Schedule *	node
	)

Definition at line 216 of file kptschedule.cc.

References m_appointments, node(), and resource().

Referenced by KPlato::ResourceSchedule::addAppointment(), and KPlato::NodeSchedule::addAppointment().

Appointment KPlato::Schedule::appointmentIntervals ( ) const

Reimplemented in KPlato::ResourceSchedule.

virtual bool KPlato::Schedule::isOverbooked ( ) const [inline, virtual]

Reimplemented in KPlato::ResourceSchedule.

Definition at line 101 of file kptschedule.h.

Referenced by KPlato::Resource::isOverbooked().

virtual bool KPlato::Schedule::isOverbooked	(	const DateTime &	,
		const DateTime &
	)			const `[inline, virtual]`

Reimplemented in KPlato::ResourceSchedule.

Definition at line 102 of file kptschedule.h.

QStringList KPlato::Schedule::overbookedResources ( ) const [virtual]

Definition at line 149 of file kptschedule.cc.

References m_appointments.

Referenced by KPlato::Node::overbookedResources(), and KPlato::NodeSchedule::printDebug().

EffortCostMap KPlato::Schedule::plannedEffortCostPrDay	(	const QDate &	start,
		const QDate &	end
	)			const `[virtual]`

Definition at line 227 of file kptschedule.cc.

References m_appointments.

Referenced by KPlato::Task::plannedEffortCostPrDay().

Duration KPlato::Schedule::plannedEffort ( ) const [virtual]

Returns the total planned effort for this task (or subtasks).

Definition at line 239 of file kptschedule.cc.

References m_appointments.

Referenced by KPlato::Task::effortMetError(), KPlato::Task::plannedEffort(), and KPlato::Resource::plannedEffort().

Duration KPlato::Schedule::plannedEffort ( const QDate & date ) const [virtual]

Returns the total planned effort for this task (or subtasks) on date.

Definition at line 250 of file kptschedule.cc.

References m_appointments.

Duration KPlato::Schedule::plannedEffortTo ( const QDate & date ) const [virtual]

Returns the planned effort up to and including date.

Definition at line 261 of file kptschedule.cc.

References m_appointments.

Referenced by KPlato::Task::plannedEffortTo().

Duration KPlato::Schedule::actualEffort ( ) const [virtual]

Returns the total actual effort for this task (or subtasks).

Definition at line 272 of file kptschedule.cc.

References m_appointments.

Referenced by KPlato::Task::actualEffort().

Duration KPlato::Schedule::actualEffort ( const QDate & date ) const [virtual]

Returns the total actual effort for this task (or subtasks) on date.

Definition at line 283 of file kptschedule.cc.

References m_appointments.

Duration KPlato::Schedule::actualEffortTo ( const QDate & date ) const [virtual]

Returns the total actual effort for this task (or subtasks) up to and including date.

Definition at line 294 of file kptschedule.cc.

References m_appointments.

Referenced by KPlato::Task::actualEffortTo().

double KPlato::Schedule::plannedCost ( ) const [virtual]

Planned cost is the sum total of all resources and other costs planned for this node.

Definition at line 305 of file kptschedule.cc.

References m_appointments.

Referenced by KPlato::Task::plannedCost().

double KPlato::Schedule::plannedCost ( const QDate & date ) const [virtual]

Planned cost on date.

Definition at line 316 of file kptschedule.cc.

References m_appointments.

double KPlato::Schedule::plannedCostTo ( const QDate & date ) const [virtual]

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.

Definition at line 327 of file kptschedule.cc.

References m_appointments.

Referenced by KPlato::Task::plannedCostTo().

double KPlato::Schedule::actualCost ( ) const [virtual]

Actual cost is the sum total of the reported costs actually used for this node.

Definition at line 338 of file kptschedule.cc.

References m_appointments.

Referenced by KPlato::Task::actualCost().

double KPlato::Schedule::actualCost ( const QDate & date ) const [virtual]

Actual cost on date.

Definition at line 349 of file kptschedule.cc.

References m_appointments.

double KPlato::Schedule::actualCostTo ( const QDate & date ) const [virtual]

Actual cost up to and including date.

Definition at line 360 of file kptschedule.cc.

References m_appointments.

Referenced by KPlato::Task::actualCostTo().

double KPlato::Schedule::effortPerformanceIndex	(	const QDate &	,
		bool *
	)			`[inline]`

Effort based performance index.

Definition at line 145 of file kptschedule.h.

double KPlato::Schedule::costPerformanceIndex	(	const QDate &	,
		bool *
	)			`[inline]`

Cost performance index.

Definition at line 147 of file kptschedule.h.

virtual double KPlato::Schedule::normalRatePrHour ( ) const [inline, virtual]

Reimplemented in KPlato::ResourceSchedule.

Definition at line 149 of file kptschedule.h.

Referenced by KPlato::Appointment::plannedPrDay().

void KPlato::Schedule::setEarliestStart ( DateTime & dt ) [inline]

Definition at line 151 of file kptschedule.h.

References earliestStart.

void KPlato::Schedule::setLatestFinish ( DateTime & dt ) [inline]

Definition at line 152 of file kptschedule.h.

References latestFinish.

void KPlato::Schedule::initiateCalculation ( ) [virtual]

Definition at line 127 of file kptschedule.cc.

References inCriticalPath, resourceError, resourceOverbooked, schedulingError, workEndTime, and workStartTime.

Referenced by KPlato::Task::initiateCalculation().

void KPlato::Schedule::calcResourceOverbooked ( ) [virtual]

Definition at line 137 of file kptschedule.cc.

References endTime, m_appointments, resourceOverbooked, and startTime.

Referenced by KPlato::Task::calcResourceOverbooked().

void KPlato::Schedule::setScheduled ( bool on ) [inline]

Definition at line 157 of file kptschedule.h.

References notScheduled.

bool KPlato::Schedule::isScheduled ( ) const [inline]

Definition at line 158 of file kptschedule.h.

References notScheduled.

Referenced by KPlato::NamedCommand::addSchScheduled(), and KPlato::Project::save().

DateTime KPlato::Schedule::start ( ) const [inline]

Definition at line 160 of file kptschedule.h.

References startTime.

Referenced by KPlato::ResourceSchedule::addAppointment(), KPlato::NodeSchedule::addAppointment(), KPlato::ResourceSchedule::isOverbooked(), KPlato::ModifyResourceAvailableFromCmd::ModifyResourceAvailableFromCmd(), and KPlato::ModifyResourceAvailableUntilCmd::ModifyResourceAvailableUntilCmd().

DateTime KPlato::Schedule::end ( ) const [inline]

Definition at line 161 of file kptschedule.h.

References endTime.

Referenced by KPlato::ResourceSchedule::addAppointment(), KPlato::NodeSchedule::addAppointment(), and KPlato::ResourceSchedule::isOverbooked().

void KPlato::Schedule::printDebug ( QString ident ) [virtual]

Reimplemented in KPlato::NodeSchedule, KPlato::ResourceSchedule, and KPlato::MainSchedule.

Definition at line 679 of file kptschedule.cc.

References isDeleted(), m_id, m_name, m_type, and typeToString().

Referenced by KPlato::MainSchedule::printDebug(), KPlato::ResourceSchedule::printDebug(), KPlato::NodeSchedule::printDebug(), KPlato::Resource::printDebug(), and KPlato::Node::printDebug().

Friends And Related Function Documentation

friend class Node [friend]

Definition at line 172 of file kptschedule.h.

friend class Task [friend]

Definition at line 173 of file kptschedule.h.

friend class Project [friend]

Definition at line 174 of file kptschedule.h.

friend class Resource [friend]

Definition at line 175 of file kptschedule.h.

friend class RecalculateProjectCmd [friend]

Definition at line 176 of file kptschedule.h.

Member Data Documentation

QString KPlato::Schedule::m_name [protected]

Definition at line 164 of file kptschedule.h.

Referenced by loadXML(), name(), printDebug(), saveCommonXML(), Schedule(), and setName().

Type KPlato::Schedule::m_type [protected]

Definition at line 165 of file kptschedule.h.

Referenced by printDebug(), Schedule(), setType(), type(), and typeToString().

long KPlato::Schedule::m_id [protected]

Definition at line 166 of file kptschedule.h.

Referenced by id(), loadXML(), printDebug(), saveCommonXML(), Schedule(), and setId().

bool KPlato::Schedule::m_deleted [protected]

Definition at line 167 of file kptschedule.h.

Referenced by KPlato::MainSchedule::isDeleted(), isDeleted(), KPlato::NodeSchedule::setDeleted(), and setDeleted().

Schedule* KPlato::Schedule::m_parent [protected]

Reimplemented in KPlato::ResourceSchedule.

Definition at line 170 of file kptschedule.h.

Referenced by KPlato::NodeSchedule::isDeleted(), isDeleted(), parent(), KPlato::NodeSchedule::printDebug(), and setParent().

DateTime KPlato::Schedule::earliestStart [protected]

earliestStart is calculated by PERT/CPM. A task may be scheduled to start later because of constraints or resource availability etc.

Definition at line 182 of file kptschedule.h.

Referenced by KPlato::Task::adjustSummarytask(), KPlato::Task::calculateForward(), KPlato::Node::getEarliestStart(), KPlato::Task::isCritical(), KPlato::NodeSchedule::loadXML(), KPlato::Node::moveEarliestStart(), KPlato::MainSchedule::printDebug(), KPlato::NodeSchedule::printDebug(), KPlato::Node::propagateEarliestStart(), KPlato::NodeSchedule::saveXML(), KPlato::Task::scheduleBackward(), KPlato::Task::scheduleForward(), setEarliestStart(), and KPlato::Node::setEarliestStart().

DateTime KPlato::Schedule::latestFinish [protected]

latestFinish is calculated by PERT/CPM. A task may be scheduled to finish earlier because of constraints or resource availability etc.

Definition at line 188 of file kptschedule.h.

Referenced by KPlato::Task::adjustSummarytask(), KPlato::Task::calculateBackward(), KPlato::Node::getLatestFinish(), KPlato::Task::isCritical(), KPlato::NodeSchedule::loadXML(), KPlato::Node::moveLatestFinish(), KPlato::Task::positiveFloat(), KPlato::MainSchedule::printDebug(), KPlato::NodeSchedule::printDebug(), KPlato::Node::propagateLatestFinish(), KPlato::NodeSchedule::saveXML(), KPlato::Task::scheduleBackward(), KPlato::Task::scheduleForward(), setLatestFinish(), and KPlato::Node::setLatestFinish().

DateTime KPlato::Schedule::startTime [protected]

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 earliestStart

Definition at line 193 of file kptschedule.h.

Referenced by KPlato::Task::adjustSummarytask(), calcResourceOverbooked(), KPlato::Task::isCritical(), KPlato::Project::load(), KPlato::MainSchedule::loadXML(), KPlato::NodeSchedule::loadXML(), KPlato::Resource::makeAppointment(), KPlato::Task::positiveFloat(), KPlato::MainSchedule::printDebug(), KPlato::NodeSchedule::printDebug(), KPlato::MainSchedule::saveXML(), KPlato::NodeSchedule::saveXML(), KPlato::Task::scheduleBackward(), KPlato::Task::scheduleForward(), KPlato::Node::setStartTime(), start(), KPlato::Project::startTime(), KPlato::Node::startTime(), and KPlato::Task::workStartTime().

DateTime KPlato::Schedule::endTime [protected]

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 latestFinish

Definition at line 199 of file kptschedule.h.

Referenced by KPlato::Task::adjustSummarytask(), calcResourceOverbooked(), end(), KPlato::Project::endTime(), KPlato::Node::endTime(), KPlato::Task::isCritical(), KPlato::Project::load(), KPlato::MainSchedule::loadXML(), KPlato::NodeSchedule::loadXML(), KPlato::Resource::makeAppointment(), KPlato::Task::positiveFloat(), KPlato::MainSchedule::printDebug(), KPlato::NodeSchedule::printDebug(), KPlato::MainSchedule::saveXML(), KPlato::NodeSchedule::saveXML(), KPlato::Task::scheduleBackward(), KPlato::Task::scheduleForward(), KPlato::Node::setEndTime(), and KPlato::Task::workEndTime().