DSRemoteConnect C++ Library 1.1.3.24
Remote connection library for Dewesoft measurement applications
Loading...
Searching...
No Matches
ConstsAndTypeDefs_Documented.h File Reference

Go to the source code of this file.

Macros

#define CHANNEL_LIST_MAX_RESPONSE_LENGTH   8192
 Maximum response length for channel list commands.
 
#define NET_CONNECTED_MSG   "+CONNECTED"
 Network message: Connection established.
 
#define NET_CONNECTED_MSG_LEN   (strlen(NET_CONNECTED_MSG) - 1)
 
#define NET_ERR_MSG   "+ERR"
 Network message: Error occurred.
 
#define NET_ERR_MSG_LEN   (strlen(NET_ERR_MSG) - 1)
 
#define NET_STX_MSG   "+STX"
 Network message: Start of transmission.
 
#define NET_STX_MSG_LEN   (strlen(NET_STX_MSG) - 1)
 
#define NET_ETX_MSG   "+ETX"
 Network message: End of transmission.
 
#define NET_ETX_MSG_LEN   (strlen(NET_ETX_MSG) - 1)
 
#define NET_OK_MSG   "+ OK"
 Network message: Command OK.
 
#define NET_OK_MSG_LEN   (strlen(NET_OK_MSG) - 1)
 
#define NET_CMD_LIST_USED_CHANNELS   "LISTUSEDCHS"
 Network command: List used channels.
 
#define DEFAULT_BUFLEN   512
 Default buffer length for general operations.
 
#define NAME_LENGTH   100
 Maximum length for channel names.
 
#define PACKET_BUF_LEN   10000
 Buffer length for network packets.
 
#define SAMPLES_BUF_LEN   10000
 Buffer length for sample data.
 
#define MAX_CHANNEL_INDEX_LENGTH   10
 Maximum length for channel index strings.
 

Enumerations

enum  DX_ERROR_CODE {
  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
}
 Error codes returned by DSRemoteConnect functions. More...
 
enum  DSX_CONNECTION_TYPE { DSX_CONNECTION_TYPE_DCOM = 0 , DSX_CONNECTION_TYPE_NET = 1 }
 Connection types supported by DSRemoteConnect. More...
 
enum  DSX_CH_TYPE { DSX_CH_ASYNC = 0 , DSX_CH_SYNC = 1 , DSX_CH_SINGLE_VALUE = 2 }
 Channel data types based on sampling characteristics. More...
 
enum  DSX_DATA_TYPE {
  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
}
 Data types for DCOM-based channels. More...
 
enum  DSX_NET_DATA_TYPE {
  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
}
 Data types for NET-based channels. More...
 

Macro Definition Documentation

◆ CHANNEL_LIST_MAX_RESPONSE_LENGTH

#define CHANNEL_LIST_MAX_RESPONSE_LENGTH   8192

Maximum response length for channel list commands.

Definition at line 207 of file ConstsAndTypeDefs_Documented.h.

◆ DEFAULT_BUFLEN

#define DEFAULT_BUFLEN   512

Default buffer length for general operations.

Definition at line 241 of file ConstsAndTypeDefs_Documented.h.

◆ MAX_CHANNEL_INDEX_LENGTH

#define MAX_CHANNEL_INDEX_LENGTH   10

Maximum length for channel index strings.

Definition at line 253 of file ConstsAndTypeDefs_Documented.h.

◆ NAME_LENGTH

#define NAME_LENGTH   100

Maximum length for channel names.

Definition at line 244 of file ConstsAndTypeDefs_Documented.h.

◆ NET_CMD_LIST_USED_CHANNELS

#define NET_CMD_LIST_USED_CHANNELS   "LISTUSEDCHS"

Network command: List used channels.

Definition at line 230 of file ConstsAndTypeDefs_Documented.h.

◆ NET_CONNECTED_MSG

#define NET_CONNECTED_MSG   "+CONNECTED"

Network message: Connection established.

Definition at line 210 of file ConstsAndTypeDefs_Documented.h.

◆ NET_CONNECTED_MSG_LEN

#define NET_CONNECTED_MSG_LEN   (strlen(NET_CONNECTED_MSG) - 1)

