PK_FACE_pattern_data_r_t

struct PK_FACE_pattern_data_r_s
    {
    PK_pattern_status_t        status;
    int                        n_pattern_faces;
    PK_FACE_t                 *pattern_faces;
    int                        n_error_topols;
    PK_TOPOL_t                *error_topols;
    };
typedef struct PK_FACE_pattern_data_r_s PK_FACE_pattern_data_r_t;



This data structure contains the status and the patterning information
for a single instance of the pattern.

Used in:

PK_FACE_pattern_r_t

Description of fields:



'status'            This status field indicates the state of this
                    instance of the pattern. Permitted values are :

                     PK_pattern_status_ok_c
                     PK_pattern_status_fail_c
                     PK_pattern_status_outside_fa_c
                     PK_pattern_status_outside_reg_c
                     PK_pattern_status_tf_failed_c
                     PK_pattern_status_face_clash_c



'n_pattern_faces'   The length of the 'pattern_faces' array.


'pattern_faces'     The faces of this instance of the pattern which originated
                    from the input pattern faces. There is a one to one
                    relationship between this array and the input array of
                    pattern faces.
                    If this instance of the pattern operation has not
                    completely failed, the number of elements in this
                    array will be the same as the number of input pattern
                    faces. In the case of the PK_FACE_pattern function,
                    the value of 'n_pattern_faces'.


'n_error_topols'    The number of topological entities in the 'error_topols'
                    array.


'error_topols'      If the 'status' field of this return structure indicates a
                    failure, this array may contain topological entities which
                    are associated with the failure.