RESTRICTED

The RESTRICTED statement defines property variables, subroutines and functions in a class module that are visible only if the object referencing them is in the inheritance tree of the name being referenced.

var	is a simple scalar variable. The variable name may be followed by READONLY to indicate that external references to the variable may not update it.

mat(rows, cols)

is a dimensioned matrix name. The rows and cols values must be numeric constants. The dimension values may be followed by READONLY to indicate that external references to the variable may not update it.

name(arg1, arg2)

is the subroutine or function name and an optional list of arguments. See the CLASS statement for the maximum number of arguments allowed in this list. Specifying the final argument name as three periods (...) effectively extends the argument list to the maximum permissible length with unnamed scalar arguments that may be accessed using the ARG() function. Use of this syntax automatically implies the VAR.ARGS option which must not also be present.

Note that the equivalence of a function to a subroutine with a hidden first argument as found with the SUBROUTINE and FUNCTION statements does not apply to public subroutines and functions.

The first form of the RESTRICTED statement defines persistent variables that will be visible from outside the object in which they appear. Restricted variables are initially unassigned unless an initialisation value is present. If used, value must be a numeric or string constant, a CHAR() or ECHAR() function with a numeric constant argument, or a constant @-variable name. An initialisation value may be provided for a mat declaration and is equivalent to use of the MAT statement to set all elements to the given value. The initialisation is applied prior to execution of the CREATE.OBJECT subroutine, if present.

The second and third forms of the RESTRICTED statement define a subroutine or function that can be referenced from outside the object. Unlike a public name that is freely accessible, a restricted name is only visible to objects that appear in the inheritance tree of the restricted item.

Arguments to public subroutines and functions may reference a whole matrix by following the matrix name by its dimensions. The actual values given are ignored; the compiler simply counts them to determine whether the matrix has one or two dimensions. For example:

In this example, the dimension value has been shown as 1 to emphasise that the actual value is irrelevant. The compiler uses this purely to determine that CLI.REC is a single dimensional matrix, possibly representing a database record read using MATREAD. The alternative syntax used with SUBROUTINE statements by prefixing the matrix name with MAT and using a DIMENSION statement to set dimensionality is not available for public subroutines and functions.

The number of arguments in calls to the subroutine or function must be the same as in the declaration unless the VAR.ARGS option is used in which case any arguments not passed by the caller will be unassigned. The ARG.COUNT() function can be used to determine the actual number of arguments passed, excluding the hidden return argument. The ARG.PRESENT() function can be used to test for the presence of an optional argument by name.

In this example, if the calling program supplies only one argument, the CLASS and CODE variables will be unassigned. If the calling program provides two arguments, the CODE variable will be unassigned.

When using VAR.ARGS, default values may be provided for any arguments by following the argument name with an = sign and the required numeric or string value or the @FALSE or @TRUE constants. For example,

RESTRICTED FUNCTION CREDIT.RATING(CLIENT, CLASS = 1, CODE = "Standard") VAR.ARGS

In this example, if the calling program supplies only one argument, the CLASS variable will default to 1 and the CODE variable will default to "Standard". If the calling program provides two arguments, the default value for CLASS is ignored and the CODE variable defaults to "Standard".

The above function takes a fixed length list of two arguments and uses the supplied values to open a socket connection to a remote server. The SKT variable in this example would be a private variable within the class module.

This example extends the previous one by making the PORT argument optional and, if it is not supplied by the caller, defaulting it to 4000.

This example uses the ... syntax to specify a variable length argument list of the maximum permissible length. It reads a record identified by the ID argument and then inserts all items from the remaining arguments that are not already in the record.