Cbsaux Function Descriptions

Last updated:10-Dec-2017



BPM

blm_abort_map_select_c - displays a dialog for selecting BLM abort state mapping for the current machine
blm_detector_name_search - returns information about a BLM from its name
blm_get_abort_info_c - reads BLM abort configuration for the machine last requested by bpm_machine
blm_get_abort_map - reads BLM abort state mapping for the machine last requested by bpm_machine_c
blm_get_abort_status_c - reads BLM house abort status for the machine last requested by bpm_machine
blm_get_crates_and_channels_c - gets BLM detector crate and channel values for the current machine
blm_get_data_c - gets BLM data for machine last requested by bpm_machine
blm_get_file_frame_data_c - returns BLM frame by frame losses for a detector from a file
blm_get_frame_data_c - returns BLM frame by frame losses for a detector
blm_get_frame_list_data_c - returns BLM frame by frame losses for a list of detectors
blm_get_house_abort_config_c - reads BLM abort configuration for the machine last requested by bpm_machine
blm_get_house_names_c - returns names of BLMs belonging to a particular house
blm_get_locations - gets BLM locations for current machine
blm_get_names - returns names of BLMs in same order blm_get_data returns values
blm_get_system_sample_data - retrieves BLM data sampling for the machine last requested by bpm_machine_c
blm_get_tbt_data_c - returns BLM turn by turn losses and timestamps
blm_get_tbt_list_data_c - returns BLM turn by turn losses and timestamps for a list of detectors
blm_interrogate_plot - enable interrogation of existin BLM plots
blm_last_error - returns the last BLM access error
blm_name_to_index_c - returns the data array index corresponding to a BLM name
blm_num_abort_states - returns the number of BLM abort state for the machine last requested by bpm_machine_c
blm_num_machine_states - returns the number of BLM states for the machine last requested by bpm_machine_c
blm_plot_data - plots BLM data
blm_plot_frame_data - plots BLM data
blm_query - returns number of beam loss monitors (BLMs) per frame for machine
blm_set_abort_map_c - sets BLM abort mapping for the machine last requested by bpm_machine_c
blm_set_abort_mask_by_address_c - enables/disables BLM aborts by address
blm_set_abort_mask_c - enables/disables BLM aborts
blm_set_abort_multiplicity_c - sets the BLM abort multiplicity for the machine last requested by bpm_machine
blm_set_abort_threshold_by_address_c - sets BLM abort thresholds by address
blm_set_abort_threshold_c - sets BLM abort thresholds
blm_set_system_sample_data_c - sets BLM data sampling for the machine last requested by bpm_machine_c
blm_state_menu_c - displays a menu of BLM states for the current machine
blm_to_crate_and_channel_c - returns BLM detector crate and channel values
bpm_beam_cycle_info - returns cycle info for last retrieved BPM data
bpm_calculate_rms_dpoverp_c - calculates BPM RMS and delta p / p values
bpm_check_for_data_c - checks to see if requested BPM data is ready
bpm_crate_and_channel_to_name_c - converts a crate number and channel number to its corresponding BPM name
bpm_crate_info_c - returns BPM crate information
bpm_crate_name_to_index - converts a BPM crate name to its corresponding index
bpm_data_source_c - sets the data acquisition source for live BPM data
bpm_default_data_event - sets the default data acquisition event for live BPM data
bpm_detector_name_search - returns information about a BPM from its name
bpm_directory_info - returns an array of BPM file directory information
bpm_enable_tbt_trigger_c - enables/disables BPM turn by turn triggering
bpm_file_link_info_c - returns file link information
bpm_file_menu_c - displays a menu of BPM save files for the current machine
bpm_find_oldest_file_number_c - finds the oldest file number in a BPM file
bpm_frame_file_menu_c - displays a menu of BPM frame files for the current machine
bpm_frame_type_to_string_c - converts a BPM frame type to its corresponding string
bpm_get_acquisition_spec_c - reads acquisition specs for the machine last requested by bpm_machine
bpm_get_calculation_masks_c - reads BPM calculation masks for the machine last requested by bpm_machine
bpm_get_calibration_spec_c - reads calibration mode data for the machine last requested by bpm_machine
bpm_get_crates_and_channels - gets BPM detector crate and channel values for the current machine
bpm_get_data_c - gets BPM data for the machine last requested by bpm_machine
bpm_get_database_system_id - returns the database system ID for the currently selected BPM system
bpm_get_default_save_file - returns the default BPM save file for the current machine
bpm_get_detector_status - gets BPM detector status values for the current machine
bpm_get_diagnostic_spec_c - reads diagnostic mode data for the machine last requested by bpm_machine
bpm_get_event_spec_text_c - returns event specification descriptive text
bpm_get_file_frame_data_c - returns BPM frame by frame positions for a detector from a file
bpm_get_filter_text_c - returns data filter descriptive text
bpm_get_frame_data_c - returns BPM frame by frame positions for a detector
bpm_get_frame_save_file - returns the currently selected BPM frame save file for the current machine
bpm_get_global_tbt_timing_c - returns BPM turn by turn timing
bpm_get_house_names_c - returns names of BPMs belonging to a particular house
bpm_get_intensity_c - gets BPM beam intensities for current machine
bpm_get_intensity_locations - gets BPM intensity detector locations for current machine
bpm_get_intensity_names - returns names of BPM intensity monitors
bpm_get_locations - gets BPM detector locations for current machine
bpm_get_microp_times_c - returns individual BPM microprocessor timestamps
bpm_get_names - returns names of BPMs in same order bpm_get_data returns values
bpm_get_offsets - gets BPM detector offsets for current machine
bpm_get_plot_window_info_c - retrieve information about BPM plot windows
bpm_get_raw_data_c - gets raw BPM data for the machine last requested by bpm_machine
bpm_get_raw_mode_data_c - returns BPM raw mode turn by turn position data and timestamps
bpm_get_raw_tbt_data_c - returns raw BPM turn by turn position data and timestamps
bpm_get_sample_mode - returns type of particle the BPM uPs are set up to sample
bpm_get_save_file - returns the currently selected BPM save file for the current machine
bpm_get_tbt_crates_and_channels - gets BPM turn by turn detector crate and channel values for the current machine
bpm_get_tbt_data_c - returns BPM turn by turn positions and timestamps
bpm_get_tbt_intensity_c - returns BPM turn by turn intensities and timestamps
bpm_get_tbt_names - returns valid BPM names for reading turn by turn data
bpm_get_tbt_timing_c - returns BPM turn by turn timing
bpm_get_threshold_c - returns BPM uP sample threshold levels
bpm_house_info - returns basic information about active BPM nodes
bpm_house_menu_c - displays a menu of the valid BPM houses
bpm_house_select_delete_c - deletes a BPM house selection field
bpm_house_select_init_c - initializes a BPM house selection field
bpm_house_select_set_c - sets the current house for a BPM house selection field
bpm_house_select_update_c - services a BPM house selection field
bpm_interrogate_plot - enable interrogation of existing BPM plots
bpm_intro - introduction to the use of BPM/BLM access routines
bpm_is_tbt_trigger_enabled - determines if BPM turn by turn triggering is enabled
bpm_link_file_c - links a BPM file to another one
bpm_lock_tbt_buffer_c - locks/unlocks BPM turn by turn data buffer
bpm_machine_c - sets a particular machine for BPM data acquisition
bpm_machine_to_string_c - converts a BPM machine ID to its corresponding string
bpm_map_from_model_c - copies array of lattice values into BPM data order
bpm_master_file_menu_c - displays a menu of BPM master save files
bpm_name_to_index_c - returns the data array index corresponding to a BPM name
bpm_next_house_c - returns the next valid BPM house name in order
bpm_next_unlinked_file_c - finds the next unlinked, unprotected, and nonreference BPM file
bpm_num_machine_states - returns the number of BPM states for the machine last requested by bpm_machine_c
bpm_plot_data - plots BPM data
bpm_protect_file_c - changes the protection for a BPM file for current machine
bpm_query - returns the number of BPM position values for currently machine
bpm_read_file_range_data_c - reads data for a detector from a range of files for the current machine
bpm_read_frame_file_data_c - reads BPM frame file data for the current machine
bpm_read_frame_file_info_c - reads BPM frame file information for the current machine
bpm_read_tbt_buffer_lock_c - reads BPM turn by turn data buffer lock
bpm_read_tbt_mode_c - reads BPM turn by turn data acquisition mode
bpm_rename_file_c - renames a BPM file for the selected machine
bpm_request_data_c - requests BPM data for the machine last requested by bpm_machine
bpm_save_data - saves BPM data for the current machine
bpm_save_frame_data_c - saves BPM frame data for the current machine
bpm_set_calculation_masks_c - sets BPM calculation masks for the machine last requested by bpm_machine
bpm_set_calibration_spec_c - sets calibration mode for the machine last requested by bpm_machine
bpm_set_detector_status_c - sets BPM detector status values for the current machine
bpm_set_diagnostic_spec_c - sets diagnostic mode for the machine last requested by bpm_machine
bpm_set_frame_save_file - sets the active BPM frame save file
bpm_set_global_tbt_timing_c - sets BPM turn by turn timing for an entire machine
bpm_set_intensity_mapping_c - sets the mapping for returned intensity data
bpm_set_readout_spec_c - sets readout spec for the machine last requested by bpm_machine
bpm_set_reference_file_c - changes the reference file status for a BPM file for current machine
bpm_set_sample_mode_c - sets BPM uPs to sample specified particle type and beam
bpm_set_save_file - sets the active BPM data save file
bpm_set_tbt_mode_c - sets the BPM turn by turn acquisition mode
bpm_set_tbt_timing_c - sets BPM turn by turn timing for a single house
bpm_set_tbt_timing_params - sets BPM turn by turn timing for an entire machine
bpm_set_threshold_c - sets BPM uP sample threshold levels
bpm_state_menu_c - displays a menu of BPM states for the current machine
bpm_status_to_string_c - returns the string corresponding to a BPM status value
bpm_string_to_frame_type - converts a string to a BPM frame type
bpm_string_to_machine - converts a string to a BPM machine ID
bpm_to_crate_and_channel_c - returns BPM detector crate and channel values
bpm_unlink_file_c - unlinks a BPM file from another one
bpm_verify_house_c - determines if passed ASCII string is a valid BPM house
old_profile_c - tells if BPM profile was taken on present Tevatron cycle

