Positionertimeflasherget - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.293

PositionerTimeFlasherGet

Name
PositionerTimeFlasherGet – Gets the time flasher parameters.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the positioner type (must not be a secondary positioner): (-8)
- Checks the time flasher parameters (must be configured): (-23)
- Checks the configured mode type (must be TimeFlasher): (-24)
Description
This function returns the parameters of the time flasher trigger. The time flasher mode is
defined by:
a position window defined by a minimum position and a maximum position
a time period to set the time spaced pulses.
For a more thorough description of the position compare output, please refer to the XPS
Motion Tutorial section Triggers/Position Compare Output.
Prototype
int PositionerTimeFlasherGet(
int SocketID,
char * FullPositionerName,
double * MinimumPosition,
double * MaximumPosition,
double * TimePeriod,
bool * EnableState
)
Input parameters
SocketID
FullPositionerName
Output parameters
MinimumPosition
MaximumPosition
TimePeriod
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: Position compare not set.
• -24: Not available in this configuration (check hardware or configuration).
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Positioner name.
double * Minimum position (units).
double * Maximum position (units).
double * Time period (seconds).
bool * Enable time flasher state (true = enabled and
false = disabled).
436
Programmer's Manual