1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<title>consecutive.so module reference</title>
<style type="text/css">
body {
font-family: sans-serif;
font-size: small;
}
pre {
background-color: #eeeeff;
border: solid 1px #000000;
padding: 15px;
}
a {
text-decoration: none;
font-weight: bold;
color: #1A419D;
}
</style>
</head>
<body>
<p><a href="index.html">Back to index</a></p>
<h1>consecutive.so module reference</h1>
<h2>Description</h2>
<p>Adds support for events that must be scheduled adjacent to one
another. This module uses updater functions, so the weight and mandatory
values are ignored.</p>
<h2>Required resource types</h2>
<p>Configuration file must define the following resource types
in order to use this module:</p>
<ul>
<li>time</li>
</ul>
<h2>Defined resource restrictions</h2>
<h2>Defined tuple restrictions</h2>
<h3>consecutive</h3>
<p>This restriction specifies that the repeats of the current event need to
be scheduled consecutively.</p>
<p>Please note that this module distinguishes events by the
assignments of constant resources and event names. The way events are
defined in the XML file has no effect. The following two examples will
therefore both result in one block of four consecutive "Lecture" events.</p>
<p>Example 1:</p>
<pre><event name ="Lecture" repeats="2">
<resource type="teacher" name="A"/>
<resource type="class" name="B"/>
<restriction type="consecutive"/>
</event>
<event name ="Lecture" repeats="2">
<resource type="teacher" name="A"/>
<resource type="class" name="B"/>
<restriction type="consecutive"/>
</event></pre>
<p>Example 2:</p>
<pre><event name ="Lecture" repeats="4">
<resource type="teacher" name="A"/>
<resource type="class" name="B"/>
<restriction type="consecutive"/>
</event></pre>
<p>If you would like to have two blocks of two consecutive "Lecture" events,
you must either change the names of two events like in the following example
or use the periods-per-block restriction.</p>
<pre><event name ="Lecture 1" repeats="2">
<resource type="teacher" name="A"/>
<resource type="class" name="B"/>
<restriction type="consecutive"/>
</event>
<event name ="Lecture 2" repeats="2">
<resource type="teacher" name="A"/>
<resource type="class" name="B"/>
<restriction type="consecutive"/>
</event></pre>
<h3>periods-per-block</h3>
<p>This restriction specifies that the repeats of the current event need to
be scheduled blocks of N consecutive events. If the number of repeats is
not divisible by N, then one block will have less than N events.</p>
<p>Events in the following example will be scheduled in two blocks of three
consecutive events, two blocks of two consecutive events and one single
event.</p>
<pre><event name ="Lecture" repeats="6">
<resource type="teacher" name="A"/>
<resource type="class" name="B"/>
<restriction type="periods-per-block">3</restriction>
</event>
<event name ="Lecture" repeats="5">
<resource type="teacher" name="A"/>
<resource type="class" name="B"/>
<restriction type="periods-per-block">2</restriction>
</event></pre>
<h2>Supported module options</h2>
<h2>Module groups</h2>
<p>This module belongs to the following groups:</p>
<ul>
<li>School scheduling</li>
<li>Multiweek scheduling</li>
</ul>
<h2>Author</h2>
<p>Tomaz Solc, <a href="mailto:tomaz.solc@tablix.org">tomaz.solc@tablix.org</a></p><h2>Credits</h2><p><p>
Original idea for this module by Nick Robinson (npr@bottlehall.co.uk).
Module was later rewritten to serve as an example for the new updater
function feature in 0.3.1 by Tomaz Solc.</p>
</p> <p><a href="index.html">Back to index</a></p>
</body>
</html>
|