Definition at line 211 of file ConstsAndTypeDefs_Documented.h.

◆ NET_ERR_MSG

#define NET_ERR_MSG   "+ERR"

Network message: Error occurred.

Definition at line 214 of file ConstsAndTypeDefs_Documented.h.

◆ NET_ERR_MSG_LEN

#define NET_ERR_MSG_LEN   (strlen(NET_ERR_MSG) - 1)

Definition at line 215 of file ConstsAndTypeDefs_Documented.h.

◆ NET_ETX_MSG

#define NET_ETX_MSG   "+ETX"

Network message: End of transmission.

Definition at line 222 of file ConstsAndTypeDefs_Documented.h.

◆ NET_ETX_MSG_LEN

#define NET_ETX_MSG_LEN   (strlen(NET_ETX_MSG) - 1)

Definition at line 223 of file ConstsAndTypeDefs_Documented.h.

◆ NET_OK_MSG

#define NET_OK_MSG   "+ OK"

Network message: Command OK.

Definition at line 226 of file ConstsAndTypeDefs_Documented.h.

◆ NET_OK_MSG_LEN

#define NET_OK_MSG_LEN   (strlen(NET_OK_MSG) - 1)

Definition at line 227 of file ConstsAndTypeDefs_Documented.h.

◆ NET_STX_MSG

#define NET_STX_MSG   "+STX"

Network message: Start of transmission.

Definition at line 218 of file ConstsAndTypeDefs_Documented.h.

◆ NET_STX_MSG_LEN

#define NET_STX_MSG_LEN   (strlen(NET_STX_MSG) - 1)

Definition at line 219 of file ConstsAndTypeDefs_Documented.h.

◆ PACKET_BUF_LEN

#define PACKET_BUF_LEN   10000

Buffer length for network packets.

Definition at line 247 of file ConstsAndTypeDefs_Documented.h.

◆ SAMPLES_BUF_LEN

#define SAMPLES_BUF_LEN   10000

Buffer length for sample data.

Definition at line 250 of file ConstsAndTypeDefs_Documented.h.

Enumeration Type Documentation

◆ DSX_CH_TYPE

Channel data types based on sampling characteristics.

Defines how channel data is sampled and delivered.

Enumerator
DSX_CH_ASYNC 

Asynchronous channel - data arrives at irregular intervals.

DSX_CH_SYNC 

Synchronous channel - data sampled at regular intervals.

DSX_CH_SINGLE_VALUE 

Single value channel - provides one value per measurement.

Definition at line 132 of file ConstsAndTypeDefs_Documented.h.

◆ DSX_CONNECTION_TYPE

Connection types supported by DSRemoteConnect.

Specifies the communication protocol to use when connecting to Dewesoft.

Enumerator
DSX_CONNECTION_TYPE_DCOM 

DCOM connection for local/remote Windows applications.

DSX_CONNECTION_TYPE_NET 

Network connection using TCP/IP protocols.

Definition at line 118 of file ConstsAndTypeDefs_Documented.h.

◆ DSX_DATA_TYPE

Data types for DCOM-based channels.

Specifies the underlying data type of channel values in DCOM connections.

Enumerator
dtByte 

8-bit unsigned byte

dtShortInt 

16-bit signed integer

dtSmallInt 

16-bit signed integer (alternative)

dtWord 

16-bit unsigned integer

dtInteger 

32-bit signed integer

dtSingle 

32-bit floating point

dtInt64 

64-bit signed integer

dtDouble 

64-bit floating point

dtLongword 

32-bit unsigned integer

dtComplexSingle 

Complex 32-bit floating point.

dtComplexDouble 

Complex 64-bit floating point.

dtText 

Text/string data.

dtBinary 

Binary data.

dtCANMessage 

CAN bus message.

dtCANFDMessage 

CAN FD message.

dtBytes8 

8-byte data block

dtBytes16 

16-byte data block

dtBytes32 

32-byte data block

dtBytes64 

64-byte data block

Definition at line 149 of file ConstsAndTypeDefs_Documented.h.

◆ DSX_NET_DATA_TYPE

Data types for NET-based channels.