WAVEFORM_GENERATOR

WG_BUILD_RAMP_POINTER - returns the f(t) table number from a ramp table map entry
WG_EXTRACT_FT_TABLE - returns the f(t) table number from a ramp table map entry
WG_EXTRACT_GI_TABLE - returns the g(i) table number from a ramp table map entry
WG_EXTRACT_HI_TABLE - returns the h(i) table number from a ramp table map entry
build_ramp_pointer_c - builds ramp table pointer value for modules
c453_device_type_c - returns device types for requested C453 devices
c465_find_level_c - returns the interrupt level containing a TCLK event
c465_find_level_list_c - returns list of interrupt levels containing a TCLK evnt
c465_find_table_numbers_c - returns the table numbers corresponding to a TCLK event
c465_find_table_numbers_list_c - returns list of table numbers corresponding to a TCLK evnt
c465_ft_frequency_c - returns the time table update frequency
c465_ft_frequency_list_c - returns a list of time table update frequencies
c465_get_table_c - returns the time table number for an interrupt level
c465_get_table_list_c - returns a list of time tables for an interrupt level
c465_get_table_numbers_c - returns the table numbers for an interrupt level
c465_get_table_numbers_list_c - returns a list of table numbers for C465 interrupt levels
c465_set_ft_frequency_c - sets the time table update frequency for a C46x module
c465_trigger_level_c - triggers a specified interrupt level
c465_trigger_level_list_c - triggers a specified interrupt level
c46x_device_type_c - returns device types for requested C46x devices
c473_device_type_c - returns device types for requested C473 devices
c473_ft_frequency - returns the time table update frequency
c473_get_device - returns DI for the requested database device on a C473 card
c473_get_family - returns C473 family DI's given root name for the family
c473_set_ft_frequency_c - sets the time table update frequency for a C473 module
c475_device_type_c - returns device types for requested C475 devices
c475_ft_frequency - returns the time table update frequency
c475_get_device - returns DI for the requested database device on a C475 card
c475_get_family - returns C475 family devices given the root name for the family
c475_set_ft_frequency_c - sets the time table update frequency for a C475 module
curve_editor - allows a user to edit a curve (set of points) graphically
curve_editor_init - auxiliary initialization procedure for curve_editor
curve_editor_multiple_waveforms_c - allows a user to edit a curve (set of points) graphically
find_time_slot_c - returns time slot preceding a given time
find_time_slot_list_c - returns time slot preceding a given time for a list
get_453_channel - returns channel on C453 card associated with this device
get_453_device - returns DI for requested database device on a C453 card
get_453_family - returns C453 family device indices given root name for family
get_465_device - returns DI for the requested database device on a C465/6/7/8/0 card
get_465_family - returns C465/6/7/8/0 family DI's given root name for the family
get_465_type - returns the exact device type for a C46x family device
rampcard_shaper - allows a user to edit a ramp waveform graphically
rampcard_shaper_init - aux initialization procedure for rampcard_shaper
v473_device_type_c - returns device types for requested V473 devices
v473_get_device_c - returns device index for the requested database device on a V473 card
v473_get_family_c - returns V473 family device indices given the root name for the family
wg_are_clock_event_interrupts_enabled - determines if clock event interrupts are enabled
wg_device_type_c - returns device types for requested waveform generator devices
wg_disable_clock_event_interrupts - disables clock event interrupts
wg_disable_ramp - disables the ramp
wg_disable_sine_wave_mode - disables sine wave mode
wg_enable_clock_event_interrupts - enables clock event interrupts
wg_enable_ramp - enables the ramp
wg_enable_sine_wave_mode - enables sine wave mode
wg_find_level_c - returns the interrupt level containing a TCLK event
wg_find_level_list_c - returns list of interrupt levels containing a TCLK evnt
wg_find_table_numbers_c - returns the table numbers corresponding to a TCLK event
wg_find_table_numbers_list_c - returns list of table numbers corresponding to a TCLK evnt
wg_find_time_slot_c - returns time slot preceding a given time for a waveform generator
wg_find_time_slot_list_c - returns time slot preceding a given time for a list
wg_ft_frequency - returns the time table update frequency
wg_get_device_c - returns DIs for requested database devices for C465/6/7/8/0, C453, C473, V473, and C475 cards
wg_get_family_c - returns C465/6/7/8/0, C453, C473, V473, and C475 family DI's given root name for the family
wg_get_root_device_by_di_c - returns the root device for requested waveform generator devices
wg_get_root_device_c - returns the root device for requested waveform generator devices
wg_get_table_numbers_c - returns the table numbers for an interrupt level of a waveform generator
wg_get_table_numbers_list_c - returns a list of table numbers for interrupt levels of waveform generators
wg_is_ramp_enabled - determines if the ramp is enabled
wg_is_sine_wave_mode_enabled - determines if sine wave mode is enabled
wg_read_mdat_selections_list_c - returns G(I) and H(I) MDAT frame selections for waveform generators
wg_reset_module - resets the module (clears everything)
wg_scale_mdat_data_c - converts MDAT breakpoint table data values for waveform generators
wg_scale_mdat_mults_c - converts raw MDAT multipliers MDAT frame values
wg_scale_mdat_selections_c - converts raw MDAT selection values to G(I) and H(I) MDAT frame values
wg_scale_time_data_c - converts delta time data values for waveform generators
wg_set_ft_frequency_c - sets the time table update frequency for a C465/6/7/8, C473, or C475 module
wg_set_mdat_selections_list_c - sets G(I) and H(I) MDAT frame selections for waveform generators
wg_td_table_type_to_device_type_c - converts a TD table type to a waveform generator device type
wg_unscale_mdat_mults_c - converts MDAT frame values to raw MDAT multiplier values
wg_unscale_mdat_selections_c - converts G(I) and H(I) MDAT frame values to raw MDAT selection values

