CompuScope SDK Manua.. - Egmont Instruments

More documents

Recommendations

Info

Return Value 1 if no error and a negative number if an error occurs. The following is a list of return codes including possible errors. Constant in GAGE_DRV.H Value, description ============================================================================ GAGE_AA_SUCCESSFUL 1L The routine completed correctly and the average buffer, "avg_buffer", contains the averaged of summed data. GAGE_AA_ROUTINE_UNAVAILABLE GAGE_AA_INVALID_TRIGGER_SOURCE GAGE_AA_INVALID_TRIGGER_DEPTH GAGE_AA_INVALID_BUFFER_SIZES GAGE_AA_INVALID_CHANNEL GAGE_AA_UNAVAILABLE_CHANNEL GAGE_AA_INVALID_AVERAGE_NUM 0L The routine is not implemented and the task could not be performed. This is temporary return value until all cards have had this routine implemented. -1L This routine will not function with a software controlled trigger. Only a valid hardware trigger source is allowed. This can be channel A, channel B or the external trigger input. -2L Board returned a different number of points than requested, the acquisition depth is less than the requested average number of samples. -3L The "data_buffer_size" parameter is not at least as large as the number of samples required for each average. -4L The channel specified does not currently exist. Example: channel 3 (board 2 channel A) was specified and the current CompuScope installed system has only one board. -5L The channel specified is not currently available or enabled, therefore it does not have any valid data to be averaged. Example: channel 2 (board 1 channel B)was specified and the current acquisition mode is single channel mode. -6L This value is returned when the number of averages (naverages) is greater than the maximum 32-bit integer (0x7fffffff hex or 2,147,483,647 decimal) divided by the size of the sample resolution (256 for 8-bit cards and 4096 for 12-bit cards). This is calculated by using 0x7fffffff and shifting it to the right by the number of bits of sample resolution (8 or 12). CompuScope API Reference Manual 61
GAGE_AA_INVALID_SAMPLE_NUM GAGE_AA_TRIGGER_TIMEOUT GAGE_AA_BUSY_TIMEOUT -7L This value is returned when the number of samples (nsamples) is greater than the maximum transfer allowed using the implemented transfer method. Currently this is 4K/8K samples for all boards except the CS2125, which is 8K/16K samples for dual/single mode acquisition, respectively. This will be increased to 64K for 16-bit environments and 4G for 32-bit environments when the arbitrary length transfer_buffer routines are implemented on all boards. -8L Board was not triggered within the board's time-out time period. -9L Board did not become non-busy within the board's time-out period. If an error occurs, the routine aborts immediately and returns to the calling program. See also gage_peak_detect(). Examples C: result = gage_acquire_average (channel, nsamples, naverages, sum, avg_buffer, data_buffer, nsamples, timeout); Visual BASIC: result = gage_acquire_average (channel, nsamples, naverages, sum, avg_buffer(0), data_buffer(0), nsamples, timeout) CompuScope API Reference Manual 62
Page 1 and 2:
Volume II: CompuScope Applications
Page 3 and 4:
Gage Applied Technologies, Inc. Sof
Page 5:
Global Table of Contents Volume I C
Page 8 and 9:
gage_normalize_address 43 gage_powe
Page 11 and 12:
III CompuScope API Routines This se
Page 13 and 14:
Recommended Routines - Quick Summar
Page 15 and 16:
Data Transfer Routines Name of the
Page 17 and 18: Recommended API Routines that Suppo
Page 19 and 20: gage_abort Syntax C: void GAGEAPI g
Page 21 and 22: gage_board_abort_capture Syntax C:
Page 23 and 24: gage_board_start_capture Syntax C:
Page 25 and 26: gage_busy Syntax C: int16 GAGEAPI g
Page 27 and 28: gage_calculate_mra_addresses Syntax
Page 29 and 30: gage_calculate_mr_addresses Syntax
Page 31 and 32: gage_capture_mode Syntax C: int16 G
Page 33 and 34: gage_delay_trigger_32 Syntax C: uIn
Page 35 and 36: gage_driver_initialize Syntax C: in
Page 37 and 38: The constant GAGE_MEMORY_SIZE_TEST
Page 39 and 40: gage_force_capture Syntax C: void G
Page 41 and 42: gage_get_driver_info Syntax C: void
Page 43 and 44: gage_get_error_code Syntax C: int16
Page 45 and 46: gage_input_control Syntax C: int16
Page 47 and 48: gage_multiple_record Syntax C: void
Page 49 and 50: gage_need_ram Syntax C: void GAGEAP
Page 51 and 52: gage_power_control Syntax C: int16
Page 53 and 54: #define GAGE_B_L_STATUS_START (GAGE
Page 55 and 56: gage_set_ext_clock_variables Syntax
Page 57 and 58: gage_software_trigger Syntax C: voi
Page 59 and 60: gage_transfer_buffer Syntax C: void
Page 61 and 62: C: offset = gage_transfer_buffer_3(
Page 63 and 64: slope_1 and slope_2 are the trigger
Page 65 and 66: gage_triggered Syntax C: int16 GAGE
Page 67: gage_acquire_average Syntax C: int3
Page 71 and 72: gage_get_boards_found Syntax C: int
Page 73 and 74: gage_get_records Syntax C: int16 GA
Page 75 and 76: gage_get_trigger_address Syntax C:
Page 77 and 78: gage_gpib_command Syntax C: int32 G
Page 79 and 80: gage_mem_read_chan_a Syntax C: int1
Page 81 and 82: gage_mem_read_dual Syntax C: int16
Page 83 and 84: gage_multiple_record_acquisitions S
Page 85 and 86: gage_read_cal_table Syntax C: int16
Page 87 and 88: gage_set_delay_trigger Syntax C: uI
Page 89 and 90: gage_set_trigger_depth Syntax C: in
Page 91 and 92: gage_support_to_text Syntax C: LPST
Page 93 and 94: gage_trigger_address Syntax C: int3
Page 95 and 96: Return Value A one is returned if s
Page 97 and 98: gage_trigger_view_transfer_2 Syntax
Page 99 and 100: gage_use_cal_table Syntax C: int16
Page 101 and 102: Appendix A Comparison of Various Da
Page 103 and 104: the data whose address was specifie
Page 105 and 106: gage_trigger_view_transfer, gage_tr
Page 107 and 108: Appendix C Multiple/Independent Mod
Page 109 and 110: Appendix D Multiple Record Mode Ope
Page 111 and 112: Illustration of a Multiple Record a
Page 113 and 114: as long the group number is less th
Page 115 and 116: Technical Support Gage Applied Tech
show all

CompuScope SDK Manua.. - Egmont Instruments

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?