RTC
®
5 PC Interface Board
Rev. 1.9 e
10 Commands And Functions
552
Ctrl Command upload_transform
Function transfers from the RTC
®
5 board to the PC all correction and transformation settings
currently assigned to the scan system.
Call
UploadErrorCode = upload_transform( HeadNo, Ptr )
Parameters
HeadNo
Number of the scan head connector whose settings should be queried, as an
unsigned 32-bit value; allowed values:
= 1: primary scan head connector
= 2: secondary scan head connector (activation required)
Ptr
Pointer (in C and C++ data type ULONG_PTR, i.e. an unsigned 32-bit or 64-bit
value) to the PC’s area of memory that should receive the queried settings
Result error code as an unsigned 32-bit value:
Bit #0 =1: X gain (gain of automatic self-calibration for galvanometer 2) = 0
Bit #1 =1: Y gain (gain of automatic self-calibration for galvanometer 1) = 0
Bit #2 =1: The total matrix of the defined coordinate transformation is noninvertable
Bit #3 =1: No correction table assigned
Bit #4 =1: The ABC values (Z axis) are noninvertable
Bit #5 =1: Error querying correction table
Bit #6 =1: Parameter error: invalid
HeadNo
or
Ptr
= 0
Bit #7 =1: BUSY error, board was BUSY or INTERNAL-BUSY (get_last_error return code
RTC5_BUSY
).
Bits #8..#31 reserved
Comments • The queried and transferred data can be used for backward transforming actual posi-
tion values via transform or get_transform (also see page 154).
• For storage of each queried data set, the application must provide (at an address spec-
ified by
Ptr
) an area of PC main memory equal to 528520 bytes.
• In case of error (except for bit#6 = 1), an error indication will be stored at
Ptr
to indi-
cate that the data are erroneous. The commands transform and get_transform will
recognize this error information and will ensure that the backward transformation is
not executed (transform then generates a corresponding error code, get_transform
generates a get_last_error return code of
RTC5_PARAM_ERROR
).
• The command is ignored (get_last_error return code:
RTC5_BUSY
) if the addressed
board’s BUSY status is currently set (list is being processed or has been halted via
pause_list) or the board’s INTERNAL-BUSY status is currently set. In contrast, the
command is executed when a list has been paused via set_wait (PAUSED status set).
• During execution of the command, external list starts will be suppressed.
RTC
®
4
RTC
®
5new command
Version info Available beginning with version DLL 516, OUT 515, RBF 512
References transform, get_transform
To Next Page
Loading...
