nScopeAPI_defs.h

Go to the documentation of this file.

/*******************************************************
 nScopeAPI - Multi-Platform library for
 communication with nScope devices.

 David Meyer

 9/10/2016

 Copyright 2014, All Rights Reserved.

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

#ifndef NSCOPEAPI_DEFS_H__
#define NSCOPEAPI_DEFS_H__

    #ifdef _WIN32
       #define NSCOPE_API_EXPORT __declspec(dllexport)
       #define NSCOPE_API_CALL //__declspec(dllimport)
    #else
       #define NSCOPE_API_EXPORT 
       #define NSCOPE_API_CALL 
    #endif

    #define NSCOPE_API NSCOPE_API_EXPORT NSCOPE_API_CALL 
    struct scopeDev_;
    typedef struct scopeDev_ *ScopeHandle; 
    struct request_;
    typedef struct request_ *Request; 
    typedef enum
    {
        SUCCESS =                  0,
        UNKNOWN_ERROR =             -100,
        NSCOPE_NOT_OPEN =           -101,
        NSCOPE_CHANNEL_OFF =        -102,
        NSCOPE_POWER_OFF =          -103,
        NO_DATA_AVAILABLE =         -104,
        INVALID_TRIGGER =           -105,
        INVALID_REQUEST =           -106,
        COMM_ERROR =                -107,
        INTERRUPT_STOPPED =         -108,
        FW_API_INCOMPATIBLE =       -109,
        VALUE_ERROR_TOO_SMALL =     -110,
        VALUE_ERROR_TOO_LARGE =     -111,
        VALUE_ERROR_OUT_OF_RANGE =  -112,
        VALUE_WARNING_TOO_SMALL =   -120,
        VALUE_WARNING_TOO_LARGE =   -121,
    } ErrorType;

    typedef enum
    {
        FALLING_EDGE =    1,  
        RISING_EDGE =     2,  
    } TriggerEdge;

    typedef enum
    {
        NOT_CONNECTED = -1, 
        POWER_OFF =     0,  
        POWER_ON =      1,  
        SHORTED =       2,  
        OVERCURRENT =   3   
    } PowerState;

    typedef enum
    {
        SINE_WAVE =     0, 
        TRIANGLE_WAVE = 1, 
    } WaveType;

#endif