RTC
®
5 PC Interface Board
Rev. 1.9 e
10 Commands And Functions
333
Ctrl Command load_fly_2d_table
Function loads a 2D table from an ASCII text file for a set_fly_2d-
Processing-on-the-fly application
with 2D encoder compensation for XY stages (see page 184).
Call
NoOfDataPoints = load_fly_2d_table( Name, No )
Parameters
Name
name of the text file as a pointer to a null-terminated ANSI string
(the text file may contain one or more tables).
No
This parameter (an unsigned 32-bit value) specifies which table in the text file
shall be loaded (the parameter corresponds to the extension
<No>
of the
instruction
[Fly2DTable<No>]
at the beginning of the desired table).
Result signed 32-bit value (a positive error code in case of an error, the negative number of found
data points in case of success):
Value Description
< 0 Success.
The absolute value of the return value is equal to the number of valid data points found in the table.
Invalid entries are ignored (see page 185).
0for
Name
= 0 (see comments)
1 No valid data points found (though Table
No
found).
2 Out of Memory (not enough WINDOWS system memory)
3 File not found.
4 DSP memory error
5 BUSY error, board is BUSY or INTERNAL-BUSY, no download (get_last_error return code
RTC5_BUSY
).
8 Board is locked by another application (get_last_error return code
RTC5_ACCESS_DENIED
).
11 PCI error (get_last_error return code
RTC5_SEND_ERROR
),
verify error (get_last_error return code
RTC5_VERIFY_ERROR
)
13 The specified table number was not found in the file.
Comments • The text file’s data format requirements for reference points of the 2D encoder compen-
sation table are described on page 185. The largest of these reference points should not
exceed the range -524288 to 524287 (otherwise precision may be lost). During
runtime, the current encoder values (including reference values) must not exceed the
largest values specified in the table. Otherwise clipping will occur.
• The command load_fly_2d_table overwrites any previously loaded table for 2D
encoder compensation.
•If
Name
= 0, then a 0-correction table for 2D encoder compensation will be loaded.
• The command will not be executed (get_last_error return code:
RTC5_BUSY
) if the
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 load_fly_2d_table, external starts will be suppressed.
• Before loading a table, load_fly_2d_table performs a DSP memory check. In case of an
error, error code 4 is returned.
RTC
®
4
RTC
®
5 new command
Version info Available beginning with version DLL 536, OUT 536
References set_fly_2d, init_fly_2d, get_fly_2d_offset