/*	*************************************************************  */
/*
 *	VTRAMP.H
 *
 *	Zachary Wolf
 *	4/16/02
 */

#ifndef __VTRAMP_HEADER
#define __VTRAMP_HEADER

/*	**************************************************************	*/

/*	SEMI-PERMANENT PARAMETERS  */
#define VTRAMP_MAX_NUM_SAMP 1000
#define VTRAMP_MAX_NUM_CHAR 100

/*	*************************************************************  */

/*	ENUM DEFINITIONS */
enum vtramp_config_enum {VTRAMP_PDI5025, VTRAMP_HP3458};
enum vtramp_binary_enum {VTRAMP_TRUE, VTRAMP_FALSE};

/*	*************************************************************  */

/*	STRUCTURE DEFINITIONS */
struct vtramp_param_struct
{
	int board_addr;						/* GPIB board address */
	int pdi5025_addr;					/* PDI5025 GPIB address */
	int hp3458_addr;					/* HP3458 GPIB address */
	char pdi5025_channel;				/* PDI5025 (if being used) channel 'A' or 'B' */
	int pdi5025_gain;					/* PDI5025 (if being used) gain 1, 2, ... */
	double hp3458_range;				/* HP3458 (if being used) range .001 V, .01 V, ... */
	enum vtramp_config_enum config;		/* hardware being used, choices in enum */
	double t_samp_before;				/* sample time before current ramp (sec) */
	double t_samp_after;				/* sample time after the current ramp (sec) */
	enum vtramp_binary_enum do_offset_correction;	/* if TRUE, do an offset correction, don't do if FALSE */
	enum vtramp_binary_enum show_ui;	/* if TRUE, show user interface, don't show if FALSE */
};

/*	*************************************************************  */

/*	PUBLIC FUNCTION DECLARATIONS */
void vtramp_init(char log_file[], struct vtramp_param_struct vtramp_param);
void vtramp_get_vt(double imag, double* vt);
void vtramp_exit(void);

/*	**************************************************************  */
 
/*	DONE  */
#endif