Object ProCavlayrule

Function ProCavlayruleCircDataGet


Description
Get the information about a circular rule from the Cavity Layout Rule structure.
Synopsis
#include <ProCavlayrule.h>
ProErrorProCavlayruleCircDataGet(
ProCvLayoutRule cvlrule
/* (In)
Cavity layout rule handle. It should be of circular or Variable built over circular type. A good programming style is to call first function ProCavlayruleRuleTypeGet() and make sure that one of the types it returns is Circular.
*/
ProCvLayoutOrient* orient
/* (Out)
pointer to layout orientation type;
*/
int* cavity_num
/* (Out)
pointer to number of components in the layout;
*/
double* cavity_step
/* (Out)
pointer to angular displacement;
*/
double* start_angle
/* (Out)
pointer to angle for the first component;
*/
double* radius
/* (Out)
pointer to the radius of the rule.
*/
)
Returns
PRO_TK_NO_ERRORThe information is successfully retrieved;
PRO_TK_BAD_INPUTSThe Rule is of uncompatible type.
PRO_TK_GENERAL_ERRORCannot inialize the pointers.

Sample Code References:

  1. pt_examples ( TestCavityLayout.c )