DEVICE_SUPPORT

abort_curr_source_control_c - turns abort concentrator current sources on/off
abort_get_device_c - returns the device index for a given abort module
abort_loop_is_up_c - determines if a given abort loop is up
abort_mask_control_c - masks or unmasks abort concentrator module inputs
abort_mask_group_c - masks or unmasks a group of aborts
abort_read_single_module_by_name_c - reads the current status of a single abort concentrator specified by name
abort_read_single_module_c - reads the current status of a single abort concentrator
abort_system_devices_c - returns the abort module devices for a given system
abort_system_display_coords_c - returns abort module display coordinates for a given system
abort_system_get_id_c - returns the databse system ID for a given abort system
abort_system_info_c - returns abort module information for a given system
abort_system_module_data_c - returns the abort module information for a given system
abort_system_num_modules_c - returns the number of abort modules for a given system
abort_system_reset_c - resets an abort system
c070_configure - send a save file to an O70
c070_data_source_c - sets the data acquisition source for reading 070/071 data
c070_delete_frame_c - deletes a frame from an 070 module
c070_get_file_names - returns a list of 070 module save file names
c070_get_shortnames - return a list of 070 save files
c070_read_data_source - reads the data acquisition source information for reading 070/071 data
c070_restore_c - restores a previously saved 070 module
c070_save_c - saves the entire table in an 070 module in memory
c071_delete_frame_c - deletes a frame from an 071 module
c071_restore_c - restores a previously saved 071 module
c071_save_c - saves the entire table in an 071 module in memory
check_power_leads_c - checks status of the Tevatron power lead control valves
clear_070_c - clears out an 070 module by setting all values to zero
device_type_text_c - returns device type text for an ACNET device
enable_070_c - enables or disables an 070 module
get_069_c - reads timing information from an 069 module
get_070_c - reads times from an 070 module
get_070_frame_info_c - returns number of times in each frame of an 070 module
get_070_frame_pointers_c - returns frame ptrs for all frames of 070, 071 module
get_070_raw_c - reads raw time values from an 070 module
get_071_raw_c - reads values from an 071 module
oddmod_all_time_c - returns a value from ODDMOD all-time summary data array
oddmod_device_text_c - returns the descriptive text for an ODDMOD device
oddmod_real_time_c - return a value from the ODDMOD real-time data array
power_leads_off_c - turns off the requested Tevatron power lead control valves
power_leads_on_c - turns on the requested Tevatron power lead control valves
put_070_c - loads times into an 070 module
put_070_raw_c - loads raw time values into an 070 module
put_071_raw_c - loads values into an 071 module
vcr_record - puts the MCR VCRs in record mode
vcr_rewind - rewinds the MCR VCRs

