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

Description (short): Problem indices.
Written by: Andreas Kupries
Description: Management of problem indices.
Keywords: problem management, management of problems, problem index, indices

Class 'problemIndex'

Description

This class contains the common variables and behaviour of all indices whose entities are able to record problems. It records all objects signaling to have problems (via addProblemObject) and provides functionality to generate a block of references to their detailed problem descriptions.

See also

problems.

Superclasses

problemBase
formatterInterface

Methods

public: addProblemObject (object)
clear ()
numProblemObjects ()
writeProblemIndex ()

Membervariables

public: problemObjects

Methods

addProblemObject (object)

Adds the object to the list of problematic entities. The class automatically filters duplicate entries.

Argument: object The handle of the added object.

clear ()

Overrides problemBase:clear
Resets state information.

numProblemObjects ()

Returns: The number of registered problematic objects.

writeProblemIndex ()

Generates a list of references to the detailed problem descriptions of all registered objects.

Membervariables

problemObjects: The ist of objects having problems (at least they said so).

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

addProblemObject (object)
Adds the object to the list of problematic entities. The class automatically filters duplicate entries.
Argument: object	The handle of the added object.

clear ()
Overrides problemBase:clear Resets state information.

numProblemObjects ()
Returns: The number of registered problematic objects.

writeProblemIndex ()
Generates a list of references to the detailed problem descriptions of all registered objects.