Docs For Class EventBlocks

Description

**************************************************************

This file is part of SlidingDoors * Copyright 2001-2003. Eric D. Nielsen, All rights reserverd * SlidingDoors is availible for license under the GPL, see * the COPYING file in the root directory of the install for * the full terms of the GPL. * * File: EventBlocks.inc * Author: Eric D. Nielsen * Description: A helper class for the ContraCheckModule -- * As events are added to this, a minimal number of blocks are * maintained such that no dance appears twice within a block * and each block contains only one style of events. This is * needed when a person is limited to some fixed number of * "blocks" for registration, but blocks may span levels. * Attributes: blocks -- the set of blocks * Constructor: EventBlocks * Methods: AddEvent * GetTotalBlocks * GetBlocksByStyle * Change Log: 01/02/03 -- created -- edn * *************************************************************

Located in /include/classes/contra-check/EventBlocks.inc (line 24)

Variable Summary

mixed $blocks

Method Summary

EventBlocks EventBlocks ()

void addEvent (mixed $level, mixed $style, mixed $dances)

void getBlocksByStyle ()

void getTotalBlocks ()

void _insertDancesIntoBlock (mixed $style, mixed $blockNum, mixed $dances, mixed $level)

void _newBlock (mixed $style)

void _testDancesInBlock (mixed $style, mixed $blockNum, mixed $dances, mixed $level)

Variables

mixed $blocks (line 26)

Methods

Constructor EventBlocks (line 35)

EventBlocks EventBlocks ()

addEvent (line 48)

void addEvent (mixed $level, mixed $style, mixed $dances)

getBlocksByStyle (line 90)

*********************************************************

Function: getBlocksByStyle * Arguments: none * Returns: an array whos keys are the style names and the * values are the number of blocks in that style * Modifies: nothing * Requires: nothing * ********************************************************

void getBlocksByStyle ()

getTotalBlocks (line 74)

*********************************************************

Function: getTotalBlocks * Arguments: none * Returns: the total number of blocks used * Modifies: nothing * Requires: nothing * ********************************************************

void getTotalBlocks ()

_insertDancesIntoBlock (line 121)

*********************************************************

Function: _insertDancesIntoBlock * Arguments: style -- which style are we added to * blockNum -- which block within this style * dances -- the dances to add * level -- what level is associated with these * Returns: nothing * Modifies: this * Requires: nothing * ********************************************************

void _insertDancesIntoBlock (mixed $style, mixed $blockNum, mixed $dances, mixed $level)

_newBlock (line 106)

*********************************************************

Function: _newBlock * Arguments: style -- which style needs a new block * Returns: nothing * Modifies: this * Requires: nothing * ********************************************************

void _newBlock (mixed $style)

_testDancesInBlock (line 147)

*********************************************************

Function: _testDanceInBlock * Arguments: style -- which style are we testing * blockNum -- which block within this style * dances -- the dances to test for * level -- what level is associated with these * Returns: true, if these dances fit in this block * fakse, otherwise * Modifies: nothing * Requires: nothing * ********************************************************

void _testDancesInBlock (mixed $style, mixed $blockNum, mixed $dances, mixed $level)