PK_TRANSF_check

PK_ERROR_code_t            PK_TRANSF_check
(
--- received arguments ---
PK_TRANSF_t                transf,      --- transformation to be checked
const PK_TRANSF_check_o_t *options,     --- options structure

--- returned arguments ---
int                 *const n_faults,    --- number of faults
PK_check_fault_t   **const faults       --- faults
)


This function checks the given transformation.


Specific Errors:
    PK_ERROR_check_error        a fault has been found when max_faults = 0
                                (MILD)
    PK_ERROR_check_failure      checker failure (MILD)
    PK_ERROR_bad_option_data    max_faults < 0 (MILD)



This function performs a validity check on a transformation,
and returns information about the fault found, if any.


option structure
------ ---------
The option structure allows the caller to control which checks are performed;
if no options are supplied, all checks appropriate to the transformation will
be made.

The option structure allows the following to be set:

    'max_faults'
        maximum number of faults to be returned and whether to force checking
        to raise a PK error instead of returning check faults.


The check fault associated with this check is as follows

'state'                        |'entity_1'|'entity_2'|     'position'
-------------------------------------------------------------------------------
PK_ENTITY_state_invalid_c      |  transf  |          |      null
                               |          |          |


Faults are returned in an array of PK_check_fault_t structures.
If there are no faults found, then 'n_faults' is returned as zero.

If there is more than one fault then the function does not
guarantee to return all the faults.

For more details on fault types and how they may arise, see the chapter on
'Checking' in the Functional Description.