/* CHANGE: Replace <Instrument Model Name> with your instrument model name.  */
/*= <Instrument Model Name> Include File ====================================*/

/*===========================================================================*/
/*  Please do not use global variables or arrays in the include file of      */
/*  instrument drivers that will be submitted for inclusion into the         */
/*  LabWindows Instrument Driver Library.                                    */
/*===========================================================================*/
     
#ifndef __lc8901a_HEADER
#define __lc8901a_HEADER

#include <vpptype.h>

#if defined(__cplusplus) || defined(__cplusplus__)
extern "C" {
#endif

/*****************************************************************************/
/*= Instrument Driver Specific Error/Warning Codes ==========================*/
/*****************************************************************************/
#define VI_ERROR_INSTR_FILE_OPEN                (_VI_ERROR+0x3FFC0800L)
#define VI_ERROR_INSTR_FILE_WRITE               (_VI_ERROR+0x3FFC0801L)
#define VI_ERROR_INSTR_INTERPRETING_RESPONSE    (_VI_ERROR+0x3FFC0803L)
#define VI_ERROR_INSTR_PARAMETER9               (_VI_ERROR+0x3FFC0809L)
#define VI_ERROR_INSTR_PARAMETER10              (_VI_ERROR+0x3FFC080AL)
#define VI_ERROR_INSTR_PARAMETER11              (_VI_ERROR+0x3FFC080BL)
#define VI_ERROR_INSTR_PARAMETER12              (_VI_ERROR+0x3FFC080CL)
#define VI_ERROR_INSTR_PARAMETER13              (_VI_ERROR+0x3FFC080DL)
#define VI_ERROR_INSTR_PARAMETER14              (_VI_ERROR+0x3FFC080EL)
#define VI_ERROR_INSTR_PARAMETER15              (_VI_ERROR+0x3FFC080FL)

/*****************************************************************************/
/*= Define Instrument Specific Error/Warning Codes Here =====================*/
/*****************************************************************************/
#define VI_WARNING_INSTR_OFFSET                           (0x3FFC0900L)
#define VI_ERROR_INSTR_OFFSET                   (_VI_ERROR+0x3FFC0900L)

#define lc8901a_ERROR_INVALID_CONFIGURATION      (VI_ERROR_INSTR_OFFSET + 0xF0L)

/*****************************************************************************/
/*= GLOBAL USER-CALLABLE FUNCTION DECLARATIONS (Exportable Functions) =======*/
/*****************************************************************************/
ViStatus _VI_FUNC lc8901a_init (ViRsrc resourceName, ViInt16 transferMode,
                    ViInt16 dataWord, ViPSession instrSession);

ViStatus _VI_FUNC lc8901a_Write (ViSession instrumentHandle, ViInt16 f, ViInt16 a,
                                ViInt16 n, long data);

ViStatus _VI_FUNC lc8901a_Read (ViSession instrSession, ViInt16 f, ViInt16 a,
                               ViInt16 n, ViInt32 blockCount,
                               ViInt32 timeoutValue, ViInt32 *data,
                               ViBoolean *x, ViBoolean *q);

ViStatus _VI_FUNC lc8901a_InitClearInhibit (ViSession instrumentHandle,
                                           ViInt16 command);

ViStatus _VI_FUNC lc8901a_SetSRQ (ViSession instrumentHandle, int SRQCondition);

/** INSERT USER-CALLABLE INSTRUMENT-DEPENDENT FUNCTION DECLARATIONS HERE **/

ViStatus _VI_FUNC lc8901a_writeInstrData (ViSession instrSession, ViString writeBuffer);
ViStatus _VI_FUNC lc8901a_readInstrData (ViSession instrSession,
                    ViInt32 numberBytesToRead, ViChar _VI_FAR readBuffer[], ViPInt32 numBytesRead);
ViStatus _VI_FUNC lc8901a_reset (ViSession instrSession);
ViStatus _VI_FUNC lc8901a_selfTest (ViSession instrSession, ViPInt16 selfTestResult,
                    ViChar _VI_FAR selfTestMessage[]);
ViStatus _VI_FUNC lc8901a_errorQuery (ViSession instrSession, ViPInt32 errorCode,
                    ViChar _VI_FAR errorMessage[]);

ViStatus _VI_FUNC lc8901a_WaitSRQ (ViSession instrumentHandle, long timeOut,
                                  short lamResponse[], ViBoolean *x,
                                  ViBoolean *q);

//ViStatus CVIFUNC lc8901a_WaitSRQ (ViSession instrumentHandle);

ViStatus _VI_FUNC lc8901a_errorMessage (ViSession instrSession, ViStatus statusCode,
                    ViChar _VI_FAR message[]);
ViStatus _VI_FUNC lc8901a_revisionQuery (ViSession instrSession,
                    ViChar _VI_FAR driverRev[], ViChar _VI_FAR instrRev[]);
ViStatus _VI_FUNC lc8901a_close (ViSession instrSession);

ViStatus _VI_FUNC lc8901a_Mode (ViSession instrSession, ViInt16 transferMode,
                                ViInt16 dataWord);

#if defined(__cplusplus) || defined(__cplusplus__)
}
#endif

/*****************************************************************************/
/*=== END INCLUDE FILE ======================================================*/
/*****************************************************************************/

#endif