Bomem-GRAMS User's Guide
Bomem-GRAMS User's Guide
Bomem-GRAMS User's Guide
Create successful ePaper yourself
Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.
Appendix B<br />
Array Basic Interface<br />
Array Basic properties<br />
OBJXCALL "TaskObj",<br />
"INSTRUMENT_COUNT",eval<br />
OBJXCALL "TaskObj", "INSTRUMENT_INDEX",eval<br />
OBJXCALL "TaskObj", "INSTRUMENT_INDEX",,<br />
index<br />
dim str(255) : OBJXCALL "TaskObj",<br />
"INSTRUMENT_ID", $str<br />
OBJXCALL "TaskObj",<br />
"INSTRUMENT_STATE",eval<br />
Description<br />
Get the number of available instruments. It is recommended to call<br />
the "UPDATE_INSTRUMENT_LIST" method prior to reading this<br />
property.<br />
Get the current index in the instrument list used to retrieve the<br />
"INSTRUMENT_ID" and "INSTRUMENT_STATE" properties. Note<br />
that this index is NOT the currently selected instrument for<br />
acquisition.<br />
Set the current index in the instrument list used to retrieve the<br />
"INSTRUMENT_ID" and "INSTRUMENT_STATE". properties. Note<br />
that this index is NOT the currently selected instrument for<br />
acquisition.<br />
Get the description of the instrument pointed to by the<br />
"INSTRUMENT_INDEX" in the instrument list.<br />
Get the connection state of the instrument pointed to by the<br />
"INSTRUMENT_INDEX" in the instrument list. Returned values are<br />
as follows:<br />
0 - FREE - instrument is not connected<br />
1 - BUSY - instrument is connected<br />
2 - Not Ethernet - connected via an interface card<br />
3 - Selected - instrument currently selected for acquisition<br />
B.3 Error codes<br />
The following is a list of the possible warning and error codes:<br />
Error ID Value Description<br />
ERR_USER_CANCEL -1 User Cancelled during collect<br />
ERR_NONE 0 No error<br />
ERR_OTHER 1 Other error<br />
ERR_TIMEOUT 2 Acquisition time-out<br />
ERR_INIT_IN_PROGRESS 3 Initialization in progress<br />
ERR_PARAM_INVALID 4 Input parameter invalid<br />
ERR_NOT_ENOUGH_MEMORY 5 Not enough memory<br />
ERR_AUTO_GAIN_FAILED 6 Auto gain failed<br />
ERR_BOARD_COUNT_INVALID 120 Bopard count parameter invalid<br />
ERR_BOARD_NAME_INVALID 121 Board name parameter invalid<br />
ERR_BOARD_ID_INVALID 122 Board ID parameter invalid<br />
<strong>Bomem</strong>-<strong>GRAMS</strong> <strong>User's</strong> <strong>Guide</strong> 41