CompuScope SDK Manua.. - Egmont Instruments

More documents

Recommendations

Info

Legacy CompuScope API Subroutines - Detailed Description The section describes the Legacy CompuScope API Subroutines. These routines are supported but are not frequently used for application programs. Generally, the functionality of the Legacy routines is available with a Recommended routine and the Legacy routines are maintained only in order to provide compatibility with older customer software applications. The Legacy routines are generally not used within Gage SDKs or stand-alone software and are, therefore, not regularly tested. Furthermore, the documentation of the Legacy routines has not been updated and includes references to currently unavailable CompuScopes models. It is strongly advised that only the Recommended routines be used in new software designs. Please read the readme text files contained in the CompuScope driver disk(s) for information relating to any changes in the API routines. CompuScope API Reference Manual 59
gage_acquire_average Syntax C: int32 GAGEAPI gage_acquire_average (int16 channel, int32 nsamples, int32 naverages, int16 sum, int32 far *avg_buffer, void far *data_buffer, int32 data_buffer_size, int32 timeout); Visual BASIC: Function gage_acquire_average (ByVal channel As Integer, ByVal nsamples As Long, ByVal naverages As Long, ByVal sum As Integer, avg_buffer As Long, data_buffer As Any, data_buffer_size As Long, timeout As Long) As Long Remarks gage_acquire_capture finds the average of a number of acquisitions. This routine does the entire capture and transfer of data internally and does not return until either all captures are completed or an error has occurred. channel is the channel where the acquisitions will take place. It has a value of 1 for Board 1 Channel A, 2 for Board 1 Channel B, 3 for Board 2 Channel A, 4 for Board 2 Channel B, etc. nsamples is the number of points to be sampled for each acquisition. naverages is the number of traces to sum. The routine will not complete until this number has been captured by the digitizer. sum is a flag that is set to one to skip the division by naverages. This will allow an application to make use of the unaveraged data to increase dynamic range. Normally the average is performed. *avg_buffer is a pointer to a buffer containing either the sum of all the data traces or the averaged data, depending on the value of the sum flag. The size of this buffer must be at least nsamples*sizeof(int32). The buffer must allocated by the calling program. *data_buffer is a pointer to a buffer for use by this routine to store data points returned from the digitizer before they are summed into data_buffer. This buffer must be at least as large as (data_buffer_size) and sized to the sample size of the CompuScope card being used (data_buffer_size * 1 byte for the 8-bit CompuScope cards and data_buffer_size * 2 bytes per sample for the 12/16-bit CompuScope cards). This buffer must be allocated by the calling program. This buffer is not used by the calling program, but is only a scratch space for this routine. data_buffer_size is the size of the buffer (data_buffer). timeout is the amount of time the software should wait for the hardware to respond to a trigger event. The resolution of the timeout is in hundreds of microseconds. A minus one (all bits set) will cause the software to wait indefinitely for the trigger event to occur (therefore, if no trigger ever occurs then the software will appear to hang since it is waiting for an event to happen that never will). CompuScope API Reference Manual 60
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: gage_triggered Syntax C: int16 GAGE
Page 69 and 70: GAGE_AA_INVALID_SAMPLE_NUM GAGE_AA_
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?