CLOCK_SUPPORT

clock_history_get_event_counts_c - returns clock event occurrence counts from a supercycle history structure
clock_history_get_event_times_c - returns clock event occurrence times from a supercycle history structure
clocklog_dates - returns the available dates for saved clock log data
clocklog_directory - displays directory of saved clocklog data
clocklog_recall - returns pointer to clocklog data, NULL if none
clockscope_directory - displays directory of saved clockscope data
clockscope_directory_info - returns saved clockscope directory information
clockscope_recall - returns clockscope data for specified key
clockscope_save - saves clockscope event data
tclk_event_select_c - selects default event for future calls to tclk_ routines
tclk_event_text_c - returns the text which describes a Tevatron clock event
tclk_event_times_c - calculates the times at which a Tevatron clock event will occur

DATALOGGER

logger_client_log_values_c - sends values to a Lumberjack to be logged
logger_menu - displays scrolling menu of Lumberjack data loggers
logger_menu_items - builds menu items for logger_menu
logger_node_id - translates between logger node number and logger historic ID

BLT

blt_activate_spec - sets the active measurement spec for the selected Beam Line Tuner
blt_get_data - gets analysed data from selected Beam Line Tuner
blt_get_pos - gets position data from selected Beam Line Tuner
blt_get_pos_device - gets position data from selected Beam Line Tuner device
blt_get_tag - gets tag data from selected Beam Line Tuner
blt_is_fresh - either sets or checks the freshness of BLT front-end data

