ErrorCodes-Py

Proxy values for underlying C values from ErrorCodes. More...

Variables
	TaskHandle = ct.c_void_p
	ErrCode = ct.c_int
tuple	ERR_OK = ErrCode.in_dll(dll, "ERR_OK")
tuple	ERR_BAD_ATTEN = ErrCode.in_dll(dll, "ERR_BAD_ATTEN")
tuple	ERR_BAD_CAL = ErrCode.in_dll(dll, "ERR_BAD_CAL")
tuple	ERR_BAD_HANDLE = ErrCode.in_dll(dll, "ERR_BAD_HANDLE")
tuple	ERR_BAD_HOP = ErrCode.in_dll(dll, "ERR_BAD_HOP")
tuple	ERR_BAD_PATH = ErrCode.in_dll(dll, "ERR_BAD_PATH")
tuple	ERR_BAD_PROM = ErrCode.in_dll(dll, "ERR_BAD_PROM")
	Error code indicating that the VNA PROM was not in a known format. Please contact support if this is a reoccuring issue.
tuple	ERR_BYTES = ErrCode.in_dll(dll, "ERR_BYTES")
	Error code indicating the DLL has received an incorrect number of bytes from the VNA. Possibly indicative of a network issue.
tuple	ERR_FREQ_OUT_OF_BOUNDS = ErrCode.in_dll(dll, "ERR_FREQ_OUT_OF_BOUNDS")
tuple	ERR_INTERRUPTED = ErrCode.in_dll(dll, "ERR_INTERRUPTED")
tuple	ERR_NO_RESPONSE = ErrCode.in_dll(dll, "ERR_NO_RESPONSE")
tuple	ERR_MISSING_IP = ErrCode.in_dll(dll, "ERR_MISSING_IP")
tuple	ERR_MISSING_PORT = ErrCode.in_dll(dll, "ERR_MISSING_PORT")
tuple	ERR_MISSING_HOP = ErrCode.in_dll(dll, "ERR_MISSING_HOP")
tuple	ERR_MISSING_ATTEN = ErrCode.in_dll(dll, "ERR_MISSING_ATTEN")
tuple	ERR_MISSING_FREQS = ErrCode.in_dll(dll, "ERR_MISSING_FREQS")
tuple	ERR_PROG_OVERFLOW = ErrCode.in_dll(dll, "ERR_PROG_OVERFLOW")
tuple	ERR_SOCKET = ErrCode.in_dll(dll, "ERR_SOCKET")
tuple	ERR_TOO_MANY_POINTS = ErrCode.in_dll(dll, "ERR_TOO_MANY_POINTS")
tuple	ERR_WRONG_STATE = ErrCode.in_dll(dll, "ERR_WRONG_STATE")
dictionary	ErrCodeBOOK

Detailed Description

Proxy values for underlying C values from ErrorCodes.

Values should be treated as immutable, and only used as parameters to pass into DLL cals.

While the underlying type is numeric, no assumptions can or should be made about the actual integer value, as it may change with DLL updates. Only equality operations should be assumed to be valid for any comparisons or value checks.

Note that Doxygen incorrectly identifies the type of these values as tuple, as the ctypes library does some runtime type munging that doxygen doesn't understand.

Values should be treated as immutable, and only used as parameters to pass into DLL cals.

While the underlying type is numeric, no assumptions can or should be made about the actual integer value, as it may change with DLL updates. Only equality operations should be assumed to be valid for any comparisons or value checks.

Note that Doxygen incorrectly identifies the type of these values as tuple, as the ctypes library does some runtime type munging that doxygen doesn't understand.

Dictionary for mapping ERR_nnn values to human-readable string representations of the error-code.

Variable Documentation

dictionary ErrCodeBOOK

Initial value:

= {
                    ERR_OK                 : 'ERR_OK',
                    ERR_BAD_ATTEN          : 'ERR_BAD_ATTEN',
                    ERR_BAD_CAL            : 'ERR_BAD_CAL',
                    ERR_BAD_HANDLE         : 'ERR_BAD_HANDLE',
                    ERR_BAD_HOP            : 'ERR_BAD_HOP',
                    ERR_BAD_PATH           : 'ERR_BAD_PATH',
                    ERR_BAD_PROM           : 'ERR_BAD_PROM',
                    ERR_BYTES              : 'ERR_BYTES',
                    ERR_FREQ_OUT_OF_BOUNDS : 'ERR_FREQ_OUT_OF_BOUNDS',
                    ERR_INTERRUPTED        : 'ERR_INTERRUPTED',
                    ERR_NO_RESPONSE        : 'ERR_NO_RESPONSE',
                    ERR_MISSING_IP         : 'ERR_MISSING_IP',
                    ERR_MISSING_PORT       : 'ERR_MISSING_PORT',
                    ERR_MISSING_HOP        : 'ERR_MISSING_HOP',
                    ERR_MISSING_ATTEN      : 'ERR_MISSING_ATTEN',
                    ERR_MISSING_FREQS      : 'ERR_MISSING_FREQS',
                    ERR_PROG_OVERFLOW      : 'ERR_PROG_OVERFLOW',
                    ERR_SOCKET             : 'ERR_SOCKET',
                    ERR_TOO_MANY_POINTS    : 'ERR_TOO_MANY_POINTS',
                    ERR_WRONG_STATE        : 'ERR_WRONG_STATE'
                }