 |
PK_BODY_create_topology_2_r_t |
|
struct PK_BODY_create_topology_2_r_s
{
PK_BODY_t body;
int n_topols;
PK_TOPOL_t *topols;
int n_create_faults;
PK_create_fault_t *create_faults;
int *internal_indices;
};
typedef struct PK_BODY_create_topology_2_r_s
PK_BODY_create_topology_2_r_t;
This return structure contains the return from PK_BODY_create_topology_2.
Used in:
PK_BODY_create_topology_2
PK_BODY_create_topology_2_r_f
If PK_BODY_create_topology_2 successfully creates a body then:
- the created body is returned in 'body'
- the entities corresponding to the entries in the 'classes' array are
returned in the 'topols' array.
- the structure 'create_fault' will hold the token PK_BODY_state_ok_c or
PK_BODY_state_ok_but_alt_type_c. The latter case only occurs if a required
'body_type' has been specified but the created body is not of that type.
If the creation is unsuccessful but no PK error is returned:
- no body is returned.
- 'topols' is empty.
- the fault return structure 'create_fault' is filled in. For each detected
fault the return structure holds one PK_check_state_t fault token and, if
possible, the indices (of the 'classes' array) of the offending
topologies. If the body that PK_BODY_create_topology_2 attempted to
construct had more than than one fault then the function does not
guarantee to return all the faults.
The fields are
'body' The created body.
'n_topols' The length of the array 'topols'.
'topols' Array of entities corresponding to the entries in the
'classes' array.
'n_create_faults' The length of the array 'create_fault'
'create_fault' Structure which holds information about any fault which
may have arisen.
The following field is for internal use only and is not to be accessed
by the application.
'internal_indices' Internal use only.