Command out_check script

Usage

A command out_check script belongs to a command (which can also be a creator in a factory) and checks conditions that must be fulfilled after executing the command. Any checks depending on several output arguments can be done in this script. Moreover, any other checks not depending on output arguments, such as testing the existence of a file, are done in this script.

[Note]Note
To check the value of a single output argument instead of several, mutually dependant output arguments, the command output argument check script should be used instead of the command out_check script. See the section called “Output argument check script” for checking a single output argument.

The out_check script is the counterpart of the in_check script. Whereas in_check is used to check conditions before executing a command, out_check is used to check conditions after executing a command.

Selector syntax

Table 7.12. Command out_check script selector

ProductionSyntaxLinks
command_out_check_script_selectorcommand_id "." "out_check"the section called “Command out_check script”

Input arguments

All output arguments of the command are implicitly provided as input arguments for this script.

Moreover, as the checks done in out_check scripts sometimes depend on input argument values, all input arguments of the command are also implicitly provided as input arguments for this script

Finally, if the script belongs to an object (i.e. it is defined in a type) then an additional last input argument holds a reference to the object. This argument's id is i_object_, and its type is the type of the object. i_object_ is used whenever the object's state must be considered in the script. If the script belongs to a service then no such input argument exists.

Output argument

This script always has one output argument whose id is o_error and whose type is ty_error_out_check. o_error is void if all conditions to execute the command are fulfilled. Otherwise it returns an error describing the first check that failed.

Example

See Example 6.8, “Multiple output arguments”.

See also