Positionercorrectorplantfeedforwarddelayget - Newport XPS Programmer's Manual

XPS Unified
7.2.1.226

PositionerCorrectorPlantFeedForwardDelayGet

Name
PositionerCorrectorPlantFeedForwardDelayGet – Gets the corrector ISR period
number configured to define the plant delay.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the filter number: (-17)
Description
This function returns the corrector ISR period number configured to define the plant
delay. Its value is predifined in the stages.ini file with the parameter named
"PlantFeedForwardDelayCorrectorISRPeriodNumber".
Prototype
int PositionerCorrectorPlantFeedForwardDelayGet(
int SocketID,
char * PositionerName,
int * CorrectorISRPeriodNumber
)
Input parameters
SocketID
PositionerName
Output parameters
CorrectorISRPeriodNumber int *
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.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
Number of ISR periods to delay plant
355
Programmer's Manual
EDH0373En1023 — 01/18