File 'lib/problems.cls' (part of 'AutoDOC')

Description (short): Problem management
Written by: Andreas Kupries
Description: Management of problems for an entity
Keywords: problem management, management of problems

Class 'problems'

Description

Common behaviour and variables of all classes which are able to record problems of their respectivee entity.

Superclasses

problemBase
indexBaseEntry

Methods

public: addProblem (category errortext url)
clear ()
numProblems ()
writeProblems ()

Membervariables

public: numProblems
problems

Methods

addProblem (category errortext url)

Adds a problem specified by category, errortext and a place to link to to the list of problems

Argument: category Either crossref or desc.

Argument: errortext A description of the problem.

Argument: url Reference to the place of the problem.

clear ()

Overrides problemBase:clear
Resets state information.

numProblems ()

Returns: The number of reported problems.

writeProblems ()

Generates the formatting for all reported problems.

Membervariables

numProblems: Number of problems reported so far.
initial value: 0
problems: Map from error categories to the actual problem descriptions. The system currently recognizes crossreferencing and description related problems. A problem description is a 2-element list containing the error text and a page reference to link to, in this order. The latter is allowed to be empty.
initial value: crossref {} desc {}

Generated by AutoDoc 2.4 at 09/28/2001, invoked by Andreas Kupries,,,

addProblem (category errortext url)
Adds a problem specified by category, errortext and a place to link to to the list of problems
Argument: category	Either crossref or desc.
Argument: errortext	A description of the problem.
Argument: url	Reference to the place of the problem.

clear ()
Overrides problemBase:clear Resets state information.

writeProblems ()
Generates the formatting for all reported problems.