PK_ASSEMBLY_check

PK_ERROR_code_t              PK_ASSEMBLY_check
(
--- received arguments ---
PK_ASSEMBLY_t                assembly,   --- assembly to be checked
const PK_ASSEMBLY_check_o_t *options,    --- options structure

--- returned arguments ---
PK_ASSEMBLY_check_r_t *const results     --- result structure
)


This function checks the given assembly.


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 series of checks on the given 'assembly', and
returns information about the faults found, if any.

Checks are performed only on the provided assembly. Checks are not
performed on the constituent parts, whether bodies or assemblies,
referenced by any of the assembly's instances, with the exception of
checks for cyclic references.

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 in the assembly then the function does not
guarantee to return all the faults.

When some types of check are omitted, an assembly which would fail them may
produce misleading results or checker failures when other checks are applied.

If the checking process itself suffers an internal failure then the function
will return the error PK_ERROR_check_failure and the entity that gave problems
will be returned in the PK_ERROR_sf_t structure.  In such a case it has proved
impossible for Parasolid to demonstrate the theoretical correctness or
otherwise of the assembly.  However it is likely that Parasolid will have
difficulties in performing subsequent operations on this assembly.

See here for more information on fault types and how they may arise.