Newport XPS-D - Positionerexcitationsignalget

XPS Unified Programmer’s Manual
7.2.1.244 PositionerExcitationSignalGet
Name
PositionerExcitationSignalGet – Gets the currently used parameters of the excitation
signal feature.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Valids object type: (-8)
- Valids positioner name: (-18)
Description
This function gets the last configured excitation signal parameters.
Prototype
int PositionerExcitationSignalGet(
int SocketID,
char * FullPositionerName,
int * SignalType,
double * Frequency,
double * Amplitude,
double * Time
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
FullPositionerName char * Positioner name.
Output parameters
SignalType int * Type of signal.
Frequency double * Frequency (Hz).
Amplitude double * Amplitude (acceleration, velocity or voltage
unit).
Time double * During time (seconds).
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
• -8: Wrong object type for this command.
• -18: Positioner Name doesn't exist or unknown command.
EDH0373En1023 — 01/18 376