Back to index

sameday.so module reference

Description

Adds a weight if a class or a teacher (as specified by the "resourcetype" module option) has the same subject more than N times in a day.

Default for N is 1. Default value can be changed with the module option "default". Default value for N can also be overridden for individual teachers, classes and events with various restrictions.

Required resource types

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

Defined resource restrictions

ignore-sameday (all resource types)

<resourcetype type="class">
	<resource name="example-class">
		<restriction type="ignore-sameday"/>
	</resource>
</resourcetype>

Set this restriction to a class or a teacher that you don't want to be checked for multiple occurrences of the same subject in a day.

This module then ignores classes that have this restriction, however this setting can be overridden for individual events if "set-sameday" restriction is used on an event for this class or teacher.

set-sameday (all resource types)

<resourcetype type="class">
	<resource name="example-class">
		<restriction type="set-sameday">2</restriction>
	</resource>
</resourcetype>

With this restriction you can set a maximum number of equal events a class or a teacher can have in a day. This setting can be overridden for individual events if "set-sameday" event restriction is used on an event for this class or teacher.

Defined tuple restrictions

consecutive

This is an alias for "ignore-sameday" restriction. It is defined for convenience when this module is used together with consecutive.so module.

ignore-sameday

Set this restriction to all events that you do not want to be checked for multiple occurences per day.

This retriction overrides the default setting and settings made by any resource restrictions.

periods-per-block

This is an alias for "set-sameday-blocksize" restriction. It is defined for convenience when this module is used together with consecutive.so module.

set-sameday

<event name="example" repeats="5">
		...
		<restriction type="set-sameday">2</restriction>
</resourcetype>

With this restriction you can set a maximum number of events of type type that a class or a teacher can have in a day.

This retriction overrides the default setting and settings made by any resource restrictions.

set-sameday-blocksize

With this restriction you can tell this module that the current event will be scheduled in blocks of this number of equal consecutive events.

Module will then consider a block of events as a single event when checking for multiple occurences per day.

Default block size is 1.

Supported module options

default

Use this option to set the default number of equal events classes or teachers can have in day.

resourcetype

Use this option to specify one or more constant resource types. Specified resource types will have their timetables checked by this module.

Use option

<option name="resourcetype">class</option>

to get the same behaviour as this module had before Tablix version 0.3.1.

Module groups

This module belongs to the following groups:

Author

Tomaz Solc, tomaz.solc@tablix.org

Credits

Ideas taken from a patch for Tablix 0.0.3 by Jaume Obrador <obrador@espaiweb.net>

Back to index