CompuScope SDK Manua.. - Egmont Instruments

More documents

Recommendations

Info

Driver, System and Board Location Routines Name of the Routine gage_driver_initialize gage_driver_remove gage_get_config_filename gage_get_driver_info gage_get_driver_info_structure gage_read_config_file gage_select_board Description Fully configures each board found in the system. Removes all the data structures from the memory that were created by the drivers or the DLL. Determines the complete path to the configuration file that contains the board location data. Fills a structure or record with the relevant information from the driver variables as to the current settings for the current CompuScope board. Returns the relevant information about the main structure used by the driver and also retrieves the driver version and number. Reads the configuration file and stores the data in an array of words. Sets the driver so that the current board is the board identified by the number passed to the routine. Parameter Control Routines Name of the Routine gage_capture_mode gage_input_control gage_delay_trigger_32 gage_set_ext_clock_variables gage_trigger_control_2 Sets the data capture mode. Description Used to set up the input channels of the CompuScope boards. Ignores the trigger for a specified amount of time Sets the needed variables when using an external clock. Takes advantage of certain CompuScope boards’ ability to have 2 different trigger inputs (source, slope and level) and is used to set up the trigger parameters of the CompuScope boards. Address Routines Name of the Routine gage_calculate_addresses gage_calculate_mra_addresses gage_calculate_mr_addresses Description Returns the start, trigger and end addresses. Corrects the trigger address based on the ETB bit information located in the data acquired from the card at the raw calculated trigger address. Returns the start, trigger and end addresses for the specified channel of the current board to the calling routine. CompuScope API Reference Manual 7
Data Transfer Routines Name of the Routine gage_mem_read_master gage_transfer_buffer gage_transfer_buffer_3 Description Reads one sample out of CompuScope board’s memory for channel A of the master CompuScope board. Copies the number of sample points of the CompuScope board’s memory space from the specified channel to the supplied buffer. Similar to the gage_transfer_buffer_2. Returns an offset to the beginning of the dword aligned buffer used by the driver. Multiple/Independent Mode Routines Name of the Routine gage_abort_capture gage_board_abort_capture gage_board_force_capure gage_board_start_capture gage_force_capture gage_get_independant_operation gage_set_independant_operation gage_start_capture Description Used to regain control of the CompuScope board(s). This routine is reconfigured when in Multiple/Independent mode to work with independent boards. This reconfiguration is done automatically when the gage_set_independant_operation routine is called. Used to regain the control of the selected CompuScope board when in Multiple/Independent mode. Used to force the capture of data by the selected CompuScope board when in Multiple/Independent mode. Used to force the capture of data by the selected CompuScope board when in Multiple/Independent mode. Forces the capture of data by the CompuScope board(s). This routine is reconfigured when in Multiple/Independent mode to work with independent boards. This reconfiguration is done automatically when the gage_set_independent_operation routine is called. Used to check if the boards are in Multiple/Independent mode or not. Sets the driver to initialize the Multiple/Independent mode. Prepares the CompuScope hardware for data acquisition. This routine is reconfigured when in Multiple/Independent mode to work with independent boards. This reconfiguration is done automatically when the gage_set_independent_operation routine is called. CompuScope API Reference Manual 8
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: Recommended Routines - Quick Summar
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 and 68:
gage_acquire_average Syntax C: int3
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?