PK_BODY_sweep_tool_status_r_t

struct PK_BODY_sweep_tool_status_s
    {
    int                     n_faults;
    PK_sweep_tool_fault_t  *faults;
    PK_ENTITY_t            *fault_entities;
    PK_VECTOR_t            *fault_locations;
    };

typedef struct PK_BODY_sweep_tool_status_s PK_BODY_sweep_tool_status_r_t;



A structure packaging status and error location information

Used in:

PK_BODY_sweep_tool_r_t

The structure has the following fields :

'n_faults'         The number of entries in the arrays 'faults',
                   'fault_entities' and 'fault_locations'. If
                   PK_BODY_make_swept_tool returns PK_ERROR_no_errors, then a
                   return value of 0 'n_faults' indicates success.

'faults'           An array indicating one or more possible problems in
                   completing the swept body. Note that this may indicate
                   failure even where PK_BODY_make_swept_tool returns
                   PK_ERROR_no_errors.

'fault_entities'   The topological or geometric entities on which the error is
                   located, or from which it originated.

'fault_locations'  The three space points where the error is located, or from
                   where it originated.