hd_hl_apis_callbacks.h File Reference

hd_hl_apis_callbacks.h file for this module. Contains includes, prototypes and global vars. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

HDCallbackCode HDCALLBACK updateDeviceCallback (void *pUserData)
 Callback for max priority servo loop update. More...
 
HDCallbackCode HDCALLBACK updateDeviceParametersCallback (void *pUserData)
 Callback for retrieving device specific parameters. More...
 
HDCallbackCode HDCALLBACK copyDeviceDataCallback (void *pUserData)
 Callback to update device data structure with the relevant parameters. More...
 
HDCallbackCode HDCALLBACK forcefeedbackCallback (void *pUserData)
 Callback to update the force feedback of the joystick. More...
 
HDCallbackCode HDCALLBACK CalibrationCallback (void *pUserData)
 Callback for device calibration. More...
 

Detailed Description

hd_hl_apis_callbacks.h file for this module. Contains includes, prototypes and global vars.

Author
pedro_cruz
Version
1.0
Date
17 May 2012

Definition in file hd_hl_apis_callbacks.h.

Function Documentation

HDCallbackCode HDCALLBACK CalibrationCallback ( void *  pUserData)

Callback for device calibration.

This function is PHANToM OMNI specific, for each device can have a different calibration method.

Parameters
pUserDataa pointer to a structure.
Returns
HD_CALLBACK_CONTINUE.

Definition at line 519 of file hd_hl_apis_callbacks.cpp.

HDCallbackCode HDCALLBACK copyDeviceDataCallback ( void *  pUserData)

Callback to update device data structure with the relevant parameters.

This function is a callback that runs whenever the haptic loop starts and updates the device data structure with the relevant parameters chosen by the user.

Parameters
pUserDataa pointer to a structure.
Returns
HD_CALLBACK_CONTINUE.

Definition at line 107 of file hd_hl_apis_callbacks.cpp.

HDCallbackCode HDCALLBACK forcefeedbackCallback ( void *  pUserData)

Callback to update the force feedback of the joystick.

This function is a callback that runs within the haptic loop. It checks the selected kinematic model and applys force whenever the chosen end point leaves the robot workspace.

Parameters
pUserDataa pointer to a structure.
Returns
HD_CALLBACK_CONTINUE.

Definition at line 238 of file hd_hl_apis_callbacks.cpp.

HDCallbackCode HDCALLBACK updateDeviceCallback ( void *  pUserData)

Callback for max priority servo loop update.

This function is the max priority callback that runs in the servo loop thread. It updates the data structure with the current joystick values.

Parameters
pUserDataa pointer to a structure.
Returns
HD_CALLBACK_CONTINUE.

Definition at line 41 of file hd_hl_apis_callbacks.cpp.

HDCallbackCode HDCALLBACK updateDeviceParametersCallback ( void *  pUserData)

Callback for retrieving device specific parameters.

This function is a callback executed once in the code that retrieves nominal maxmimum stiffness, damping, force and continuous force, specific for each device.

Parameters
pUserDataa pointer to a structure.
Returns
HD_CALLBACK_CONTINUE.

Definition at line 88 of file hd_hl_apis_callbacks.cpp.



phua_haptic
Author(s): Pedro Cruz
autogenerated on Mon Mar 2 2015 01:32:36