Y_GP_GetDOFIndex
This function block is used to obtain the machine array index of an axis used in a group with six degrees of freedom by only specifying the label of the degree of freedom of interest.
Parameters
| * | Parameter | Data Type | Description | Default |
|---|---|---|---|---|
| VAR_IN_OUT | ||||
| B | AxesGroup | AXES_GROUP_REF | A logical reference to a group of axes, which contains several additional substructures pertaining to the group. | |
| VAR_INPUT | ||||
| B | Enable | BOOL | The function will continue to execute every scan while Enable is held high and there are no errors. | FALSE |
| V | Label | Yt_String16 | Name of the DOF of the machine. For auxiliary axes, input the same name used in the group definition. | '' |
| VAR_OUTPUT | ||||
| B | Valid | BOOL | Indicates that the function is operating normally and the outputs of the function are valid. | |
| B | Error | BOOL | Set high if an error has occurred during the execution of the function block. This output is cleared when 'Execute' or 'Enable' goes low. | |
| E | ErrorID | UINT | If Error is true, this output provides the Error ID. This output is reset when 'Execute' or 'Enable' goes low. | |
| V | DOFIndex | UINT | Position of the DOF or auxiliary axis in the machine array index. | |
Notes
- Y_GP_GetDOFIndex allows the user to input a string label to obtain the machine array index for a degree of freedom in a group, eliminating the chance an incorrect DOF index is used for other operations.
- Label inputs supported are 'X', 'Y', 'Z', 'Rx', 'Ry', 'Rz'. Rotational axes can also be specified as 'A', 'B', 'C'.
Error Description
See the Function Block ErrorID List.
Example
The X axis has a DOF index of 1.
