Y_GP_GetGroupDOF
This function block populate a structure, with datatype Yt_GP_DOF_Struct, that shows a boolean value for axes configured in the group.
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 |
| 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 | DOF_Config | Yt_GP_DOF_Struct | Structure containing Boolean values indicating which degrees of freedom are configured in the group. | |
Notes
- DOF_Config.Axis[1] will return TRUE if X is configured in the group, [2] will return TRUE if Y is configured in the group, and so on for six degrees of freedom (X, Y, Z, Rx, Ry, Rz) and auxilary axis in the elements 7 to 12 (D, E...) .
- Internally, the AxesGroup.Machine.Label is checked to see if it is not empty. If it is empty, the corresponding DOF_Config.Axis[n] will return FALSE.
Error Description
See the Function Block ErrorID List.
Example
Group configured with X and Z.
