Checker Objects

A ChkReturn object is returned from a Check function to the Checker utility to tell the utility whether the element has passed or failed the test.

If the check has passed, the .Passed member will be set to TRUE and the array of text string messages is initialised as empty.

If the check has failed, the .Passed member will be set to FALSE and the array of text string messages should contain at least one entry.

-- Define object

define object CHKRETURN

-- Message Array

member .Messages is ARRAY

-- Passed=TRUE Failed=False

member .Passed is BOOLEAN

endobject

-- End of object definition

The Check object is the object created in the des-checks.pmldat file to configure the Checker utility. It is also passed to the Check function as its second argument.

-- Define object

define object CHECK

-- Check Name (unique)

member .Name is STRING

-- Check Class

member .Class is STRING

-- Class Check Type

member .Group is STRING

-- Check Description

member .Title is STRING

-- Check Function Name

member .Function is STRING

-- Permissible Element types

member .Types is STRING

-- Selection rule

member .Rule is STRING

-- Successful action

member .Passed is STRING

-- Failed action (if none returned from check)

member .Failed is STRING

-- Module check is available form

member .Module is STRING

-- File type (who/where check is loaded from)

member .FileType is STRING

endobject

-- End