Positionercorrectorexcitationsignalgainset - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.211

PositionerCorrectorExcitationSignalGainSet

Name
PositionerCorrectorExcitationSignalGainSet – Sets corrector excitation signal gain.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the parameter value: value must be between -1 and 1, else return "Parameter
out of range or incorrect" (-17)
- Checks the positioner name: (-18)
Description
This function configures the corrector excitation signal gain for the selected positioner.
ExcitationSignalGain value must ≥-1 and ≤1.
The final gain of excitation signal for primary
positioner = KFeedforwardExcitationToPrimary * ExcitationSignalGain
The final gain of excitation signal for secondary
positioner = KFeedforwardExcitationToSecondary * ExcitationSignalGain
To have more details about KFeedforwardExcitationToPrimary and
KFeedforwardExcitationToSecondary , refer to the API
PositionerExcitationKFeedforwardSet()
Prototype
Int PositionerCorrectorExcitationSignalGainSet(
int SocketID,
char * PositionerName,
double ExcitationSignalGain
)
Input parameters
SocketID
PositionerName
ExcitationSignalGain
Output parameters
None.
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -8: Wrong object type for this command.
• -17: Parameter out of range or incorrect.
• -18: Positioner Name doesn't exist or unknown command.
NOTE
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
double Excitation signal gain.
328
Programmer's Manual