LLRF_CURVE

llrf_curve_current_length_c - returns the current length of a LLRF curve
llrf_curve_max_length_c - returns the maximum length of a LLRF curve
llrf_curve_root_name_c - returns the root name for a LLRF curve
llrf_get_curve_devices_c - returns the devices related to a LLRF curve
llrf_read_curve_c - reads LLRF curve values
llrf_write_curve_c - writes LLRF curve values

SEQUENCER

sequencer_file_execute_c - executes a requested Sequencer file
sequencer_file_find_device_c - searches all Sequencer files for a device
sequencer_file_get_directory_info_c - returns the Sequencer file directory information for a Sequencer mode
sequencer_file_get_entries_c - returns the contents of a given Sequencer file
sequencer_file_has_sr_restore_commands_c - determines whether or not a Sequencer file has Save/Restore restore commands
sequencer_file_name_to_number_c - returns the Sequencer file number corresponding to a file name
sequencer_file_num_bypassed_commands_c - returns the number of bypassed commands in a Sequencer file
sequencer_file_number_exists_c - determines if a Sequencer file number exists
sequencer_maximum_mode_number - returns the maximum Sequencer mode number
sequencer_mode_to_name_c - converts a Sequencer mode number to a name
sequencer_name_to_mode - converts a Sequencer name to a mode value