Specifies the underlying data type of channel values in network connections. Similar to DSX_DATA_TYPE but optimized for network transmission.

Enumerator
dtSignedCharNet 

8-bit signed character

dtUnSignedCharNet 

8-bit unsigned character

dtShortNet 

16-bit signed integer

dtUnsignedShortNet 

16-bit unsigned integer

dtIntegerNet 

32-bit signed integer

dtFloatNet 

32-bit floating point

dtDoubleNet 

64-bit floating point

dtLongLongNet 

64-bit signed integer

dtLongWordNet 

32-bit unsigned integer

dtComplexSingleNet 

Complex 32-bit floating point.

dtComplexDoubleNet 

Complex 64-bit floating point.

dtTextNet 

Text/string data.

dtBinaryNet 

Binary data.

dtCANMessageNet 

CAN bus message.

dtCANFDMessageNet 

CAN FD message.

dtBytes8Net 

8-byte data block

dtBytes16Net 

16-byte data block

dtBytes32Net 

32-byte data block

dtBytes64Net 

64-byte data block

Definition at line 178 of file ConstsAndTypeDefs_Documented.h.

◆ DX_ERROR_CODE

Error codes returned by DSRemoteConnect functions.

All DSRemoteConnect functions return one of these error codes. Positive values and zero indicate success or warnings, negative values indicate errors.

Enumerator
DSX_TOO_MANY_SAMPLES_AVAILABLE 

More samples available than requested (warning)

DSX_END_OF_ENUM 

End of enumeration reached.

DSX_NO_ERROR 

No error - operation successful.

DSX_DCOM_CHANNEL_ID_NOT_FOUND 

DCOM: Channel ID not found in current setup.

DSX_DCOM_UNKNOWN_ERROR 

DCOM: Unknown error occurred.

DSX_DCOM_NO_DATA 

DCOM: No data available for reading.

DSX_DCOM_NOT_CONNECTED 

DCOM: Not connected to Dewesoft application.

DSX_COUNT_OUT_OF_BOUNDS 

Count parameter out of valid bounds.

DSX_NET_UNABLE_TO_CONNECT 

NET: Unable to establish network connection.

DSX_NET_UNKNOWN_ERROR 

NET: Unknown network error occurred.

DSX_UNKNOWN_ERROR 

General unknown error.

DSX_NULL_HANDLER 

Null handle or pointer passed to function.

DSX_INVALID_CONNECTION_STRING 

Invalid connection string format.

DSX_DCOM_ISSUE 

DCOM: General DCOM interface issue.

DSX_DCOM_COULD_NOT_CONNECT 

DCOM: Could not establish DCOM connection.

DSX_DCOM_NO_CHANNELS_TO_ENUMERATE 

DCOM: No channels available for enumeration.

DSX_DCOM_EMPTY_ARRAY 

DCOM: Empty array returned.

DSX_CANNOT_MAKE_CH_INSTANCE 

Cannot create channel instance.

DSX_WRONG_PROPS_NAME 

Wrong property name specified.

DSX_ERROR_GETTING_LENGTH_PROPS 

Error getting property length.

DSX_NET_COMMAND_NOT_SUPPORTED 

NET: Command not supported by server.

DSX_CH_IS_NOT_CONTROL 

Channel is not a control channel.

DSX_NET_SETUP_NOT_FOUND 

NET: Setup file not found.

DSX_NET_BUFFER_OVERWRITTEN 

NET: Buffer was overwritten before reading.

DSX_NET_ISACQ_CHECKFAILED 

NET: Acquisition status check failed.

DSX_NET_STOPPING_ACQ_FAILED 

NET: Failed to stop acquisition.

DSX_NET_INITIALIZING_VECTOR_CH 

NET: Error initializing vector channels.

DSX_NET_GETTIMING_FAILED 

NET: Failed to get timing information.

DSX_NET_PREPARECHFORTRANSFER_FAILED 

NET: Failed to prepare channel for transfer.

DSX_NET_STARTTRANSFER_FAILED 

NET: Failed to start data transfer.

DSX_NET_STARTACQ_FAILED 

NET: Failed to start acquisition.

Definition at line 17 of file ConstsAndTypeDefs_Documented.h.