Positionerpositioncompareaquadbwindowedget - Newport XPS Programmer's Manual

XPS Unified
7.2.1.271

PositionerPositionCompareAquadBWindowedGet

Name
PositionerPositionCompareAquadBWindowedGet – Gets the windowed AquadB
mode parameters and state..
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the positioner type: (-8)
- Checks the position encoder ("AquadB" or "AnalogInterpolated"): (-24)
- Checks the position compare parameters (must be configured): (-23)
- Checks the configured mode type (must be WindowedAquadB): (-24)
- Checks if the CIE board supports this function: (-115)
Description
This function returns the configured parameters of the position windowed AquadB
output signal and gives its state (enabled or disabled).
This function can be used only with a position encoder ("AquadB" or
"AnalogInterpolated"). If there is no position encoder then (-24) error is returned.
Prototype
int PositionerPositionCompareAquadBWindowedGet (int SocketID, char
FullPositionerName[250] , double* MinimumPosition, double* MaximumPosition, bool
* EnableState)
Input parameters
SocketID
FullPositionerName
Output parameters
MinimumPosition
MaximumPosition
EnableState
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -8: Wrong object type for this command.
• -23: ERR_POSITION_COMPARE_NOT_SET.
• -24: Not available in this configuration (check hardware or configuration).
• -115: Function is not supported by current hardware.
NOTE
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
double * Minimum position (units).
double * Maximum position (units).
bool * Windowed AquadB state (true=enabled or
false=disabled)
409
Programmer's Manual
EDH0373En1023 — 01/18