Back to index

maxconsecutive.so module reference

Description

This module allows you to set a limit for the maximum number of consecutive events in a teacher's timetable. Additionally you can also set the number of different lectures that a teacher can have without a pause.

Two lectures are different if they differ in the title and the attending group of students (i.e. they must differ in the name of the event and all assigned constant resources). The way these lectures are defined in the XML file has no effect (for example with a single <event> tag with repeats or two identical <event> tags - see also consecutive.so documentation)

<module name="maxconsecutive" weight="60" mandatory="yes">
	<option name="max-consecutive">4</option>
	<option name="max-different">3</option>
</module>

With the above options the following combinations are allowed (where A, B, C denote time slots assigned to different lectures and . denotes a free time slot):

. A B C . (max-different limit reached)

. A A B B . (max-consecutive limit reached)

. A A B C . (both max-different and max-consecutive limits reached)

And the following combination isn't allowed:

A A B B C . (over the max-consecutive limit)

Required resource types

Configuration file must define the following resource types in order to use this module:

Defined resource restrictions

Defined tuple restrictions

Supported module options

max-consecutive

Use this option to specify the maximum length of a consecutive block of events in a teacher's timetable.

For example:

<module name="maxconsecutive" weight="60" mandatory="yes">
	<option name="max-consecutive">3</option>
</module>

In this case a teacher can have at most 3 lectures (3 occupied time slots) before requiring at least one time slot of pause.

max-different

Use this option to specify the maximum number of different events in a consecutive block of events in a teacher's timetable.

For example:

<module name="maxconsecutive" weight="60" mandatory="yes">
	<option name="max-different">2</option>
</module>

In this case a teacher can have at most 2 different lectures (and any number of occupied time slots) before requiring at least one time slot of pause.

Module groups

This module belongs to the following groups:

Author

Tomaz Solc, tomaz.solc@tablix.org

Back to index