ConstsAndTypeDefs_Documented.h

Go to the documentation of this file.

 
#pragma once
 
typedef enum {
    DSX_TOO_MANY_SAMPLES_AVAILABLE = 2,
    
    DSX_END_OF_ENUM = 1,
    
    DSX_NO_ERROR = 0,
    
    DSX_DCOM_CHANNEL_ID_NOT_FOUND = -1,
    
    DSX_DCOM_UNKNOWN_ERROR = -2,
    
    DSX_DCOM_NO_DATA = -3,
    
    DSX_DCOM_NOT_CONNECTED = -4,
    
    DSX_COUNT_OUT_OF_BOUNDS = -5,
    
    DSX_NET_UNABLE_TO_CONNECT = -6,
    
    DSX_NET_UNKNOWN_ERROR = -7,
    
    DSX_UNKNOWN_ERROR = -8,
    
    DSX_NULL_HANDLER = -9,
    
    DSX_INVALID_CONNECTION_STRING = -10,
    
    DSX_DCOM_ISSUE = -11,
    
    DSX_DCOM_COULD_NOT_CONNECT = -12,
    
    DSX_DCOM_NO_CHANNELS_TO_ENUMERATE = -13,
    
    DSX_DCOM_EMPTY_ARRAY = -14,
    
    DSX_CANNOT_MAKE_CH_INSTANCE = -15,
    
    DSX_WRONG_PROPS_NAME = -16,
    
    DSX_ERROR_GETTING_LENGTH_PROPS = -17,
    
    DSX_NET_COMMAND_NOT_SUPPORTED = -18,
    
    DSX_CH_IS_NOT_CONTROL = -19,
    
    DSX_NET_SETUP_NOT_FOUND = -20,
    
    DSX_NET_BUFFER_OVERWRITTEN = -21,
    
    DSX_NET_ISACQ_CHECKFAILED = -22,
    
    DSX_NET_STOPPING_ACQ_FAILED = -23,
    
    DSX_NET_INITIALIZING_VECTOR_CH = -24,
    
    DSX_NET_GETTIMING_FAILED = -25,
    
    DSX_NET_PREPARECHFORTRANSFER_FAILED = -26,
    
    DSX_NET_STARTTRANSFER_FAILED = -27,
    
    DSX_NET_STARTACQ_FAILED = -28
} DX_ERROR_CODE;
 
typedef enum {
    DSX_CONNECTION_TYPE_DCOM = 0,
    
    DSX_CONNECTION_TYPE_NET = 1
} DSX_CONNECTION_TYPE;
 
typedef enum {
    DSX_CH_ASYNC = 0,
    
    DSX_CH_SYNC = 1,
    
    DSX_CH_SINGLE_VALUE = 2
} DSX_CH_TYPE;
 
typedef enum {
    dtByte = 0,              
    dtShortInt = 1,          
    dtSmallInt = 2,          
    dtWord = 3,              
    dtInteger = 4,           
    dtSingle = 5,            
    dtInt64 = 6,             
    dtDouble = 7,            
    dtLongword = 8,          
    dtComplexSingle = 9,     
    dtComplexDouble = 10,    
    dtText = 11,             
    dtBinary = 12,           
    dtCANMessage = 13,       
    dtCANFDMessage = 14,     
    dtBytes8 = 15,           
    dtBytes16 = 16,          
    dtBytes32 = 17,          
    dtBytes64 = 18           
} DSX_DATA_TYPE;
 
typedef enum {
    dtSignedCharNet = 0,        
    dtUnSignedCharNet = 1,      
    dtShortNet = 2,             
    dtUnsignedShortNet = 3,     
    dtIntegerNet = 4,           
    dtFloatNet = 5,             
    dtDoubleNet = 7,            
    dtLongLongNet = 6,          
    dtLongWordNet = 8,          
    dtComplexSingleNet = 9,     
    dtComplexDoubleNet = 10,    
    dtTextNet = 11,             
    dtBinaryNet = 12,           
    dtCANMessageNet = 13,       
    dtCANFDMessageNet = 14,     
    dtBytes8Net = 15,           
    dtBytes16Net = 16,          
    dtBytes32Net = 17,          
    dtBytes64Net = 18           
} DSX_NET_DATA_TYPE;
 
// ============================================================================
// @defgroup net_protocol Network Protocol Constants
// @brief Constants used in network communication protocol
// @{
// ============================================================================
 
#define CHANNEL_LIST_MAX_RESPONSE_LENGTH 8192
 
#define NET_CONNECTED_MSG "+CONNECTED"
#define NET_CONNECTED_MSG_LEN (strlen(NET_CONNECTED_MSG) - 1)
 
#define NET_ERR_MSG "+ERR"
#define NET_ERR_MSG_LEN (strlen(NET_ERR_MSG) - 1)
 
#define NET_STX_MSG "+STX"
#define NET_STX_MSG_LEN (strlen(NET_STX_MSG) - 1)
 
#define NET_ETX_MSG "+ETX"
#define NET_ETX_MSG_LEN (strlen(NET_ETX_MSG) - 1)
 
#define NET_OK_MSG "+ OK"
#define NET_OK_MSG_LEN (strlen(NET_OK_MSG) - 1)
 
#define NET_CMD_LIST_USED_CHANNELS "LISTUSEDCHS"
 
 // end of net_protocol group
 
// ============================================================================
// @defgroup buffer_constants Buffer and Size Constants
// @brief Constants defining buffer sizes and limits
// @{
// ============================================================================
 
#define DEFAULT_BUFLEN 512
 
#define NAME_LENGTH 100
 
#define PACKET_BUF_LEN 10000
 
#define SAMPLES_BUF_LEN 10000
 
#define MAX_CHANNEL_INDEX_LENGTH 10
 
 // end of buffer_constants group