MISCELLANEOUS

acl_file_edit_c - dialog which allows the user to edit an ACL file
acl_file_menu_c - displays a menu of ACL files
bssb_permit_status_c - returns the BSSB beam permit status for a system
bssb_permit_status_list_c - returns the BSSB beam permit status for a list of systems
cns_set_is_enabled - returns TRUE if console settings are allowed through DPM
contours - creates a contour plot
db_column_info_c - returns information about each column in a database table
db_ctime_to_db_date_c - converts from C time (secs since 1/1/70) to database date structure
db_retrieve_rows_c - retrieve rows of data from the database
db_table_name_parse_c - parses a database table name into its component pieces
dio_gas_module_devices_c - returns the list of ACNET devices belonging to a GAS module
dio_gas_module_type_c - returns GAS module type and slot for a device and a property
display_camac_crate - draw a CAMAC crate and display its cards and devices
emitt_dp_tev - calculates tranverse emittance, dp/p given beam widths
fe_create_crate_data_type_c - creates a data type consisting of crates attached to a front end
fe_create_gas_house_type_c - creates a data type consisting of GAS houses attached to a front end
fe_create_madc_data_type_c - creates a data type consisting of MADCs attached to a front end
fe_create_madc_enum_type_c - creates an enumerated data type consisting of MADCs attached to a front end
fe_get_crate_list_c - returns list of CAMAC crates attached to a front end
fe_get_gas_house_list_c - returns list of GAS houses belonging to a front end
fe_get_madc_list_c - returns the list of MADCs belonging to a front end
is_valid_dabbel_user - checks to see if user is a valid DABBEL user
qpm_hscode - translates two-character ASCII house names to codes and vice versa
read_mjy_data_file_c - read data from an MJY format binary data file
read_num_booster_turns_c - reads the number of Booster turns for a given reset event
read_tagged_value_file - read ACNET devices from an ASCII file
seqdat_mode_menu - displays menu modes and allows user to select a mode
seqdat_mode_text - returns mode_text, length for a given node
seqdat_read - return data set by the SEQUENCER/C49
seqdat_set_mode - sets sequencer 'mode'
seqdat_update - updates Sequencer/C49 data for subsequent readings
tev_ramp_times_c - returns cycle time value for requested Tevatron ramp event
wait_for_device(_c) - waits for a device to have a value in a specified range
wait_for_device_status(_c) - waits for a device to have a specified status value
wait_time_c - waits until a specified number of seconds have elapsed
who_what_why_c - constructs a program log message based upon user supplied information
write_mjy_data_file_c - write data to an MJY format binary data file