work_schedule.WorkSchedule Class Reference

Class WorkSchedule represents a named group of teams who collectively work one or more shifts with off-shift periods. More...

Inheritance diagram for work_schedule.WorkSchedule:

Public Member Functions
def	__init__ (self, str name, str description)
	Construct a work schedule. More...
def	deleteTeam (self, Team team)
	Remove this team from the schedule. More...
def	deleteNonWorkingPeriod (self, NonWorkingPeriod period)
	Remove a non-working period from the schedule. More...
[ShiftInstance]	getShiftInstancesForDay (self, date day)
	Get the list of shift instances for the specified date that start during that date. More...
[ShiftInstance]	getShiftInstancesForTime (self, datetime dateTime)
	Get the list of shift instances for the specified date and time of day. More...
Team	createTeam (self, str name, str description, Rotation rotation, time rotationStart)
	Create a team. More...
Shift	createShift (self, str name, str description, time start, timedelta duration)
	Create a shift. More...
def	deleteShift (self, Shift shift)
	Delete this shift. More...
NonWorkingPeriod	createNonWorkingPeriod (self, str name, str description, datetime startDateTime, timedelta duration)
	Create a non-working period of time. More...
Rotation	createRotation (self, str name, str description)
	Create a rotation. More...
timedelta	getRotationDuration (self)
	Get total duration of rotations across all teams. More...
timedelta	getRotationWorkingTime (self)
	Get the total working time for all team rotations. More...
timedelta	calculateWorkingTime (self, datetime fromTime, datetime toTime)
	Calculate the scheduled working time between the specified dates and times of day. More...
timedelta	calculateNonWorkingTime (self, datetime fromTime, datetime toTime)
	Calculate the non-working time between the specified dates and times of day. More...
def	printShiftInstances (self, date start, date end)
	Print shift instances. More...
str	__str__ (self)

Static Public Member Functions
time	getPeriodKey (NonWorkingPeriod period)
	Get the key for sorting non-working periods More...

Public Attributes
	teams
	shifts
	rotations
	nonWorkingPeriods

Static Public Attributes
	key

Detailed Description

Class WorkSchedule represents a named group of teams who collectively work one or more shifts with off-shift periods.

A work schedule can have periods of non-working time as well as breaks.

Constructor & Destructor Documentation

__init__()

def work_schedule.WorkSchedule.__init__	(		self,
		str	name,
		str	description
	)

Construct a work schedule.

Parameters

name	Schedule name
description	Schedule description

Member Function Documentation

calculateNonWorkingTime()

timedelta work_schedule.WorkSchedule.calculateNonWorkingTime	(		self,
		datetime	fromTime,
		datetime	toTime
	)

Calculate the non-working time between the specified dates and times of day.

Parameters

fromTime	Starting date and time of day
toTime	Ending date and time of day

Returns

Non-working time duration

calculateWorkingTime()

timedelta work_schedule.WorkSchedule.calculateWorkingTime	(		self,
		datetime	fromTime,
		datetime	toTime
	)

Calculate the scheduled working time between the specified dates and times of day.

Non-working periods are removed.

Parameters

fromTime	Starting date and time of day
toTime	Ending date and time of day

Returns

Working time duration

createNonWorkingPeriod()

NonWorkingPeriod work_schedule.WorkSchedule.createNonWorkingPeriod	(		self,
		str	name,
		str	description,
		datetime	startDateTime,
		timedelta	duration
	)

Create a non-working period of time.

Parameters

name	Name of period
description	Description of period
startDateTime	Starting date and time of day
duration	Duration of period

Returns

NonWorkingPeriod

createRotation()

Rotation work_schedule.WorkSchedule.createRotation	(		self,
		str	name,
		str	description
	)

Create a rotation.

Parameters

name	Name of rotation
description	Description of rotation

Returns

Rotation

createShift()

Shift work_schedule.WorkSchedule.createShift	(		self,
		str	name,
		str	description,
		time	start,
		timedelta	duration
	)

Create a shift.

Parameters

name	Name of shift
description	Description of shift
start	start time of day
duration	duration of shift

Returns

Shift

createTeam()

Team work_schedule.WorkSchedule.createTeam	(		self,
		str	name,
		str	description,
		Rotation	rotation,
		time	rotationStart
	)

Create a team.

Parameters

name	Name of team
description	description of team
rotation	rotation
rotationStart	Start of rotation

Returns

Team

deleteNonWorkingPeriod()

def work_schedule.WorkSchedule.deleteNonWorkingPeriod	(		self,
		NonWorkingPeriod	period
	)

Remove a non-working period from the schedule.

Parameters

period

NonWorkingPeriod

deleteShift()

def work_schedule.WorkSchedule.deleteShift	(		self,
		Shift	shift
	)

Delete this shift.

Parameters

shift

Shift to delete

deleteTeam()

def work_schedule.WorkSchedule.deleteTeam	(		self,
		Team	team
	)

Remove this team from the schedule.

Parameters

team

Team

getPeriodKey()

time work_schedule.WorkSchedule.getPeriodKey ( NonWorkingPeriod  period )

static

Get the key for sorting non-working periods

Parameters

period

NonWorkingPeriod

Returns

time key

getRotationDuration()

timedelta work_schedule.WorkSchedule.getRotationDuration

(

self

)

Get total duration of rotations across all teams.

Returns

Duration of team rotations

getRotationWorkingTime()

timedelta work_schedule.WorkSchedule.getRotationWorkingTime

(

self

)

Get the total working time for all team rotations.

Returns

sum of rotation working times

getShiftInstancesForDay()

[ShiftInstance] work_schedule.WorkSchedule.getShiftInstancesForDay	(		self,
		date	day
	)

Get the list of shift instances for the specified date that start during that date.

Parameters

day

date

Returns

list of ShiftInstance

getShiftInstancesForTime()

[ShiftInstance] work_schedule.WorkSchedule.getShiftInstancesForTime	(		self,
		datetime	dateTime
	)

Get the list of shift instances for the specified date and time of day.

Parameters

dateTime

Date and time of day

Returns

List of ShiftInstance

printShiftInstances()

def work_schedule.WorkSchedule.printShiftInstances	(		self,
		date	start,
		date	end
	)

Print shift instances.

Parameters

start	Starting date
end	Ending date

---

The documentation for this class was generated from the following file:

• work_schedule.py