Added small docstring to motorVelocity explaining an important caveat.
This commit is contained in:
@@ -267,6 +267,19 @@ class HIDDEN sinqController : public asynMotorController {
|
||||
int motorMoveVel() { return motorMoveVel_; }
|
||||
int motorHome() { return motorHome_; }
|
||||
int motorStop() { return motorStop_; }
|
||||
|
||||
/**
|
||||
* @brief Index for the paramLib entry which writes the motor speed in steps
|
||||
* / s into the RVEL field of the motor record.
|
||||
*
|
||||
* Important: Only write to this field if the motor is moving. As discussed
|
||||
* here: https://github.com/epics-modules/motor/pull/236, otherwise a race
|
||||
* condition might occur and the move or moveVelocity might be called with
|
||||
* the readback velocity instead of that written into the VELO / JVEL
|
||||
* fields.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
int motorVelocity() { return motorVelocity_; }
|
||||
int motorVelBase() { return motorVelBase_; }
|
||||
int motorAccel() { return motorAccel_; }
|
||||
|
||||
Reference in New Issue
Block a user